Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzAksCluster

Module:
Az.Aks Module

List Kubernetes managed clusters.

Syntax

ResourceGroupParameterSet (Default) 

Get-AzAksCluster
 [[-ResourceGroupName] <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [-SubscriptionId <String>]
 [<CommonParameters>]

IdParameterSet 

Get-AzAksCluster
 [-Id] <String>
 [-DefaultProfile <IAzureContextContainer>]
 [-SubscriptionId <String>]
 [<CommonParameters>]

NameParameterSet 

Get-AzAksCluster
 [-ResourceGroupName] <String>
 [-Name] <String>
 [-DefaultProfile <IAzureContextContainer>]
 [-SubscriptionId <String>]
 [<CommonParameters>]

Description

List Kubernetes managed clusters.

Examples

Example 1: List all Kubernetes clusters

Get-AzAksCluster

Parameters

-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

-Id

Id of a managed Kubernetes cluster

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ResourceId

Parameter sets

-Name

Name of your managed Kubernetes cluster

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceGroupName

Resource group name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-SubscriptionId

The ID of the subscription. By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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.

Inputs

String

Outputs

PSKubernetesCluster

Feedback

Was this page helpful?