Get-AzNetworkCloudAgentPool

Reference

Module:: Az.NetworkCloud

Get properties of the provided Kubernetes cluster agent pool.

Syntax

Get-AzNetworkCloudAgentPool
   -KubernetesClusterName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzNetworkCloudAgentPool
   -KubernetesClusterName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzNetworkCloudAgentPool
   -InputObject <INetworkCloudIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get properties of the provided Kubernetes cluster agent pool.

Examples

Example 1: List Kubernetes cluster's agent pools

Get-AzNetworkCloudAgentPool -KubernetesClusterName clusterName -ResourceGroupName resourceGroup -SubscriptionId subscriptionId

Location  Name               SystemDataCreatedAt   SystemDataCreatedBy    SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy
--------       ----                     -------------------                -------------------                  -----------------------                   ------------------------                 ------------
westus3  agentpool1       07/11/2023 18:14:59   <identity>                          User                                          07/18/2023 17:46:45           <identity>
westus3  testagentpool1 07/18/2023 17:44:02   <identity>                         User                                          07/18/2023 17:46:45           <identity>

This command lists all agent pools of kubernetes cluster.

Example 2: Get Kubernetes cluster's agent pool

Get-AzNetworkCloudAgentPool -Name agentPoolName -KubernetesClusterName clusterName -ResourceGroupName resourceGroup -SubscriptionId subscriptionId

Location  Name               SystemDataCreatedAt   SystemDataCreatedBy    SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy
--------       ----                     -------------------                -------------------                  -----------------------                   ------------------------                 ------------
westus3  testagentpool1 07/18/2023 17:44:02   <identity>                         User                                          07/18/2023 17:46:45           <identity>

This command gets details of an agent pool.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	INetworkCloudIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-KubernetesClusterName

The name of the Kubernetes cluster.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the Kubernetes cluster agent pool.

Type:	String
Aliases:	AgentPoolName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

INetworkCloudIdentity

Outputs

IAgentPool

Share via