Get-AzInterconnectGroupNodeAvailability
Gets the node availability of an interconnect group.
Syntax
GetByNameParameterSet (Default)
Get-AzInterconnectGroupNodeAvailability
-ResourceGroupName <String>
-Name <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByInputObjectParameterSet
Get-AzInterconnectGroupNodeAvailability
-InputObject <PSInterconnectGroup>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdParameterSet
Get-AzInterconnectGroupNodeAvailability
-ResourceId <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzInterconnectGroupNodeAvailability cmdlet gets the node availability of an interconnect group. The result reports, for each subgroup, how many nodes are in service, how many are in use, and the total node count.
Examples
Example 1: Get the node availability of an interconnect group
Get-AzInterconnectGroupNodeAvailability -ResourceGroupName "ResourceGroup01" -Name "InterconnectGroup01"
This command gets the node availability of the interconnect group named InterconnectGroup01.
Example 2: Get the node availability by using the pipeline
Get-AzInterconnectGroup -ResourceGroupName "ResourceGroup01" -Name "InterconnectGroup01" | Get-AzInterconnectGroupNodeAvailability
This command pipes an interconnect group to Get-AzInterconnectGroupNodeAvailability.
Example 3: Get the node availability by resource ID
Get-AzInterconnectGroupNodeAvailability -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.Network/interconnectGroups/InterconnectGroup01"
This command gets the node availability of the interconnect group identified by the specified resource ID.
Parameters
-AsJob
Run cmdlet in the background
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
The interconnect group object.
Parameter properties
| Type: | PSInterconnectGroup |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | InterconnectGroup |
Parameter sets
GetByInputObjectParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The name of the interconnect group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ResourceName, InterconnectGroupName |
Parameter sets
GetByNameParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The resource group name of the interconnect group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByNameParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceId
The resource id of the interconnect group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | InterconnectGroupId |
Parameter sets
GetByResourceIdParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
