Import-AzAksCredential

Import and merge Kubectl config for a managed Kubernetes Cluster.

Syntax

Import-AzAksCredential
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-Admin]
      [-ConfigPath <String>]
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Import-AzAksCredential
      -InputObject <PSKubernetesCluster>
      [-Admin]
      [-ConfigPath <String>]
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Import-AzAksCredential
      [-Id] <String>
      [-Admin]
      [-ConfigPath <String>]
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Import and merge Kubectl config for a managed Kubernetes Cluster.

Examples

Import and merge Kubectl config

PS C:\> Import-AzAksCredential -ResourceGroupName group -Name myCluster

Parameters

-Admin

Get the 'clusterAdmin' kubectl config instead of the default 'clusterUser'.

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

A kubectl config file to create or update. Use '-' to print YAML to stdout instead. Default: %Home%/.kube/config.

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Import Kubernetes config even if it is the default

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

Id of a managed Kubernetes cluster

Type:String
Aliases:ResourceId
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-InputObject

A PSKubernetesCluster object, normally passed through the pipeline.

Type:Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

Name of your managed Kubernetes cluster

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns true if import is successful

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

Resource group name

Type:String
Position:0
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Azure.Commands.Aks.Models.PSKubernetesCluster

String

Outputs

String