Een nieuw abonnement inrichten (tenantabonnement)
Van toepassing op: Windows Azure Pack
Richt een nieuw abonnement in met de opgegeven informatie.
Aanvraag
Vervang <ServiceMgmt> door het eindpuntadres van uw Service Management-API.
Methode |
Aanvraag-URI |
HTTP-versie |
---|---|---|
POST |
<https:// ServiceMgmt>:30005/subscriptions |
HTTP/1.1 |
URI-parameters
Geen.
Aanvraagheaders
In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.
Aanvraagheader |
Beschrijving |
---|---|
x-ms-principal-id: |
Vereist. De principal-id. |
Autorisatie: Bearer |
Vereist. Bearer-token voor autorisatie. |
x-ms-client-request-id: |
Optioneel. De clientaanvraag-id. |
x-ms-client-session-id: |
Optioneel. De clientsessie-id. |
x-ms-principal-liveid: |
Optioneel. De principal Live-id. |
Aanvraagbody
In de volgende tabel worden de elementen van de aanvraagbody beschreven.
Naam van element |
Description |
---|---|
AccountAdminLiveEmailId |
De Microsoft-account-id van de accountbeheerder. Niet vereist voor het inrichten van abonnementen. Gebruik null. |
AccountAdminLivePuid |
De passport-account-id van de accountbeheerder. Dit moet een bestaand gebruikersaccount zijn. U kunt Een gebruiker ophalen gebruiken om te bepalen of het account bestaat. |
AccountId |
De account-id. Gebruik Guid.Empty. |
FriendlyName |
De beschrijvende naam voor het abonnement. |
OfferCategory |
De aanbiedingscategorie. Gebruik null. |
OfferInfo |
De aanbiedingsgegevens. Gebruik null. |
OfferType |
Het type aanbieding. Gebruik 0. |
ReasonCode |
De redencode. Gebruik null. |
ServiceAdminLiveEmailId |
De Microsoft-account-id van de servicebeheerder. Deze waarde wordt niet gebruikt door Windows Azure Pack en is alleen vereist voor consistentiedoeleinden. Gebruik null. |
ServiceAdminLivePuid |
De Passport-account-id van de servicebeheerder. Niet vereist voor het inrichten van abonnementen. Gebruik null. |
SubscriptionId |
De abonnements-id. Gebruik Guid.NewGuid(). ToString() om een GUID te maken. |
Status |
De abonnementsstatus. Gebruik null. |
PlanId |
De plan-id van het abonnement waarop wordt geabonneerd. |
CoAdminNames |
Een lijst met medebeheerders. Gebruik null als er geen co-beheerders bestaan. De medebeheerders hoeven niet bekend te zijn bij het systeem. Wanneer het co-beheerdersaccount vervolgens wordt gemaakt, wordt het abonnement automatisch toegepast op de medebeheerder. |
Antwoord
Het antwoord bevat een HTTP-statuscode, een set antwoordheaders en een antwoordtekst.
Statuscode
Een geslaagde bewerking retourneert statuscode 200 (OK). MaxSubscriptionsPerPlanReached wordt geretourneerd als het maximum aantal abonnementen dat is toegestaan voor het plan wordt bereikt.
Zie Status- en Foutcodes (Windows Azure Pack Service Management) voor informatie over statuscodes.
Antwoordheaders
Het antwoord voor deze bewerking bevat standaard HTTP-headers. Alle standaardheaders voldoen aan de http/1.1-protocolspecificatie.
Hoofdtekst van antwoord
In de volgende tabel worden de belangrijkste elementen van de hoofdtekst van het antwoord beschreven:
Elementnaam |
Beschrijving |
---|---|
Abonnement |
De ingerichte abonnementen. Zie Abonnement (gemeenschappelijk object) voor meer informatie. |
Voorbeeld
In het volgende codevoorbeeld ziet u een abonnementsaanvraag inrichten .
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
}
In het volgende codevoorbeeld ziet u de antwoordtekst Abonnement inrichten .
{
"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"
}
Opmerkingen
De beheerportal voor tenants voert de volgende REST-aanroepen uit bij het inrichten van een abonnement.
Haal de beschikbare abonnementen op. Dit wordt gebruikt voor het weergeven van de abonnementen waarop een gebruiker zich kan abonneren. De planobjecten (administratorobjecten) die elk worden geretourneerd, hebben een id-eigenschap . Zodra een plan is gekozen, wordt de id-waarde gebruikt om het gekozen plan te identificeren in de aanroep om een nieuw abonnement in te richten.
Een gebruiker ophalen. Aangezien een abonnement niet kan worden gemaakt voor een gebruiker die niet bestaat, bevestigt deze aanroep dat er inderdaad een gebruiker bestaat.
Richt een nieuw abonnement in. Richt het abonnement in met behulp van de opgegeven informatie.