Custom Resource Provider Endpoints

 

Applies To: Windows Azure Pack

To integrate with Windows Azure Pack there are 4 endpoints that a custom provider must account for.

Administrator Endpoint

The administrator is the address where the Windows Azure Pack Service Management REST API sends requests from the administrator API. This is also the address where the API layer expects to receive responses to administrator transactions expect subscriptions and offers; these transactions are sent to and handled by the Notification Endpoint.

Tenant Endpoint

The tenant endpoint is the address where the Service Management API layer sends all requests from the Tenant API. This is also the location where the Service Management API layer expects to receive responses from tenant transactions.

The Service Management API layer serves as a proxy for translating the incoming URIs from the tenant into a format that can be consumed by the custom resource provider. During registration, the custom resource provider has an option of specifying the source and target translation template to the Service Management API layer. A typical mapping would be as follows:

Tenant Source URI template

{subid}/services/sqlservers/{*path}

Tenant Target URI template

{subid}/{*path}

Alternatively, the custom resource provider can supply only the target endpoint and the Service Management API layer will automatically determine a translation pattern on implicitly defined rules.

Notification Endpoint

The notification endpoint is used for subscription and offers related to transactions. When a user signs up for a plan, the Service Management API layer registers the user by sending a fan-out call to the notification endpoints for each resource provider in the plan. To support this and other notifications, such as the deletion of a subscription, a customer resource provider must implement the following REST API:

  • Create Subscription

  • Get Subscription

  • Get Subscription Usage Summary

  • Update Subscription

  • Delete Subscription

  • Update Quota

  • Validate Quota

  • Get Default Quota

For more information, see Windows Azure Pack Custom Resource Provider Notification REST API Reference

Usage Endpoint

The usage endpoint is used by a resource provider to expose usage data that is collected by the Windows Azure Pack for Windows Server usage collector. Usage data can then be used to calculate billing costs for resources used by a customer. For information about creating a billing adaptor, see Windows Azure Pack Usage Service.

The usage collector sends a request to the usage endpoint at predetermined intervals with a specific record identifier and batch size request. In return the resource provider sends its usage data.

The usage collector sends a request to the usage endpoint in the format https://<usageendpoint>/usage. Therefore, the implementation of the usage endpoint must expose a /usage folder.

An example usage collector request is as follows:

https://<usageendpoint>/usage?lastID=23451&batchSize=100

For more information, see Windows Azure Pack Custom Resource Provider Usage REST API Reference

See Also

Windows Azure Pack Custom Resource Providers
Windows Azure Pack Custom Resource Provider Notification REST API Reference
Windows Azure Pack Custom Resource Provider Usage REST API Reference