Role Class

Definition

Namespace:

Microsoft.WindowsAzure.Management.Compute.Models

Assembly:

Microsoft.WindowsAzure.Management.Compute.dll

Package:

Microsoft.WindowsAzure.Management.Compute v14.0.0

Details of a role in a deployment.

public class Role

type Role = class

Public Class Role

Inheritance

Object

Role

Constructors

Role()

Initializes a new instance of the Role class.

Properties

AvailabilitySetName	Optional. The name of the role.
ConfigurationSets	Optional. A collection of values that represents system or application configuration settings.
DataVirtualHardDisks	Optional. Contains the parameters Azure uses to create a data disk for a virtual machine.
DebugSettings	Optional. This parameter can be used to set debug settings for a VM. When boot diagnostics feature is enabled, console screenshot or serial output is stored in blob storage. This property is only returned with a version header of 2015-09-01 or newer.
DefaultWinRmCertificateThumbprint	Optional. The read-only thumbprint of the certificate that is used with the HTTPS listener for WinRM.
Label	Optional. The friendly name for the role.
LicenseType	Optional. Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system. Possible values are: Windows_Client, Windows_Server
MediaLocation	Optional. Storage location where the VM Image VHDs should be copied, for published VM Images.
MigrationState	Optional. Specifies the IaaS Classic to ARM migration state of the virtual machine.Possible values are: None, Preparing, Prepared, PrepareFailed, Committing, Committed, CommitFailed, Aborting, AbortFailed.None is treated as null value and it is not be visible.
OSVersion	Optional. The version of the operating system on which the role instances are running.
OSVirtualHardDisk	Optional. Contains the parameters Azure uses to create the operating system disk for the virtual machine.
ProvisionGuestAgent	Optional. Indicates whether the WindowsAzureGuestAgent service is installed on the Virtual Machine. To run a resource extension in a Virtual Machine, this service must be installed.
ResourceExtensionReferences	Optional. Contains a collection of resource extensions that are to be installed on the Virtual Machine. This element is used if ProvisionGuestAgent is set to true.
RoleName	Optional. The name of the role.
RoleSize	Optional. The size of the role instance.
RoleType	Optional. Specifies the type of the role. This element is only listed for Virtual Machine deployments, and by default is PersistentVMRole.
VMImageInput	Optional. When a VM Image is used to create a new PersistantVMRole, the DiskConfigurations in the VM Image are used to create new Disks for the new VM. This parameter can be used to resize the newly created Disks to a larger size than the underlying DiskConfigurations in the VM Image.This property is only returned with a version header of 2014-10-01 or newer.
VMImageName	Optional. Optional. The name of the VMImage from which this Role is to be created. If the OSDisk in the VMImage was Specialized, then no WindowsProvisioningConfigurationSet or LinuxProvisioningConfigurationSet should be provided. No OSVirtualHardDisk or DataVirtualHardDisk should be specified when using this argument.