VirtualMachineRole (Instance) [SPFSDK][VMROLE]

 

Applies To: Windows Azure Pack

The VirtualMachineRole type represents a virtual machine role resource.

Syntax

{
    "Name": "String",
    "Label": "String",
    "ProvisioningState": "String",
    "ResourceDefinition": { <ResourceDefinition> },
    "ResourceConfiguration": { <ResourceConfiguration> },
    "InstanceView": { <InstanceView> },
    "Substate": { "VMRoleMessages": [] }
}

Properties

Important

For more information about the Access column, see Property Access [SPFSDK][VMROLE].

Name	Type	Access	Description
Name	String	RC	The name of the resource.
Label	String	RCU	A localized display label for the resource.
ResourceDefinition	ResourceDefinition [SPFSDK][VMROLE]	RCU	The template of the resource, either from when the resource was created, or from the last time that it was updated. To update, change this property to another resource definition.
ResourceConfiguration	ResourceConfiguration [SPFSDK][VMROLE]	RCU	The parameter values that are used when the resource is provisioned. To update, provide a new ResourceConfiguration object with the ResourceConfiguration.Version property that is updated to a bigger value.
ProvisioningState	String	R	The state of the resource. Possible values are: Provisioning Provisioned Updating Failed Deprovisioned
Substate	VMRoleSubstate [SPFSDK][VMROLE]	R	Specific details about the current provisioning state.
InstanceView	VMRoleInstanceView [SPFSDK][VMROLE]	R	A read-only view of the virtual machine role instance information.

Remarks

The following code example provides a sample VirtualMachineRole object.

{
    "Label": "Description Value Here",
    "Name": "TestFromCodeVMRole",
    "ProvisioningState": "Provisioned",

    "ResourceConfiguration": {
        "Version": "1.0.0.0",

        "ParameterValues": "{ 
            \"MyParameter1\" : \"Value1\",
            \"MyParameter2\" : \"Value2\" 
        }"
    },

    "ResourceDefinition": { ... },
    "InstanceView": {
        "InstanceCount": "1",
        "ResolvedResourceDefinition": { ... },
        "VIPs": []
    },
    "Substate": { "VMRoleMessages": [] }
}

See Also

VM Role JSON Reference [SPFSDK][VMROLE]
ResourceConfiguration [SPFSDK][VMROLE]
VMRoleSubstate [SPFSDK][VMROLE]
VMRoleInstanceView [SPFSDK][VMROLE]
ResourceDefinition [SPFSDK][VMROLE]