< Back

Get-AzureRmVMRunCommandDocument

Tue Jan 29, 2019 9:37 pm

NAME Get-AzureRmVMRunCommandDocument



SYNOPSIS

Get run command document.





SYNTAX

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





DESCRIPTION

Get run command document.





PARAMETERS

-CommandId <String>

The command id.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Location <String>

The location upon which run commands is queried.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String







OUTPUTS

Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandDocument







NOTES









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







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... nddocument