Start-AzAksManagedClusterCommand
AKS will run a pod to run the command.
This is primarily useful for private clusters.
For more information see AKS Run Command .
Syntax
RunExpanded (Default)
Start-AzAksManagedClusterCommand
-ResourceGroupName <String>
-ResourceName <String>
-Command <String>
[-SubscriptionId <String>]
[-ClusterToken <String>]
[-Context <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RunViaJsonString
Start-AzAksManagedClusterCommand
-ResourceGroupName <String>
-ResourceName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RunViaJsonFilePath
Start-AzAksManagedClusterCommand
-ResourceGroupName <String>
-ResourceName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RunViaIdentityExpanded
Start-AzAksManagedClusterCommand
-InputObject <IAksIdentity>
-Command <String>
[-ClusterToken <String>]
[-Context <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
AKS will run a pod to run the command.
This is primarily useful for private clusters.
For more information see AKS Run Command .
Examples
Example 1: Run AKS command
Start-AzAksManagedClusterCommand -ResourceGroupName mygroup -ResourceName mycluster -Command "kubectl get nodes"
ExitCode : 0
FinishedAt : 3/31/2023 8:52:17 AM
Id : 0a3991475d9744fcbfdc2595b40e517f
Log : NAME STATUS ROLES AGE VERSION
aks-default-40136599-vmss000000 Ready agent 46m v1.24.9
aks-pool2-22198594-vmss000000 Ready agent 43m v1.24.9
ProvisioningState : Succeeded
Reason :
StartedAt : 3/31/2023 8:52:16 AM
AKS will create a pod to run the command.
This is primarily useful for private clusters.
Example 2: Run AKS command via identity
$cluster = Get-AzAksCluster -ResourceGroupName mygroup -Name mycluster
$cluster | Start-AzAksManagedClusterCommand -Command "kubectl get nodes"
ExitCode : 0
FinishedAt : 3/31/2023 8:54:17 AM
Id : 0a3991475d9744fcbfdc2595b40e517f
Log : NAME STATUS ROLES AGE VERSION
aks-default-40136599-vmss000000 Ready agent 46m v1.24.9
aks-pool2-22198594-vmss000000 Ready agent 43m v1.24.9
ProvisioningState : Succeeded
Reason :
StartedAt : 3/31/2023 8:54:16 AM
Parameters
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ClusterToken
AuthToken issued for AKS AAD Server App.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RunExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Command
The command to run.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RunExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Context
A base64 encoded zip file containing the files required by the command.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RunExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunViaIdentityExpanded
Position: Named Mandatory: False 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
Identity Parameter
Type: IAksIdentity
Default value: None Supports wildcards: False DontShow: False
RunViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Run operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RunViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Run operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RunViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False 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
RunExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceName
The name of the managed cluster resource.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RunExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunViaJsonFilePath
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
RunExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunViaJsonFilePath
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
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 .
Outputs
