Edit

Share via

Get-AzAksManagedClusterCommandResult

Module:
Az.Aks Module

Gets the results of a command which has been run on the Managed Cluster.

Syntax

Get (Default) 

Get-AzAksManagedClusterCommandResult
    -CommandId <String>
    -ResourceGroupName <String>
    -ResourceName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

GetViaIdentityManagedCluster 

Get-AzAksManagedClusterCommandResult
    -CommandId <String>
    -ManagedClusterInputObject <IAksIdentity>
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

GetViaIdentity 

Get-AzAksManagedClusterCommandResult
    -InputObject <IAksIdentity>
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

Description

Gets the results of a command which has been run on the Managed Cluster.

Examples

Example 1: Get the results of a command which has been run on the Managed Cluster.

Get-AzAksManagedClusterCommandResult -ResourceGroupName mygroup -ResourceName mycluster -CommandId '706de66629b14267b4962cf015122c12'

ExitCode          : 0
FinishedAt        : 3/31/2023 9:14:40 AM
Id                : 706de66629b14267b4962cf015122c12
Log               : NAME                              STATUS   ROLES   AGE   VERSION
                    aks-default-40136599-vmss000000   Ready    agent   68m   v1.24.9
                    aks-pool2-22198594-vmss000000     Ready    agent   65m   v1.24.9

ProvisioningState : Succeeded
Reason            :
StartedAt         : 3/31/2023 9:14:38 AM

Parameters

-CommandId

Id of the command.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentityManagedCluster
Position:Named
Mandatory:True
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

-InputObject

Identity Parameter

Parameter properties

Type:IAksIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ManagedClusterInputObject

Identity Parameter

Parameter properties

Type:IAksIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityManagedCluster
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns true when the command succeeds

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

Get
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

Get
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

Get
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.

Inputs

IAksIdentity

Outputs

IRunCommandResult