Get-AzConnectedKubernetes
Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
Syntax
List1 (Default)
Get-AzConnectedKubernetes
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzConnectedKubernetes
-ClusterName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
List
Get-AzConnectedKubernetes
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Name |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | 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 |
-InputObject
Identity Parameter
Parameter properties
| Type: | IConnectedKubernetesIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
List
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SubscriptionId
The ID of the target subscription.
Parameter properties
| Type: | String[] |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
List1
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Get
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
List
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| 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.