Edit

Share via

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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Id of a managed Kubernetes cluster

Parameter properties

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

Parameter sets

IdParameterSet
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Name of your managed Kubernetes cluster

Parameter properties

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

Parameter sets

NameParameterSet
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

Resource group name

Parameter properties

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

Parameter sets

ResourceGroupParameterSet
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
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.

Inputs

String

Outputs

PSKubernetesCluster