Start-AzAksDashboard
Create a Kubectl SSH tunnel to the managed cluster's dashboard.
Syntax
Start-AzAksDashboard
[-ResourceGroupName] <String>
[-Name] <String>
[-DisableBrowser]
[-ListenPort <Int32>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-SubscriptionId <String>]
[<CommonParameters>] Start-AzAksDashboard
[-InputObject] <PSKubernetesCluster>
[-DisableBrowser]
[-ListenPort <Int32>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-SubscriptionId <String>]
[<CommonParameters>] Start-AzAksDashboard
[-Id] <String>
[-DisableBrowser]
[-ListenPort <Int32>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-SubscriptionId <String>]
[<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 accessible via http://127.0.0.1:8001.
Examples
Start an SSH tunnel and open a browser to the Kubernetes dashboard
Start-AzAksDashboard -ResourceGroupName group -Name myClusterParameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, 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 establishing 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 |
-ListenPort
The listening port for the dashboard. Default value is 8003.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-SubscriptionId
The ID of the subscription. By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |