Share via

VMRoleInstanceView [SPFSDK][VMROLE]

  • Article

 

Applies To: Windows Azure Pack

The VMRoleInstanceViewtype contains a ResourceDefinition member with various properties that are resolved by the ResourceConfiguration.ParameterValues property values. Additionally, the count of virtual machines and the virtual IPs that those virtual machines use are available.

Syntax

"VMRoleInstanceView": {
    "InstanceCount": "Integer",
    "ResolvedResourceDefinition": { <ResourceDefinition> },
    "VIPs": [ <VMRoleVIP> ]
}

Properties

Important

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

Name

Type

Access

Description

InstanceCount

Integer

R

The count of virtual machines in this virtual machine role.

ResolvedResourceDefinition

ResourceDefinition [SPFSDK][VMROLE]

R

The ResourceDefinition template that the virtual machine role uses. All of the ResourceDefinition parameters will be filled in with their configured values.

VIPs

Array of VMRoleIP [SPFSDK][VMROLE]

R

Array of load-balanced network adapters that this virtual machine role uses.

Remarks

The following code example provides a sample VMRoleInstanceView type.

"VirtualMachineRoleInstance": {
    "InstanceView": {
        "InstanceCount": "1",
        "ResolvedResourceDefinition": { ... },
        "VIPs": []
    }
}

See Also

VirtualMachineRole (Instance) [SPFSDK][VMROLE]
ResourceDefinition [SPFSDK][VMROLE]
VMRoleIP [SPFSDK][VMROLE]
Property Access [SPFSDK][VMROLE]