Service [SPFSDK][VMMREF]

 

Applies To: Windows Azure Pack

The Service entity represents a Virtual Machine Manager (VMM) service.

Inheritance Hierarchy

VMM
  Service

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	Required	Edm.Guid	False	Key Property The identifier of the entity.
StampId	Required	Optional	Required	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 entity was added.
AllVMsAccessible	-	Optional	-	-	Edm.Boolean	True	Internal use only.
CloudId	Required	Optional	-	-	Edm.Guid	True	The identifier of the cloud.
CostCenter	-	Optional	Optional	-	Edm.String	True	The cost center that this service is grouped with.
CustomProperty	-	Optional	-	-	Collection(CustomProperty [SPFSDK][VMMREF])	False	The custom properties of the service.
DeployedTo	-	Optional	-	-	Edm.String	True	Indicates whether the service is deployed to a host group or cloud.
DeploymentState	-	Optional	-	-	Edm.String	True	The deployment state of the service. Value Description Undeployed The service has not yet been deployed. Deploying The service is in the process of being deployed. Deployed The service has been deployed or serviced successfully. DeploymentFailed Some VMs or applications for the service have deployment failures. Servicing The service is in the process of being serviced. ServicingFailed Some VMs or applications of the service have failed during servicing. Deleting The service is in the process of being deleted.
Description	-	Optional	Optional	-	Edm.String	True	The description of the service.
Enabled	-	Optional	-	-	Edm.Boolean	True	Internal use only.
FailedJobID	-	Optional	-	-	Edm.Guid	True	The identifier of a failed job.
GrantedToList	-	Optional	Optional	-	Collection(UserAndRole [SPFSDK][VMMREF])	False	The users and roles that have access to the service.
IgnorePlacementErrors	Optional	Optional	-	-	Edm.Boolean	True	If True, the service will still be created even if placement errors occur.
InServicingMode	-	Optional	-	-	Edm.Boolean	True	Indicate that the Service is in maintenance mode or not.
ModifiedTime	-	Optional	-	-	Edm.DateTime	True	When it was last modified.
Name	-	Optional	Optional	-	Edm.String	True	The name of the service.
NewServiceDeployment	Required	Optional	-	-	NewServiceDeployment [SPFSDK][VMMREF]	True	TBD
NotificationsAvailable	-	Optional	-	-	Edm.Boolean	True	Indicates whether the service has outstanding Notifications or not. When true, this means that there are newer service templates available for the service.
Operation	-	Optional	Optional	-	Edm.String	True	Controls the service when this object is submitted to the server. Valid values are. Start Stop Shutdown Suspend Resume
OverallStatus	-	Optional	-	-	Edm.String	True	Indicates that the service has a warning or error associated with it. Either OK or NeedsAttention. This property reports the overall status of the service by looking for a negative status from the ServiceStatus property and then the DeploymentState property.
Owner	-	Optional	Optional	-	UserAndRole [SPFSDK][VMMREF]	True	The owner of the service.
PendingServiceSettings	-	Optional	-	-	Collection(ServiceSetting [SPFSDK][VMMREF])	False	Service settings that will be updated.
PendingServiceTemplatePresent	-	Optional	-	-	Edm.Boolean	True	Whether an updated template is available.
PendingServiceTemplateRelease	-	Optional	-	-	Edm.String	True	The release of the pending service template.
ServicePriority	-	-	Optional	-	Edm.String	True	The priority for a service Normal (default) Low High
ServiceSettings	-	Optional	Optional	-	Collection(ServiceSetting [SPFSDK][VMMREF])	False	A collection of settings for the service. The settings are. ComputerName RunAsAccount VMNetwork
ServiceStatus	-	Optional	-	-	Edm.String	True	Indicates that the service has a warning or error associated with it. Either OK or NeedsAttention.
ServiceTemplateId	Required	Optional	Optional	-	Edm.Guid	True	The identifier of the service template.
ServiceTemplateRelease	-	Optional	-	-	Edm.String	True	The release of the service template.
ServicingWindow	-	Optional	-	-	ServicingWindow [SPFSDK][VMMREF]	True	The schedule of when this service can be serviced.
VMHostGroup	-	Optional	-	-	Edm.String	True	The name of the host group this service is deployed to.

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
FailedJob	One or None	Not specified	Job [SPFSDK][VMMREF]	Not specified
PendingServiceTemplate	One or None	Not specified	ServiceTemplate [SPFSDK][VMMREF]	Not specified
ServiceTemplate	One or None	Not specified	ServiceTemplate [SPFSDK][VMMREF]	Not specified
Cloud	One or None	Not specified	Cloud [SPFSDK][VMMREF]	Not specified
ComputerTiers	Many	Not specified	ComputerTier [SPFSDK][VMMREF]	Not specified
MostRecentTask	One or None	Not specified	Job [SPFSDK][VMMREF]	Not specified
ApplicationHosts	Many	Not specified	ApplicationHost [SPFSDK][VMMREF]	Not specified

OData Operations

None

Notes

The RunAsynchronously query parameter may be added to the URL (with a value of 1) of an Update operation. This will tell the service to return immediately after the request is sent instead of waiting for the update to finish, which may cause the request to timeout. For example:

https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/Services(ID=guid'38c9c3b9-9288-4d7a-82fa-501cd4eb9ecb',StampId=guid'd70c1a9b-c241-48f5-880a-b6c36071e653')?RunAsynchronously=1

Examples

• Create (POST) a Service [SPFSDK][VMMREF]

• Read (GET) a Service [SPFSDK][VMMREF]

• Update (PUT) a Service [SPFSDK][VMMREF]

• Delete (DELETE) a Service [SPFSDK][VMMREF]

See Also

Entities [SPFSDK][VMMREF]
Services Collection [SPFSDK][VMMREF]
ServiceTemplate [SPFSDK][VMMREF]