Get-AzConnectedKubernetes
Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
Syntax
Get-AzConnectedKubernetes
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzConnectedKubernetes
-ClusterName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzConnectedKubernetes
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzConnectedKubernetes
-InputObject <IConnectedKubernetesIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
Examples
Example 1: Get all connected kubernetes under a subscription.
Get-AzConnectedKubernetes
Location Name ResourceGroupName
-------- ---- -----------------
eastus azps_test_cluster azps_test_group
eastus azps_test_cluster_ahb azps_test_group
This command gets all connected kubernetes under a subscription.
Example 2: Get all connected kubernetes under the resource group.
Get-AzConnectedKubernetes -ResourceGroupName azps_test_group
Location Name ResourceGroupName
-------- ---- -----------------
eastus azps_test_cluster azps_test_group
eastus azps_test_cluster_ahb azps_test_group
This command gets all connected kubernetes under the resource group.
Example 3: Get a connected kubernetes.
Get-AzConnectedKubernetes -ResourceGroupName azps_test_group -Name azps_test_cluster
Location Name ResourceGroupName
-------- ---- -----------------
eastus azps_test_cluster azps_test_group
This command gets a connected kubernetes.
Example 4: Get a connected kubernetes by object.
$conAks = Get-AzConnectedKubernetes -ClusterName azps_test_cluster_ahb -ResourceGroupName azps_test_group
Get-AzConnectedKubernetes -InputObject $conAks
Location Name ResourceGroupName
-------- ---- -----------------
eastus azps_test_cluster_ahb azps_test_group
This command gets a connected kubernetes by object.
Parameters
-ClusterName
The name of the Kubernetes cluster on which get is called.
Type: | String |
Aliases: | Name |
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: | IConnectedKubernetesIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |