Get-AzVMRunCommandDocument

Module:

Az.Compute

Get a run command document.

Syntax

Get-AzVMRunCommandDocument
   [-Location] <String>
   [[-CommandId] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Get a run command document.

Examples

Example 1

Get-AzVMRunCommandDocument -Location 'westus' -CommandId 'RunPowerShellScript'

Gets a specific run command document for 'RunPowerShellScript' in 'westus'.

Example 2

Get-AzVMRunCommandDocument -Location 'westus'

Lists all available run commands in 'westus'.

Parameters

-CommandId

The command ID.

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

-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

-Location

The location upon which run commands are queried.

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

Inputs

String

Outputs

PSRunCommandDocument