Skapa en prenumeration för ett meddelande
Gäller för: Windows Azure Pack
Används av Service Management-API:et för att meddela resursprovidern att en prenumeration på en plan skapas. Det angivna prenumerationsobjektet innehåller information som kan användas av resursprovidern för att internt bearbeta den nya prenumerationen.
Förfrågan
Ersätt <NotificationEndpoint> med slutpunktsadressen för rest-API:et Windows Azure Pack Custom Resource Provider Notification.
Metod |
URI för förfrågan |
HTTP-version |
---|---|---|
POST |
<http:// NotificationEndpoint>/subscriptions |
HTTP/1.1 |
URI-parametrar
Inga.
Rubriker för begäran
I följande tabell beskrivs obligatoriska och valfria begärandehuvuden.
Begärandehuvud |
Beskrivning |
---|---|
Auktorisering: Grundläggande |
Krävs. Den grundläggande auktoriseringstoken. |
x-ms-principal-id |
Krävs. Huvudidentifieraren. |
x-ms-client-request-id |
Valfritt. Identifierare för klientbegäran. |
x-ms-client-session-id |
Valfritt. Klientsessionsidentifieraren. |
x-ms-principal-liveid |
Valfritt. Live-huvudidentifieraren. |
Begärandetext
I följande tabell beskrivs elementen i begärandetexten.
Elementnamn |
Beskrivning |
---|---|
Prenumeration |
Prenumerationen som ska skapas. Mer information finns i Prenumeration (meddelandeslutpunktsobjekt). |
Svarsåtgärder
Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext.
Statuskod
Returnera statuskod 201 (skapad) om resursproviderns interna prenumeration har skapats. Statuskod 202 (godkänd) kan returneras om åtgärden körs asynkront.
Information om statuskoder finns i Status- och felkoder (Windows Azure Pack Service Management).
Svarsrubriker
Svaret för den här åtgärden innehåller HTTP-standardhuvuden. Alla standardhuvuden överensstämmer med http/1.1-protokollspecifikationen.
Svarstext
I följande tabell beskrivs de viktigaste elementen i svarstexten:
Elementnamn |
Beskrivning |
---|---|
Prenumeration |
Den nya prenumerationen. Mer information finns i Prenumeration (meddelandeslutpunktsobjekt). |
Exempel
I följande kodexempel visas en begäran om att skapa prenumeration .
POST https://<NotificationEndpoint>/subscriptions HTTP/1.1
Referer: https://<Computer>:30004/subscriptions
Accept-Language: en-US
x-ms-client-request-id: 4abcdb02-cf03-4b07-a1e1-d43c4fe06a8b-2013-07-25 06:09:39Z
x-ms-client-session-id: be02e255-38de-4e86-9690-b3a3e3037e4c
x-ms-principal-id: <COMPUTER>\Administrator
x-ms-principal-liveid: <COMPUTER>\Administrator
x-ms-request-id: 60668356a6204f269a455cc3f3901a84.2013-07-25T06:09:42.8465532Z
Authorization: Basic <encoded username and password>
Content-Type: application/json; charset=utf-8
Host: <Computer>:30010
Content-Length: 438
Expect: 100-continue
{
"SubscriptionId": "685a05ed-3a6f-4c3a-b70c-924a1307834f",
"SubscriptionName": "Hosting Plan One",
"State": 0,
"LifecycleState": 0,
"LastErrorMessage": null,
"QuotaSettings": [
{
"Key": "Editions",
"Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"resourceSizeLimit\":\"1024\",\"offerEditionId\":\"070913050037\",\"groupType\":null}]"
}
],
"AdminId": "egghead@contoso.com",
"CoAdminIds": [
]
}
I följande kodexempel visas ett JSON-svar för Skapa prenumeration .
{
"SubscriptionId": "685a05ed-3a6f-4c3a-b70c-924a1307834f",
"SubscriptionName": "Hosting Plan One",
"State": 0,
"LifecycleState": 0,
"LastErrorMessage": null,
"QuotaSettings": [
{
"Key": "Editions",
"Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"resourceSizeLimit\":\"1024\",\"offerEditionId\":\"070913050037\",\"groupType\":null}]"
}
],
"AdminId": "egghead@contoso.com",
"CoAdminIds": [
]
}
Kommentarer
När du anropar TBD väntar Service Management-API:et en minut på ett svar. Om inget svar tas emot markeras prenumerationen som osynkroniserad.
Asynkrona åtgärder stöds. Om skapandeåtgärden tar mer än en minut att slutföra kan resursprovidern returnera 202 (godkänd) och ange sin interna representation av Prenumeration (Meddelandeslutpunktsobjekt). LifecycleState till Provisioning. När resursprovidern har slutfört skapandeåtgärden ska den ange sin representation av Prenumeration (meddelandeslutpunktsobjekt). LifecycleState till Etablerad . Service Management-API:et kontrollerar prenumerationen (meddelandeslutpunktsobjektet). LifecycleState för slutförande av åtgärden var 10:e sekund med TBD.
Se även
Windows REST API-referens för meddelanden för anpassad resursprovider i Azure Pack