Modifier

Partager via

Get-AzAksArcClusterAdminKubeconfig

  • Reference
Module:
Az.AksArc

Lists the admin credentials of the provisioned cluster (can only be used within private network)

Syntax

Get-AzAksArcClusterAdminKubeconfig
   -ClusterName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-FilePath <String>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Lists the admin credentials of the provisioned cluster (can only be used within private network)

Examples

Example 1: Get the admin kubeconfig for the provisioned cluster.

Get-AzAksArcClusterAdminKubeconfig -ClusterName azps_test_cluster -ResourceGroupName azps_test_group

This command retrieves the admin kubeconfig for the provisioned cluster and prints it.

Example 2: Get the admin kubeconfig for the provisioned cluster and saves to the specified file.

Get-AzAksArcClusterAdminKubeconfig -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -FilePath "C:\Users\sampleuser\samplekubeconfig"

This command retrieves the admin kubeconfig for the provisioned cluster and saves to the specified file.

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ClusterName

The name of the Kubernetes cluster on which get is called.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FilePath

The path to save the kubeconfig to.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

IListCredentialResponse