Start-AzureRmAksDashboard

Reference

Module:: AzureRM.Aks

Create a Kubectl SSH tunnel to the managed cluster's dashboard.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Start-AzureRmAksDashboard
     [-ResourceGroupName] <String>
     [-Name] <String>
     [-DisableBrowser]
     [-PassThru]
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]

Start-AzureRmAksDashboard
     [-InputObject] <PSKubernetesCluster>
     [-DisableBrowser]
     [-PassThru]
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]

Start-AzureRmAksDashboard
     [-Id] <String>
     [-DisableBrowser]
     [-PassThru]
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]

Description

Create a Kubectl SSH tunnel to the managed cluster's dashboard. The SSH tunnel is setup in a PowerShell job called Kubectl-Tunnel and can be found by running Get-Job. The tunnel should be accessable via http://127.0.0.1:8001.

Examples

Start an SSH tunnel and open a browser to the Kubernetes dashboard

PS C:\> Start-AzureRmAksDashboard -ResourceGroupName group -Name myCluster

Parameters

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableBrowser

Do not pop open a browser after establising the kubectl port-forward.

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

-Id

Id of a managed Kubernetes cluster

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

-InputObject

A PSKubernetesCluster object, normally passed through the pipeline.

Type:	PSKubernetesCluster
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Name of your managed Kubernetes cluster

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

-PassThru

Cmdlet returns the KubeTunnelJob if passed.

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

-ResourceGroupName

Resource group name

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

Inputs

PSKubernetesCluster

Parameters: InputObject (ByValue)

String

Outputs

KubeTunnelJob