Users Guide
• getService: Retrieves the Service of the given name.
– name — Name of the Service that should be retrieved.
• getServiceById: Retrieves the Service of the given id.
– deploymentId — id of the Service that is to be fetched.
• getServiceStatus: Returns the status of the target Service (For example, in_progress, complete, error).
NOTE: The returned status is no longer capitalized as in versions 1.0 –1.1.
– vsoDeployment — Service that is to be checked for its status.
• getServiceTemplateComponentById: Retrieves a ServiceComponent object that has the matching id from the given Service
object.
– deployment — the target Service object.
– componentId — the component id.
• getServiceTemplateComponents: Retrieves a list of ServiceComponent objects from the given Service.
– deployment — The Service to retrieve the ServiceComponent objects.
• getServiceTemplateComponentsByType: Retrieves a list of ServiceComponent objects, but the result is ltered by the
selected resource types.
– deployment — The Service to retrieve the ServiceComponent objects.
– storage — Boolean value indicating that the returned list of ServiceComponents should include STORAGE type
components if available.
– server — Boolean value indicating that the returned list of ServiceComponents should include SERVER type
components if available.
– cluster — Boolean value indicating that the returned list of ServiceComponents should include CLUSTER type
components if available.
– vm — Boolean value indicating that the returned list of ServiceComponents should include VIRTUALMACHINE type
components if available.
– app — Boolean value indicating that the returned list of ServiceComponents should include SERVICE (application) type
components if available.
• getServices: Returns a list of all the Services in the ASM server.
This method is deprecated, and the method description does not show in the API Explorer. Use the attribute, services, instead.
• getTemplateById: This method takes the Template id and fetches the Template object of the matching id from the Appliance.
– templateId — ID of the target Template.
• getTemplates: Returns a list of all the published Templates in the ASM server.
This method is deprecated, and the method description does not appear on the API Explorer. Use the attribute, templates,
instead.
• scaleDownService: This method removes the resources of the selected types from the chosen Service. If a resource type is
selected and no resources of that type exists, it will simply not aect the overall operation of the scale down (For example,
scaling down VIRTUALMACHINE type resources in a Service without any will not aect the Service after the operation has been
completed). Returned object is the Service with updated components list.
– deployment — The Service where the resources of the selected types are to be removed.
– storage — Boolean value indicating that STORAGE type components are to be removed.
– server — Boolean value indicating that SERVER type components are to be removed.
– cluster — Boolean value indicating that CLUSTER type components are to be removed.
16