Get-WAPackVMRole
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
Empty (Default)
Get-WAPackVMRole
[-Profile <AzureSMProfile>]
[<CommonParameters>]
FromName
Get-WAPackVMRole
-Name <String>
[-Profile <AzureSMProfile>]
[<CommonParameters>]
FromCloudService
Get-WAPackVMRole
-Name <String>
-CloudServiceName <String>
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
These topics are deprecated and will be removed in the future.
This topic describes the cmdlet in the 0.8.1 version of the Microsoft Azure PowerShell module.
To find out the version of the module you're using, from the Azure PowerShell console, type (Get-Module -Name Azure).Version.
Examples
Example 1: Get a virtual machine role (created through the portal)
PS C:\> Get-WAPackVMRole -Name "ContosoVMRole01"
This command gets a virtual machine role which has been created through the portal named ContosoVMRole01.
Example 2: Get a virtual machine role by using a name and a cloud service name
PS C:\> Get-WAPackVMRole -CloudServiceName "ContosoCloudService01" -Name "ContosoVMRole02"
This command gets a virtual machine role named ContosoVMRole02 which stand on a cloud service named ContosoCloudService01.
Example 3: Get all virtual machine role
PS C:\> Get-WAPackVMRole
This command gets all existing virtual machine role.
Parameters
-CloudServiceName
Specifies the cloud service name of virtual machine role.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromCloudService
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
Specifies the name of a virtual machine role.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
FromCloudService
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Parameter properties
| Type: | AzureSMProfile |
| 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 |
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.