VirtualMachineRole (Gallery)[SPFSDK][VMROLE]

 

Applies To: Windows Azure Pack

Represents a virtual machine role (VM role) gallery item. These objects are created by importing a gallery item.

Syntax

{
    "ContentUrl": string,
    "Description": string,
    "IconUrl": string,
    "Label": string,
    "Name": string,
    "PublishDate": date-time,
    "Publisher": string,
    "PublisherLabel": string,
    "ResourceDefinition@odata.mediaContentType": string,
    "ResourceDefinitionUrl": string,
    "Version": string,
    "ViewDefinitionUrl": string,
    "odata.type": string
}

Properties

Important

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

Name	Type	Access	Description
odata.type	String	R	The type of gallery item. For VM roles, the value is MicrosoftCompute.VMRoleGalleryItem.
Name	String	R	The identifier of the gallery item.
Version	String	R	The version identifier of the gallery item, in Major.Minor.Build format.
Publisher	String	R	The publisher of the gallery item.
Description	String	R	The description of the gallery item.
ContentUrl	String	R	The URL to the files that are included in the gallery item, such as images.
Label	String	R	The display name for the gallery item, in the requestor’s locale.
PublisherLabel	String	R	The display name for the publisher of the gallery item, in the requestor’s locale.
PublishDate	DateTime	R	The date and time that the gallery item was created.
IconUrl	String	R	The URL to an icon that represents the gallery item.
ResourceDefinitionUrl	String	R	The URL of the ResourceDefinition [SPFSDK][VMROLE] JSON object that defines the contents of the gallery item.
ResourceDefinition@odata.mediaContentType	String	R	The type of content available at the URL that is specified by the ResourceDefinitionURL property.
ViewDefinitionUrl	String	R	The URL of the view definition JSON object that defines the UI information that is used when an instance of the gallery item resource definition is created.

Remarks

The following code example provides a sample VirtualMachineRole object.

{
    "ContentUrl": "Gallery/GalleryItems(Name%3d%27CentOS6LAMP%27,Version%3d%271.0.0.0%27,Publisher%3d%27Microsoft%27)/Content",
    "Description": "Deploy a CentOS 6 virtual machine role with Apache, MySQL and PHP installed.",
    "IconUrl": null,
    "Label": "CentOS6 LAMP Role",
    "Name": "CentOS6LAMP",
    "PublishDate": "2013-09-05T18:35:00.967",
    "Publisher": "Microsoft",
    "PublisherLabel": "Microsoft",
    "ResourceDefinition@odata.mediaContentType": "application/json",
    "ResourceDefinitionUrl": "Gallery/GalleryItems(Name%3d%27CentOS6LAMP%27,Version%3d%271.0.0.0%27,Publisher%3d%27Microsoft%27)/MicrosoftCompute.ResourceDefinitionGalleryItem/ResourceDefinition",
    "Version": "1.0.0.0",
    "ViewDefinitionUrl": "Gallery/ViewDefinitions(Name%3d%27CentOS6LAMP%27,Version%3d%271.0.0.0%27,Publisher%3d%27Microsoft%27)/%24value",
    "odata.type": "MicrosoftCompute.VMRoleGalleryItem"
}

See Also

VM Role JSON Reference [SPFSDK][VMROLE]
ResourceDefinition [SPFSDK][VMROLE]
VirtualMachineRole (Instance) [SPFSDK][VMROLE]
Property Access [SPFSDK][VMROLE]