Get-AzNetworkCloudKubernetesCluster

  • Reference
Module:
Az.NetworkCloud

Get properties of the provided the Kubernetes cluster.

Syntax

Get-AzNetworkCloudKubernetesCluster
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzNetworkCloudKubernetesCluster
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzNetworkCloudKubernetesCluster
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzNetworkCloudKubernetesCluster
   -InputObject <INetworkCloudIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get properties of the provided the Kubernetes cluster.

Examples

Example 1: List Kubernetes clusters by subscription

Get-AzNetworkCloudKubernetesCluster -SubscriptionId subscriptionId

Location Name                          SystemDataCreatedAt SystemDataCreatedBy                  SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy             SystemDataLastModifiedByType ResourceGroupName
-------- ----                          ------------------- -------------------                  ----------------------- ------------------------ ------------------------             ---------------------------- -----------------
location kubernetesCluster1            06/30/2023 20:39:44 <Identity>                           User                    08/03/2023 20:26:35      <Identity>                           Application                  resourceGroupName
location kubernetesCluster2            07/11/2023 02:49:35 <Identity>                           User                    08/03/2023 20:26:32      <Identity>                           Application                  resourceGroupName
location kubernetesCluster3            07/15/2023 22:04:00 <Identity>                           Application             07/15/2023 22:18:48      <Identity>                           Application                  resourceGroupName
location kubernetesCluster4            07/25/2023 21:00:31 <Identity>                           User                    08/03/2023 20:26:37      <Identity>                           Application                  resourceGroupName

This command lists all Kubernetes clusters under a subscription.

Example 2: Get Kubernetes cluster

Get-AzNetworkCloudKubernetesCluster -KubernetesClusterName kubernetesClusterName -SubscriptionId subscriptionId -ResourceGroupName resourceGroupName

Location Name    SystemDataCreatedAt SystemDataCreatedBy    SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy             SystemDataLastModifiedByType ResourceGroupName
-------- ----    ------------------- -------------------    ----------------------- ------------------------ ------------------------             ---------------------------- -----------------
location default 08/09/2023 20:23:17 <Identity>             User                    08/09/2023 20:44:27      <Identity>                           Application                  resourceGroupName

This command gets a Kubernetes cluster by name.

Example 3: List Kubernetes cluster by resource group

Get-AzNetworkCloudKubernetesCluster -ResourceGroupName resourceGroupName -SubscriptionId subscriptionId

Location Name    SystemDataCreatedAt SystemDataCreatedBy    SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy             SystemDataLastModifiedByType ResourceGroupName
-------- ----    ------------------- -------------------    ----------------------- ------------------------ ------------------------             ---------------------------- -----------------
location default 08/09/2023 20:23:17 <Identity>             User                    08/09/2023 20:44:27      <Identity>                           Application                  resourceGroupName

This command lists all Kubernetes clusters in a resource group.

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

-Name

The name of the Kubernetes cluster.

Type:String
Aliases:KubernetesClusterName
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

IKubernetesCluster