Get-AzAksArcNodepool
Gets the specified agent pool in the provisioned cluster
Syntax
List (Default)
Get-AzAksArcNodepool
-ClusterName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[<CommonParameters>]
Get
Get-AzAksArcNodepool
-ClusterName <String>
-ResourceGroupName <String>
-Name <String>
[-SubscriptionId <String>]
[<CommonParameters>]
Description
Gets the specified agent pool in the provisioned cluster
Examples
Example 1: Get all nodepools in a provisioned cluster.
Get-AzAksArcNodepool -ClusterName azps_test_cluster -ResourceGroupName azps_test_group
Name ResourceGroupName
---- -----------------
azps_test_nodepool1 azps_test_group
azps_test_nodepool2 azps_test_group
This command gets the provisioned cluster's nodepools.
Example 2: Get a specific nodepool in a provisioned cluster.
Get-AzAksArcNodepool -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Name azps_test_nodepool1
This command gets the specified provisioned cluster nodepool.
Parameters
-ClusterName
The name of the Kubernetes cluster on which get is called.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Parameter for the name of the agent pool in the provisioned cluster.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SubscriptionId
The ID of the target subscription.
Parameter properties
| Type: | String |
| Default value: | (Get-AzContext).Subscription.Id |
| 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 |
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.
