Get-AzVMRunCommandDocument
Get a run command document.
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, 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 |
-Location
The location upon which run commands are queried.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| 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.
