Share via

ServiceTemplate [SPFSDK][VMMREF]

  • Article

 

Applies To: Windows Azure Pack

The ServiceTemplate entity represents a template for a Virtual Machine Manager (VMM) service.

Inheritance Hierarchy

VMM
  ServiceTemplate

Entity Properties

For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.

Name

Create (POST)

Read (GET)

Update (PUT)

Delete (DELETE)

Type

Nullable

Description

ID

-

Optional

Required

-

Edm.Guid

False

Key Property

The identifier of the entity.

StampId

-

Optional

Required

-

Edm.Guid

False

Key Property

The identifier of the stamp that restricts the query.

Accessibility

-

Optional

-

-

Edm.String

True

Indicates whether the object is publically available or not, either Public or Internal.

AddedTime

-

Optional

-

-

Edm.DateTime

True

When the template was added.

CustomProperty

-

Optional

-

-

Collection(CustomProperty [SPFSDK][VMMREF])

False

The custom properties of the service template.

Description

-

Optional

-

-

Edm.String

True

The description of the template.

Enabled

-

Optional

-

-

Edm.Boolean

True

Internal use only.

GrantedToList

-

Optional

Required

-

Collection(UserAndRole [SPFSDK][VMMREF])

False

The users and roles that have access to the template.

IsPublished

-

Optional

-

-

Edm.Boolean

True

Whether the template is published.

ModifiedTime

-

Optional

-

-

Edm.DateTime

True

When the template was last modified

Name

-

Optional

-

-

Edm.String

True

The name of the template.

Namespace

-

Optional

-

-

Edm.String

True

Reports the location of the service template, the global or tenant namespace.

NotificationsAvailable

-

Optional

-

-

Edm.Boolean

True

Indicates whether the service template has outstanding Notifications.

Owner

-

Optional

-

-

UserAndRole [SPFSDK][VMMREF]

True

The owner of the template.

PublishedTime

-

Optional

-

-

Edm.DateTime

True

When the template was published.

Release

-

Optional

-

-

Edm.String

True

The release of the template.

ServicePriority

-

Optional

-

-

Edm.String

True

the priority for a service.

  • Normal (default)

  • Low

  • High

ServiceSettings

-

Optional

-

-

Collection(ServiceSetting [SPFSDK][VMMREF])

False

A collection of settings for the service. The settings are.

  • ComputerName

  • RunAsAccount

  • VMNetwork

ServiceTemplateState

-

Optional

-

-

Edm.String

True

The state of the template. One of the following.

  • Normal

  • Missing

  • UnderCreation

  • CreationFailed

  • NeedsAttention

UseAsDefaultRelease

-

Optional

-

-

Edm.Boolean

True

Whether this release is used as the default release for the service template.

UseAsPattern

-

Optional

-

-

Edm.Boolean

True

Indicates weather or not this template is usable in the designer as a pattern.

Relationships

For more information about how the relationships of an entity are used, see Entity Basics.

Name

Relationship Type

From Property

To Entity

To Property

ComputerTierTemplates

Many

Not specified

ComputerTierTemplate [SPFSDK][VMMREF]

Not specified

ApplicationHostTemplates

Many

Not specified

ApplicationHostTemplate [SPFSDK][VMMREF]

Not specified

OData Operations

None

Examples

See Also

Entities [SPFSDK][VMMREF]
ServiceTemplates Collection [SPFSDK][VMMREF]
Service [SPFSDK][VMMREF]