Etablera en ny prenumeration (klientprenumeration)
Gäller för: Windows Azure Pack
Etablerar en ny prenumeration med den angivna informationen.
Förfrågan
Ersätt <ServiceMgmt> med din Service Management API-slutpunktsadress.
Metod |
URI för förfrågan |
HTTP-version |
---|---|---|
POST |
<https:// ServiceMgmt>:30005/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 |
---|---|
x-ms-principal-id: |
Krävs. Huvudidentifieraren. |
Auktorisering: Bärare |
Krävs. Token för auktoriseringsbärare. |
x-ms-client-request-id: |
Valfritt. Identifieraren för klientbegäran. |
x-ms-client-session-id: |
Valfritt. Klientsessionsidentifieraren. |
x-ms-principal-liveid: |
Valfritt. Huvudidentifieraren live. |
Begärandetext
I följande tabell beskrivs elementen i begärandetexten.
Elementnamn |
Beskrivning |
---|---|
AccountAdminLiveEmailId |
Kontoadministratörens Microsoft-kontoidentifierare. Krävs inte för prenumerationsetablering. Använd null. |
AccountAdminLivePuid |
Kontoadministratörens Passport-kontoidentifierare. Detta måste vara ett befintligt användarkonto. Du kan använda Hämta en användare för att avgöra om kontot finns. |
AccountId |
Kontoidentifieraren. Använd Guid.Empty. |
FriendlyName |
Det egna namnet på prenumerationen. |
OfferCategory |
Erbjudandekategorin. Använd null. |
OfferInfo |
Erbjudandeinformationen. Använd null. |
OfferType |
Erbjudandetypen. Använd 0. |
ReasonCode |
Orsakskoden. Använd null. |
ServiceAdminLiveEmailId |
Microsoft-kontoidentifieraren för tjänstadministratören. Det här värdet används inte av Windows Azure Pack och krävs endast i konsekvenssyfte. Använd null. |
ServiceAdminLivePuid |
Passport-kontoidentifieraren för tjänstadministratören. Krävs inte för prenumerationsetablering. Använd null. |
SubscriptionId |
Prenumerationsidentifieraren. Använd Guid.NewGuid(). ToString() för att skapa ett GUID. |
Status |
Prenumerationsstatus. Använd null. |
PlanId |
Planidentifieraren för planen som prenumereras på. |
CoAdminNames |
En lista över medadministratörer. Använd null om det inte finns några medadministratörer. Medadministratörerna behöver inte vara kända för systemet. När medadministratörskontot sedan skapas tillämpas prenumerationen automatiskt på medadministratören. |
Svarsåtgärder
Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext.
Statuskod
En lyckad åtgärd returnerar statuskoden 200 (OK). MaxSubscriptionsPerPlanReached returneras om det maximala antalet prenumerationer som kan tillåtas för planen nås.
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 |
De etablerade prenumerationerna. Mer information finns i Prenumeration (vanligt objekt). |
Exempel
I följande kodexempel visas en begäran om etableringsprenumeration .
POST https://<Computer>:30005/subscriptions HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: 02130fee-13b7-4b93-b618-3a8830dbe611-2014-04-15 20:00:55Z
x-ms-client-session-id: eec98428-7dd5-4033-8a2c-77946f61a2f6
x-ms-principal-id: NewUser%40contoso.com
Accept-Language: en-US
Content-Type: application/json; charset=utf-8
Host: <computer>:30005
Content-Length: 458
Expect: 100-continue
{
"AccountAdminLiveEmailId": null,
"AccountAdminLivePuid": "newuser@contoso.com",
"AccountId": "00000000-0000-0000-0000-000000000000",
"FriendlyName": "MyServicePlanX",
"OfferCategory": null,
"OfferInfo": null,
"OfferType": 0,
"ReasonCode": null,
"ServiceAdminLiveEmailId": null,
"ServiceAdminLivePuid": "newuser@contoso.com",
"SubscriptionId": "da506abb-1658-4abf-971c-e0e5a9c47b83",
"Status": null,
"PlanId": "MyServicePlanX18aa6bac",
"CoAdminNames": null
}
I följande kodexempel visas svarstexten För etableringsprenumeration .
{
"SubscriptionID": "da506abb-1658-4abf-971c-e0e5a9c47b83",
"SubscriptionName": "MyServicePlanX",
"AccountAdminLiveEmailId": "newuser@contoso.com",
"ServiceAdminLiveEmailId": null,
"CoAdminNames": [
],
"AddOnReferences": [
],
"AddOns": [
],
"State": 1,
"QuotaSyncState": 0,
"ActivationSyncState": 1,
"PlanId": "MyServicePlanX18aa6bac",
"Services": [
{
"Type": "mysqlservers",
"State": "registered",
"QuotaSyncState": 0,
"ActivationSyncState": 1,
"BaseQuotaSettings": [
{
"Key": "Editions",
"Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"offerEditionId\":\"040814101717\",\"groupType\":null}]"
}
]
}
],
"LastErrorMessage": null,
"Features": null,
"OfferFriendlyName": "MyServicePlanX",
"OfferCategory": null,
"Created": "2014-04-15T20:00:59.187"
}
Kommentarer
Hanteringsportalen för klientorganisationer gör följande REST-anrop när du etablerar en prenumeration.
Hämta tillgängliga planer. Detta används för att visa de planer som en användare kan prenumerera på. De planobjekt (administratörsobjekt) som returneras har en ID-egenskap . När en plan har valts används ID-värdet för att identifiera den valda planen i anropet till Etablera en ny prenumeration.
Hämta en användare. Eftersom det inte går att skapa en prenumeration för en användare som inte finns bekräftar det här anropet att en användare verkligen finns.
Etablera en ny prenumeration. Etablerar prenumerationen med den angivna informationen.