Get-AzAksNodePoolUpgradeProfile

Module:

Az.Aks

Gets the upgrade profile for an agent pool.

Syntax

Get-AzAksNodePoolUpgradeProfile
   -ClusterName <String>
   -NodePoolName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzAksNodePoolUpgradeProfile
   -InputObject <IAksIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the upgrade profile for an agent pool.

Examples

Example 1: Get Aks node pool upgrade profile with resource group name and cluster name

Get-AzAksNodePoolUpgradeProfile -ResourceGroupName group -ClusterName myCluster -AgentPoolName default

Name    Type
----    ----
default Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles

Get Aks node pool upgrade profile with resource group name and cluster name.

Parameters

-ClusterName

The name of the managed cluster resource.

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

-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:	IAksIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-NodePoolName

The name of the 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.

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

Inputs

IAksIdentity

Outputs

IAgentPoolUpgradeProfile

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IAksIdentity>: Identity Parameter

• [AgentPoolName <String>]: The name of the agent pool.
• [CommandId <String>]: Id of the command.
• [ConfigName <String>]: The name of the maintenance configuration.
• [Id <String>]: Resource identity path
• [Location <String>]: The name of Azure region.
• [PrivateEndpointConnectionName <String>]: The name of the private endpoint connection.
• [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
• [ResourceName <String>]: The name of the managed cluster resource.
• [RoleName <String>]: The name of the role for managed cluster accessProfile resource.
• [SubscriptionId <String>]: The ID of the target subscription.