Get-AzureRmVMRunCommandDocument
Get run command document.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmVMRunCommandDocument
[-Location] <String>
[[-CommandId] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
Get run command document.
Examples
Example 1
PS C:\> Get-AzureRmVMRunCommandDocument -Location 'westus' -CommandId 'RunPowerShellScript'Gets a specific run command document for 'RunPowerShellScript' in 'westus'. Get-AzureRmVMRunCommandDocument -Location $loc
Example 2
PS C:\> Get-AzureRmVMRunCommandDocument -Location 'westus'Lists all available run commands in 'westus'.
Parameters
-CommandId
The command id.
| Type: | String |
| Position: | 2 |
| 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: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
The location upon which run commands is queried.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |