1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getConnectivityConfiguration
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.network.getConnectivityConfiguration

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name Azure REST API version: 2023-02-01.

    Other available API versions: 2021-02-01-preview, 2021-05-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01.

    Using getConnectivityConfiguration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConnectivityConfiguration(args: GetConnectivityConfigurationArgs, opts?: InvokeOptions): Promise<GetConnectivityConfigurationResult>
    function getConnectivityConfigurationOutput(args: GetConnectivityConfigurationOutputArgs, opts?: InvokeOptions): Output<GetConnectivityConfigurationResult>
    def get_connectivity_configuration(configuration_name: Optional[str] = None,
                                       network_manager_name: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetConnectivityConfigurationResult
    def get_connectivity_configuration_output(configuration_name: Optional[pulumi.Input[str]] = None,
                                       network_manager_name: Optional[pulumi.Input[str]] = None,
                                       resource_group_name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetConnectivityConfigurationResult]
    func LookupConnectivityConfiguration(ctx *Context, args *LookupConnectivityConfigurationArgs, opts ...InvokeOption) (*LookupConnectivityConfigurationResult, error)
    func LookupConnectivityConfigurationOutput(ctx *Context, args *LookupConnectivityConfigurationOutputArgs, opts ...InvokeOption) LookupConnectivityConfigurationResultOutput

    > Note: This function is named LookupConnectivityConfiguration in the Go SDK.

    public static class GetConnectivityConfiguration 
    {
        public static Task<GetConnectivityConfigurationResult> InvokeAsync(GetConnectivityConfigurationArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectivityConfigurationResult> Invoke(GetConnectivityConfigurationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectivityConfigurationResult> getConnectivityConfiguration(GetConnectivityConfigurationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:network:getConnectivityConfiguration
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConfigurationName string
    The name of the network manager connectivity configuration.
    NetworkManagerName string
    The name of the network manager.
    ResourceGroupName string
    The name of the resource group.
    ConfigurationName string
    The name of the network manager connectivity configuration.
    NetworkManagerName string
    The name of the network manager.
    ResourceGroupName string
    The name of the resource group.
    configurationName String
    The name of the network manager connectivity configuration.
    networkManagerName String
    The name of the network manager.
    resourceGroupName String
    The name of the resource group.
    configurationName string
    The name of the network manager connectivity configuration.
    networkManagerName string
    The name of the network manager.
    resourceGroupName string
    The name of the resource group.
    configuration_name str
    The name of the network manager connectivity configuration.
    network_manager_name str
    The name of the network manager.
    resource_group_name str
    The name of the resource group.
    configurationName String
    The name of the network manager connectivity configuration.
    networkManagerName String
    The name of the network manager.
    resourceGroupName String
    The name of the resource group.

    getConnectivityConfiguration Result

    The following output properties are available:

    AppliesToGroups List<Pulumi.AzureNative.Network.Outputs.ConnectivityGroupItemResponse>
    Groups for configuration
    ConnectivityTopology string
    Connectivity topology type.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    Resource ID.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the connectivity configuration resource.
    ResourceGuid string
    Unique identifier for this resource.
    SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse
    The system metadata related to this resource.
    Type string
    Resource type.
    DeleteExistingPeering string
    Flag if need to remove current existing peerings.
    Description string
    A description of the connectivity configuration.
    Hubs List<Pulumi.AzureNative.Network.Outputs.HubResponse>
    List of hubItems
    IsGlobal string
    Flag if global mesh is supported.
    AppliesToGroups []ConnectivityGroupItemResponse
    Groups for configuration
    ConnectivityTopology string
    Connectivity topology type.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    Resource ID.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the connectivity configuration resource.
    ResourceGuid string
    Unique identifier for this resource.
    SystemData SystemDataResponse
    The system metadata related to this resource.
    Type string
    Resource type.
    DeleteExistingPeering string
    Flag if need to remove current existing peerings.
    Description string
    A description of the connectivity configuration.
    Hubs []HubResponse
    List of hubItems
    IsGlobal string
    Flag if global mesh is supported.
    appliesToGroups List<ConnectivityGroupItemResponse>
    Groups for configuration
    connectivityTopology String
    Connectivity topology type.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    Resource ID.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the connectivity configuration resource.
    resourceGuid String
    Unique identifier for this resource.
    systemData SystemDataResponse
    The system metadata related to this resource.
    type String
    Resource type.
    deleteExistingPeering String
    Flag if need to remove current existing peerings.
    description String
    A description of the connectivity configuration.
    hubs List<HubResponse>
    List of hubItems
    isGlobal String
    Flag if global mesh is supported.
    appliesToGroups ConnectivityGroupItemResponse[]
    Groups for configuration
    connectivityTopology string
    Connectivity topology type.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    Resource ID.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the connectivity configuration resource.
    resourceGuid string
    Unique identifier for this resource.
    systemData SystemDataResponse
    The system metadata related to this resource.
    type string
    Resource type.
    deleteExistingPeering string
    Flag if need to remove current existing peerings.
    description string
    A description of the connectivity configuration.
    hubs HubResponse[]
    List of hubItems
    isGlobal string
    Flag if global mesh is supported.
    applies_to_groups Sequence[ConnectivityGroupItemResponse]
    Groups for configuration
    connectivity_topology str
    Connectivity topology type.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    Resource ID.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the connectivity configuration resource.
    resource_guid str
    Unique identifier for this resource.
    system_data SystemDataResponse
    The system metadata related to this resource.
    type str
    Resource type.
    delete_existing_peering str
    Flag if need to remove current existing peerings.
    description str
    A description of the connectivity configuration.
    hubs Sequence[HubResponse]
    List of hubItems
    is_global str
    Flag if global mesh is supported.
    appliesToGroups List<Property Map>
    Groups for configuration
    connectivityTopology String
    Connectivity topology type.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    Resource ID.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the connectivity configuration resource.
    resourceGuid String
    Unique identifier for this resource.
    systemData Property Map
    The system metadata related to this resource.
    type String
    Resource type.
    deleteExistingPeering String
    Flag if need to remove current existing peerings.
    description String
    A description of the connectivity configuration.
    hubs List<Property Map>
    List of hubItems
    isGlobal String
    Flag if global mesh is supported.

    Supporting Types

    ConnectivityGroupItemResponse

    GroupConnectivity string
    Group connectivity type.
    NetworkGroupId string
    Network group Id.
    IsGlobal string
    Flag if global is supported.
    UseHubGateway string
    Flag if need to use hub gateway.
    GroupConnectivity string
    Group connectivity type.
    NetworkGroupId string
    Network group Id.
    IsGlobal string
    Flag if global is supported.
    UseHubGateway string
    Flag if need to use hub gateway.
    groupConnectivity String
    Group connectivity type.
    networkGroupId String
    Network group Id.
    isGlobal String
    Flag if global is supported.
    useHubGateway String
    Flag if need to use hub gateway.
    groupConnectivity string
    Group connectivity type.
    networkGroupId string
    Network group Id.
    isGlobal string
    Flag if global is supported.
    useHubGateway string
    Flag if need to use hub gateway.
    group_connectivity str
    Group connectivity type.
    network_group_id str
    Network group Id.
    is_global str
    Flag if global is supported.
    use_hub_gateway str
    Flag if need to use hub gateway.
    groupConnectivity String
    Group connectivity type.
    networkGroupId String
    Network group Id.
    isGlobal String
    Flag if global is supported.
    useHubGateway String
    Flag if need to use hub gateway.

    HubResponse

    ResourceId string
    Resource Id.
    ResourceType string
    Resource Type.
    ResourceId string
    Resource Id.
    ResourceType string
    Resource Type.
    resourceId String
    Resource Id.
    resourceType String
    Resource Type.
    resourceId string
    Resource Id.
    resourceType string
    Resource Type.
    resource_id str
    Resource Id.
    resource_type str
    Resource Type.
    resourceId String
    Resource Id.
    resourceType String
    Resource Type.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The type of identity that last modified the resource.
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The type of identity that last modified the resource.
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi