Retrieve a Resource Provider Instance

Article
08/24/2015

Applies To: Windows Azure Pack

Retrieves an instance of a resource provider.

Request

Replace <ServiceMgmt> with your Service Management API endpoint address. Replace <Name> with the resource provider name. Replace <InstanceIdentifier> with the instance identifier of the resource provider instance that is to be retrieved.

Method	Request URI	HTTP version
GET	https://<ServiceMgmt>:30004/resourceproviders/<Name>/<InstanceIdentifier>	HTTP/1.1

URI Parameters

None.

Request Headers

The following table describes required and optional request headers.

Request header	Description
Authorization: Bearer	Required. The authorization bearer token.
x-ms-principal-id	Required. The principal identifier.
x-ms-client-request-id	Optional. The client request identifier.
x-ms-client-session-id	Optional. The client session identifier.
x-ms-principal-liveid	Optional. The principal Live identifier.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 200 (OK).

For information about status codes, see Status and Error Codes (Windows Azure Pack Service Management).

Response Headers

The response for this operation includes standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Body

The following table describes the key elements of the response body:

Element name	Description
ResourceProvider	The retrieved resource provider. For more information, see ResourceProvider (Administrator object).

Example

The following code example shows a Get Resource Provider Instance request.

GET https://<computer>:30004/resourceproviders/monitoring/3E92E3A1-1FC1-4AB1-BAB1-6A556DE9BAE9 HTTP/1.1
Authorization: Bearer 
x-ms-client-request-id: a382fdb4-42f3-46fb-a9e7-83f26de17a0c-2013-07-09 23:37:29Z
x-ms-client-session-id: 78441bcf-1ac1-4216-82f0-81f21875567c
x-ms-principal-id: <computer>\Administrator
Accept-Language: en-US
x-ms-principal-liveid: <computer>\Administrator
Host: <computer>:30004
Content-Length: 0

The following code example shows a Get Resource Provider Instance response.

{
  "Name": "monitoring",
  "DisplayName": "Monitoring Service",
  "Description": null,
  "Enabled": true,
  "PassThroughEnabled": true,
  "AllowAnonymousAccess": true,
  "AllowMultipleInstances": false,
  "AdminEndpoint": {
    "ForwardingAddress": "https:\/\/computer:30020\/",
    "AuthenticationMode": 1,
    "AuthenticationUsername": "MonitoringClient",
    "AuthenticationPassword": null
  },
  "TenantEndpoint": {
    "ForwardingAddress": "https:\/\/computer:30020\/",
    "AuthenticationMode": 1,
    "AuthenticationUsername": "MonitoringClient",
    "AuthenticationPassword": null,
    "SourceUriTemplate": "{subid}\/services\/monitoring\/{*path}",
    "TargetUriTemplate": "{subid}\/{*path}"
  },
  "UsageEndpoint": null,
  "HealthCheckEndpoint": null,
  "NotificationEndpoint": null,
  "InstanceId": "3E92E3A1-1FC1-4AB1-BAB1-6A556DE9BAE9",
  "InstanceDisplayName": "Monitoring Service",
  "MaxQuotaUpdateBatchSize": 5,
  "SubscriptionStatusPollingInterval": "00:00:10",
  "Type": 0
}

Share via