1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. network
  6. getInterconnectGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.25.0
published on Wednesday, Aug 5, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.25.0
published on Wednesday, Aug 5, 2026 by Pulumi

    Gets information about the specified interconnect group.

    Uses Azure REST API version 2025-07-01.

    Using getInterconnectGroup

    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 getInterconnectGroup(args: GetInterconnectGroupArgs, opts?: InvokeOptions): Promise<GetInterconnectGroupResult>
    function getInterconnectGroupOutput(args: GetInterconnectGroupOutputArgs, opts?: InvokeOptions): Output<GetInterconnectGroupResult>
    def get_interconnect_group(interconnect_group_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetInterconnectGroupResult
    def get_interconnect_group_output(interconnect_group_name: pulumi.Input[Optional[str]] = None,
                               resource_group_name: pulumi.Input[Optional[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetInterconnectGroupResult]
    func LookupInterconnectGroup(ctx *Context, args *LookupInterconnectGroupArgs, opts ...InvokeOption) (*LookupInterconnectGroupResult, error)
    func LookupInterconnectGroupOutput(ctx *Context, args *LookupInterconnectGroupOutputArgs, opts ...InvokeOption) LookupInterconnectGroupResultOutput

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

    public static class GetInterconnectGroup 
    {
        public static Task<GetInterconnectGroupResult> InvokeAsync(GetInterconnectGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetInterconnectGroupResult> Invoke(GetInterconnectGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInterconnectGroupResult> getInterconnectGroup(GetInterconnectGroupArgs args, InvokeOptions options)
    public static Output<GetInterconnectGroupResult> getInterconnectGroup(GetInterconnectGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:network:getInterconnectGroup
      arguments:
        # arguments dictionary
    data "azure-native_network_get_interconnect_group" "name" {
        # arguments
    }

    The following arguments are supported:

    InterconnectGroupName string
    The name of the interconnect group.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    InterconnectGroupName string
    The name of the interconnect group.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    interconnect_group_name string
    The name of the interconnect group.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    interconnectGroupName String
    The name of the interconnect group.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    interconnectGroupName string
    The name of the interconnect group.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    interconnect_group_name str
    The name of the interconnect group.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    interconnectGroupName String
    The name of the interconnect group.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getInterconnectGroup Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the interconnect group resource.
    ResourceGuid string
    The resource GUID property of the interconnect group resource.
    SubgroupProfile Pulumi.AzureNative.Network.Outputs.SubgroupProfileResponse
    The subgroup profile of the interconnect group resource.
    Subgroups List<Pulumi.AzureNative.Network.Outputs.SubgroupResponse>
    A list of subgroups of the interconnect group.
    Type string
    Resource type.
    Id string
    Resource ID.
    Location string
    Resource location.
    Scope string
    Scope of interconnect group resource.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the interconnect group resource.
    ResourceGuid string
    The resource GUID property of the interconnect group resource.
    SubgroupProfile SubgroupProfileResponse
    The subgroup profile of the interconnect group resource.
    Subgroups []SubgroupResponse
    A list of subgroups of the interconnect group.
    Type string
    Resource type.
    Id string
    Resource ID.
    Location string
    Resource location.
    Scope string
    Scope of interconnect group resource.
    Tags map[string]string
    Resource tags.
    azure_api_version string
    The Azure API version of the resource.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    name string
    Resource name.
    provisioning_state string
    The provisioning state of the interconnect group resource.
    resource_guid string
    The resource GUID property of the interconnect group resource.
    subgroup_profile object
    The subgroup profile of the interconnect group resource.
    subgroups list(object)
    A list of subgroups of the interconnect group.
    type string
    Resource type.
    id string
    Resource ID.
    location string
    Resource location.
    scope string
    Scope of interconnect group resource.
    tags map(string)
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the interconnect group resource.
    resourceGuid String
    The resource GUID property of the interconnect group resource.
    subgroupProfile SubgroupProfileResponse
    The subgroup profile of the interconnect group resource.
    subgroups List<SubgroupResponse>
    A list of subgroups of the interconnect group.
    type String
    Resource type.
    id String
    Resource ID.
    location String
    Resource location.
    scope String
    Scope of interconnect group resource.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the interconnect group resource.
    resourceGuid string
    The resource GUID property of the interconnect group resource.
    subgroupProfile SubgroupProfileResponse
    The subgroup profile of the interconnect group resource.
    subgroups SubgroupResponse[]
    A list of subgroups of the interconnect group.
    type string
    Resource type.
    id string
    Resource ID.
    location string
    Resource location.
    scope string
    Scope of interconnect group resource.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the interconnect group resource.
    resource_guid str
    The resource GUID property of the interconnect group resource.
    subgroup_profile SubgroupProfileResponse
    The subgroup profile of the interconnect group resource.
    subgroups Sequence[SubgroupResponse]
    A list of subgroups of the interconnect group.
    type str
    Resource type.
    id str
    Resource ID.
    location str
    Resource location.
    scope str
    Scope of interconnect group resource.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the interconnect group resource.
    resourceGuid String
    The resource GUID property of the interconnect group resource.
    subgroupProfile Property Map
    The subgroup profile of the interconnect group resource.
    subgroups List<Property Map>
    A list of subgroups of the interconnect group.
    type String
    Resource type.
    id String
    Resource ID.
    location String
    Resource location.
    scope String
    Scope of interconnect group resource.
    tags Map<String>
    Resource tags.

    Supporting Types

    SubResourceResponse

    Id string
    Resource ID.
    Id string
    Resource ID.
    id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    SubgroupProfileResponse

    VmSize string
    VM size of the subgroup profile.
    Scope string
    Scope of the subgroup profile.
    Size int
    Size of the subgroup profile.
    VmSize string
    VM size of the subgroup profile.
    Scope string
    Scope of the subgroup profile.
    Size int
    Size of the subgroup profile.
    vm_size string
    VM size of the subgroup profile.
    scope string
    Scope of the subgroup profile.
    size number
    Size of the subgroup profile.
    vmSize String
    VM size of the subgroup profile.
    scope String
    Scope of the subgroup profile.
    size Integer
    Size of the subgroup profile.
    vmSize string
    VM size of the subgroup profile.
    scope string
    Scope of the subgroup profile.
    size number
    Size of the subgroup profile.
    vm_size str
    VM size of the subgroup profile.
    scope str
    Scope of the subgroup profile.
    size int
    Size of the subgroup profile.
    vmSize String
    VM size of the subgroup profile.
    scope String
    Scope of the subgroup profile.
    size Number
    Size of the subgroup profile.

    SubgroupResponse

    InterconnectBlock Pulumi.AzureNative.Network.Inputs.SubResourceResponse
    The reference to an interconnect block resource.
    InternalSubgroupId string
    The unique identifier of the subgroup.
    ProvisioningState string
    The provisioning state of the subgroup.
    Type string
    Resource type.
    VirtualMachines List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
    A list of virtual machine references.
    Id string
    Resource ID.
    Name string
    Name of the resource.
    InterconnectBlock SubResourceResponse
    The reference to an interconnect block resource.
    InternalSubgroupId string
    The unique identifier of the subgroup.
    ProvisioningState string
    The provisioning state of the subgroup.
    Type string
    Resource type.
    VirtualMachines []SubResourceResponse
    A list of virtual machine references.
    Id string
    Resource ID.
    Name string
    Name of the resource.
    interconnect_block object
    The reference to an interconnect block resource.
    internal_subgroup_id string
    The unique identifier of the subgroup.
    provisioning_state string
    The provisioning state of the subgroup.
    type string
    Resource type.
    virtual_machines list(object)
    A list of virtual machine references.
    id string
    Resource ID.
    name string
    Name of the resource.
    interconnectBlock SubResourceResponse
    The reference to an interconnect block resource.
    internalSubgroupId String
    The unique identifier of the subgroup.
    provisioningState String
    The provisioning state of the subgroup.
    type String
    Resource type.
    virtualMachines List<SubResourceResponse>
    A list of virtual machine references.
    id String
    Resource ID.
    name String
    Name of the resource.
    interconnectBlock SubResourceResponse
    The reference to an interconnect block resource.
    internalSubgroupId string
    The unique identifier of the subgroup.
    provisioningState string
    The provisioning state of the subgroup.
    type string
    Resource type.
    virtualMachines SubResourceResponse[]
    A list of virtual machine references.
    id string
    Resource ID.
    name string
    Name of the resource.
    interconnect_block SubResourceResponse
    The reference to an interconnect block resource.
    internal_subgroup_id str
    The unique identifier of the subgroup.
    provisioning_state str
    The provisioning state of the subgroup.
    type str
    Resource type.
    virtual_machines Sequence[SubResourceResponse]
    A list of virtual machine references.
    id str
    Resource ID.
    name str
    Name of the resource.
    interconnectBlock Property Map
    The reference to an interconnect block resource.
    internalSubgroupId String
    The unique identifier of the subgroup.
    provisioningState String
    The provisioning state of the subgroup.
    type String
    Resource type.
    virtualMachines List<Property Map>
    A list of virtual machine references.
    id String
    Resource ID.
    name String
    Name of 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 v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.25.0
    published on Wednesday, Aug 5, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial