Provisionar uma nova assinatura (assinatura de locatário)
Aplica-se a: Windows Azure Pack
Provisiona uma nova assinatura com as informações especificadas.
Solicitação
Substitua <ServiceMgmt> pelo endereço do ponto de extremidade da API de Gerenciamento de Serviços.
Método |
URI da solicitação |
Versão HTTP |
---|---|---|
POST |
<https:// ServiceMgmt>:30005/subscriptions |
HTTP/1.1 |
Parâmetros de URI
Nenhum.
Cabeçalhos de solicitação
A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.
Cabeçalho da solicitação |
Descrição |
---|---|
x-ms-principal-id: |
Obrigatórios. O identificador principal. |
Autorização: Portador |
Obrigatórios. Token de portador de autorização. |
x-ms-client-request-id: |
Opcional. O identificador de solicitação do cliente. |
x-ms-client-session-id: |
Opcional. O identificador da sessão do cliente. |
x-ms-principal-liveid: |
Opcional. O identificador live principal. |
Corpo da solicitação
A tabela a seguir descreve os elementos do corpo da solicitação.
Nome do elemento |
Descrição |
---|---|
AccountAdminLiveEmailId |
O identificador de conta da Microsoft do administrador da conta. Não é necessário para provisionamento de assinatura. Use null. |
AccountAdminLivePuid |
O identificador da conta passport do administrador da conta. Deve ser uma conta de usuário existente. Você pode usar Recuperar um Usuário para determinar se a conta existe. |
AccountId |
O identificador da conta. Use Guid.Empty. |
FriendlyName |
O nome amigável da assinatura. |
OfferCategory |
A categoria de oferta. Use null. |
OfferInfo |
As informações da oferta. Use null. |
OfferType |
O tipo de oferta. Use 0. |
ReasonCode |
O código de motivo. Use null. |
ServiceAdminLiveEmailId |
O identificador de conta da Microsoft do administrador do serviço. Esse valor não é usado pelo Windows Azure Pack e é necessário apenas para fins de consistência. Use null. |
ServiceAdminLivePuid |
O identificador da conta passport do administrador do serviço. Não é necessário para provisionamento de assinatura. Use null. |
SubscriptionId |
O Identificador de assinatura. Use Guid.NewGuid(). ToString() para criar um GUID. |
Status |
O status da assinatura. Use null. |
PlanId |
O identificador de plano ao qual o plano está sendo assinado. |
CoAdminNames |
Uma lista de coadministradores. Use null se não existirem coadministradores. Os coadministradores não precisam ser conhecidos pelo sistema. Quando a conta de coadministrador é criada posteriormente, a assinatura é aplicada automaticamente ao coadministrador. |
Resposta
A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.
Código de status
Uma operação bem-sucedida retorna o código de status 200 (OK). MaxSubscriptionsPerPlanReached será retornado se o número máximo de assinaturas permitido para o plano for atingido.
Para obter informações sobre códigos de status, consulte Status e Códigos de Erro (Windows Gerenciamento de Serviço do Azure Pack).
Cabeçalhos de resposta
A resposta para essa operação inclui cabeçalhos HTTP padrão. Todos os cabeçalhos padrão estão em conformidade com a especificação de protocolo HTTP/1.1.
Corpo da resposta
A tabela a seguir descreve os principais elementos do corpo da resposta:
Nome do elemento |
Descrição |
---|---|
Subscription |
As assinaturas provisionadas. Para obter mais informações, consulte Assinatura (objeto Comum). |
Exemplo
O exemplo de código a seguir mostra uma solicitação de Assinatura de Provisionamento .
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
}
O exemplo de código a seguir mostra um corpo de resposta da Assinatura de Provisionamento .
{
"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"
}
Comentários
O portal de gerenciamento para locatários faz as seguintes chamadas REST ao provisionar uma assinatura.
Recupere os Planos Disponíveis. Isso é usado para exibir os planos aos quais um usuário pode assinar. Os objetos Plan (objeto Administrator) retornados cada um tem uma propriedade de ID . Depois que um plano é escolhido, o valor da ID é usado para identificar o plano escolhido na chamada para Provisionar uma Nova Assinatura.
Recuperar um usuário. Como uma assinatura não pode ser criada para um usuário que não existe, essa chamada confirma que um usuário realmente existe.
Provisionar uma nova assinatura. Provisiona a assinatura usando as informações fornecidas.