Windows Azure Pack Service Management REST API Reference

 

Applies To: Windows Azure Pack

The Service Management API for the Windows Azure Pack is a collection of REST APIs that provide extensibility for Service Management on the Windows Server operating system.

The following describes the permissions for the Service Management API.

Administrator interfaces

REST APIs that are only available to Service Management for administrators. When you implement these APIs, you must set the port number in the URI request to 30004.

Common interfaces

REST APIs that are available to Service Management for administrators and tenants. When you implement these APIs, you must set the port number in the URI request to either 30005 for the tenant API or 30004 for the administrator API.

Public tenant interfaces

Public REST APIs that support end-user subscription management for services. When you implement these APIs, you must set the port number in the URI request to 30006.

Tenant interface

REST APIs that enable tenants to manage and configure cloud services that are included in the plans to which they subscribe. When you implement these APIs, you must set the port number in the URI request to 30005.

This section has the following topics.

Name

Description

Administrator Add-on Interfaces

REST APIs to create and manage add-ons with the management portal for administrators. The APIs are only available to administrators.

Administrator Plan Interfaces

REST APIs to create and manage add-ons with the management portal for administrators. The APIs are only available to administrators.

Administrator Resource Provider Interfaces

REST APIs to create and manage resource providers with the management portal for administrators. The APIs are only available to administrators.

Administrator Subscription Interfaces

REST APIs to create and manage subscriptions with the management portal for administrators. The APIs are only available to administrators.

Administrator User Interfaces

REST APIs to create and manage users with the management portal for administrators. The APIs are only available to administrators.

Common Add-on Interfaces

REST APIs to retrieve add-ons. The APIs are available to administrators and tenants.

Common Plan Interfaces

REST APIs to retrieve plans. The APIs are available to administrators and tenants.

Common Setting Interfaces

REST APIs to update settings. The APIs are available to administrators and tenants.

Common Subscription Interfaces

REST APIs to create and manage subscriptions. The APIs are available to administrators and tenants.

Common User Interfaces

REST APIs to create and manage users. The APIs are available to administrators and tenants.

Public Tenant Subscription Interfaces

Public REST APIs that services can use to manage subscriptions for end users. The APIs are available to tenants.

Tenant Add-on Interfaces

REST APIs to retrieve add-ons. The APIs are available to tenants.

Tenant Management Certificate Interfaces

REST APIs to create and manage management certificates. The APIs are available to tenants.

Tenant Plan Interfaces

REST APIs to retrieve plans. The APIs are available to tenants.

Tenant Subscription Interfaces

REST APIs to create and manage subscriptions. The APIs are available to tenants.

Status and Error Codes (Windows Azure Pack Service Management)

Error codes for the Service Management API.

Show: