Service

System Center
 

Updated: June 27, 2017

Applies To: System Center 2016 - Service Provider Foundation, System Center Technical Preview

Reads, creates, updates, or deletes Virtual Machine Manager (VMM) services.

GETPOSTPUTDELETE
YesYesYesYes

GET

Gets the specified VMM services.

If you provide the StampId property, all services within the matching stamp are returned.

If you provide the Name property, the service with the matching name is returned.

If you provide the ID property, the specified service is returned.

If you provide the CloudId property, the query is restricted to the specified cloud.

Entity Properties

NameTypeMandatoryDescription
IDEdm.GuidNoThe identifier of the service.
StampIdEdm.GuidNoThe identifier of the stamp that restricts the query.
NameEdm.StringNoThe name of the service.
CloudIdEdm.GuidNoThe cloud identifier.

POST

Creates a new service based on the specified service template.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp that restricts the query.
ServiceTemplateIdEdm.GuidYesThe identifier of the service template to create this service from
CloudIdEdm.GuidYesThe cloud identifier.
NewServiceDeploymentNewServiceDeploymentNoConfigures service deployment and computer tiers settings.
IgnorePlacementErrorsEdm.BooleanNoIf the value of this property is true, the service will still be created even if any placement errors occur.

PUT

Updates an existing service.

Based on the properties that are provided, the PUT operation can update the properties of the service, reassign ownership, or control the state of the service.

Specifies the Operation property to control the state of the service.

Entity Properties

NameTypeDescription
IDEdm.GuidYesThe identifier of an existing service.
StampIdEdm.GuidYesThe identifier of the stamp that restricts the query.
NameEdm.StringNoThe name of the service.
DescriptionEdm.StringNoThe description of the service.
OwnerUserAndRoleNoThe owner of the service.
GrantedToListUserAndRole[]NoThe users and roles that have access to the service.

 Collection may be empty.
CostCenterEdm.StringNoThe cost center that this service is grouped with.
ServicePriorityEdm.StringNoSpecifies the priority for a service. Valid values are Normal, Low, and High. The default value is Normal.
ServiceTemplateIdEdm.GuidNoThe identifier of the service template.
ServiceSettingsEdm.Collections.ArrayListNoA collection of settings for the service. The settings are ComputerName, RunAsAccount, and VMNetwork.
OperationEdm.StringNoControls the service when this object is submitted to the server. Valid values are Start, Stop, Shutdown, Suspend, and Resume.
RunAsynchronouslyEdm.IntNoIndicates whether the job runs asynchronously.

DELETE

Deletes the specified service.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp that restricts the query.
IDEdm.GuidYesThe identifier of the service to delete.

VMM Collections Reference R2

Show: