Billing Subscriptions - Get

Referência

Service:: Billing

API Version:: 2021-10-01

Obtém uma assinatura por sua ID. Atualmente, há suporte para a operação para contas de cobrança com o tipo de contrato Contrato de Cliente da Microsoft, Contrato de Parceiro da Microsoft e o Programa de Serviços Online da Microsoft.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}?api-version=2021-10-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
billingAccountName	path	True	string	A ID que identifica exclusivamente uma conta de cobrança.
billingSubscriptionName	path	True	string	A ID que identifica exclusivamente uma assinatura.
api-version	query	True	string	A versão da API a ser usada com a solicitação do cliente. A versão atual é 2021-10-01.

Respostas

Nome	Tipo	Description
200 OK	BillingSubscription	OK. A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

BillingSubscription

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/418b0e9c-5dc3-4260-918f-30b90619fe07?api-version=2021-10-01

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Billing;
using Azure.ResourceManager.Billing.Models;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2021-10-01/examples/BillingSubscription.json
// this example is just showing the usage of "BillingSubscriptions_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingSubscriptionResource created on azure
// for more information of creating BillingSubscriptionResource, please refer to the document of BillingSubscriptionResource
string billingAccountName = "{billingAccountName}";
string billingSubscriptionName = "418b0e9c-5dc3-4260-918f-30b90619fe07";
ResourceIdentifier billingSubscriptionResourceId = BillingSubscriptionResource.CreateResourceIdentifier(billingAccountName, billingSubscriptionName);
BillingSubscriptionResource billingSubscription = client.GetBillingSubscriptionResource(billingSubscriptionResourceId);

// invoke the operation
BillingSubscriptionResource result = await billingSubscription.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BillingSubscriptionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/418b0e9c-5dc3-4260-918f-30b90619fe07",
  "name": "418b0e9c-5dc3-4260-918f-30b90619fe07",
  "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
  "properties": {
    "autoRenew": "Off",
    "billingFrequency": "P1M",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/2b72f936-0166-47d6-91a3-ef9f84f36664",
    "billingProfileDisplayName": "Contoso operations billing profile",
    "billingProfileName": "2b72f936-0166-47d6-91a3-ef9f84f36664",
    "displayName": "Subscription 1",
    "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/2b72f936-0166-47d6-91a3-ef9f84f36664/invoiceSections/5c562559-e31b-4bfe-b608-f8b5b3fbd073",
    "invoiceSectionDisplayName": "Contoso operations invoice section",
    "invoiceSectionName": "5c562559-e31b-4bfe-b608-f8b5b3fbd073",
    "lastMonthCharges": {
      "currency": "USD",
      "value": 5000
    },
    "monthToDateCharges": {
      "currency": "USD",
      "value": 600
    },
    "productCategory": "UsageBased",
    "productType": "Usage based",
    "productTypeId": "DZH318Z0BPS6",
    "purchaseDate": "2021-10-01T00:00:00Z",
    "quantity": 1,
    "skuId": "0001",
    "skuDescription": "Microsoft Azure Plan",
    "status": "Active",
    "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3"
  }
}

Definições

Nome	Description
Amount	O valor.
AutoRenew	Indica se a renovação automática está ativada ou desativada para uma assinatura.
BillingSubscription	Uma assinatura de cobrança.
BillingSubscriptionStatus	O status da assinatura. Esse campo não está disponível para contas de cobrança Enterprise Agreement.
ErrorDetails	Os detalhes do erro.
ErrorResponse	A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
ErrorSubDetails	Os sub-detalhes do erro.
NextBillingCycleDetails	O próximo ciclo de cobrança detalhes da assinatura.
RenewalTermDetails	Os detalhes do termo da assinatura na renovação.
Reseller	Detalhes do revendedor.
SubscriptionEnrollmentAccountStatus	A conta de registro atual status da assinatura. Esse campo está disponível apenas para as contas de cobrança do Enterprise Agreement.

Amount

O valor.

Nome	Tipo	Description
currency	string	A moeda do valor do valor.
value	number	Valor da quantidade.

AutoRenew

Indica se a renovação automática está ativada ou desativada para uma assinatura.

Nome	Tipo	Description
Off	string
On	string

BillingSubscription

Uma assinatura de cobrança.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.autoRenew	AutoRenew	Indica se a renovação automática está ativada ou desativada para uma assinatura.
properties.beneficiaryTenantId	string	O locatário de provisionamento da assinatura.
properties.billingFrequency	string	A frequência de cobrança da assinatura no formato ISO8601. Exemplo: P1M, P3M, P1Y
properties.billingPolicies	object	Dicionário de políticas de cobrança associadas à assinatura.
properties.billingProfileDisplayName	string	O nome de exibição do perfil de cobrança ao qual a assinatura é cobrada. Esse campo só é aplicável para contas de cobrança Contrato de Cliente da Microsoft.
properties.billingProfileId	string	A ID do perfil de cobrança ao qual a assinatura é cobrada. Esse campo só é aplicável para contas de cobrança Contrato de Cliente da Microsoft.
properties.billingProfileName	string	O nome do perfil de cobrança ao qual a assinatura é cobrada. Esse campo só é aplicável para contas de cobrança Contrato de Cliente da Microsoft.
properties.consumptionCostCenter	string	O centro de custo aplicado à assinatura. Esse campo só está disponível para assinaturas de consumo de contas de cobrança do tipo Contrato de Cliente da Microsoft.
properties.customerDisplayName	string	O nome do cliente para o qual a assinatura foi criada. O campo é aplicável somente para contas de cobrança Contrato de Parceiro da Microsoft.
properties.customerId	string	A ID do cliente para o qual a assinatura foi criada. O campo é aplicável somente para contas de cobrança Contrato de Parceiro da Microsoft.
properties.customerName	string	O nome do cliente para o qual a assinatura foi criada. O campo é aplicável somente para contas de cobrança Contrato de Parceiro da Microsoft.
properties.displayName	string	O nome da assinatura.
properties.enrollmentAccountDisplayName	string	O nome da conta de registro associado à assinatura. Esse campo está disponível apenas para as contas de cobrança do Enterprise Agreement.
properties.enrollmentAccountId	string	A ID da Conta de registro associada à assinatura. Esse campo está disponível apenas para as contas de cobrança do Enterprise Agreement.
properties.enrollmentAccountSubscriptionDetails.enrollmentAccountStartDate	string	A conta de registro e a data de início da associação da assinatura. Esse campo está disponível apenas para as contas de cobrança do Enterprise Agreement.
properties.enrollmentAccountSubscriptionDetails.subscriptionEnrollmentAccountStatus	SubscriptionEnrollmentAccountStatus	A conta de registro atual status da assinatura. Esse campo está disponível apenas para as contas de cobrança do Enterprise Agreement.
properties.invoiceSectionDisplayName	string	O nome de exibição da seção da fatura à qual a assinatura é cobrada. O campo é aplicável somente para contas de cobrança Contrato de Parceiro da Microsoft.
properties.invoiceSectionId	string	A ID da seção da fatura à qual a assinatura é cobrada. O campo é aplicável somente para contas de cobrança Contrato de Parceiro da Microsoft.
properties.invoiceSectionName	string	O nome da seção da fatura à qual a assinatura é cobrada. O campo é aplicável somente para contas de cobrança Contrato de Parceiro da Microsoft.
properties.lastMonthCharges	Amount	As acusações do mês passado. Esse campo só está disponível para assinaturas baseadas em uso de contas de cobrança Contrato de Cliente da Microsoft.
properties.monthToDateCharges	Amount	Os encargos atuais do mês até o momento. Esse campo só está disponível para assinaturas baseadas em uso de contas de cobrança Contrato de Cliente da Microsoft.
properties.nextBillingCycleDetails	NextBillingCycleDetails	Em seguida, ciclo de cobrança detalhes da assinatura.
properties.offerId	string	A ID da oferta para a assinatura. Esse campo só está disponível para as contas de cobrança do Programa Microsoft Online Services.
properties.productCategory	string	A categoria do produto para o qual a assinatura é comprada. Os valores possíveis incluem: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other
properties.productType	string	O tipo do produto para o qual a assinatura é comprada
properties.productTypeId	string	A ID do produto para o qual a assinatura é comprada
properties.purchaseDate	string	A data de compra da assinatura no horário UTC.
properties.quantity	integer	O número de licenças compradas para a assinatura
properties.renewalTermDetails	RenewalTermDetails	Os detalhes do termo da assinatura na próxima renovação.
properties.reseller	Reseller	O revendedor para o qual a assinatura é criada. O campo está disponível para Contrato de Parceiro da Microsoft contas de cobrança.
properties.skuDescription	string	A descrição da SKU do produto para o qual a assinatura é comprada. Esse campo só está disponível para contas de cobrança Contrato de Cliente da Microsoft.
properties.skuId	string	A ID de SKU do produto para o qual a assinatura é comprada. Esse campo só está disponível para contas de cobrança Contrato de Cliente da Microsoft.
properties.status	BillingSubscriptionStatus	O status da assinatura. Esse campo não está disponível para contas de cobrança Enterprise Agreement.
properties.subscriptionId	string	A ID da assinatura baseada em uso. Esse campo só está disponível para assinaturas baseadas em uso de contas de cobrança Contrato de Cliente da Microsoft.
properties.suspensionReasons	string[]	O motivo da suspensão da assinatura. Esse campo não está disponível para contas de cobrança Enterprise Agreement.
properties.termDuration	string	A duração para a qual você pode usar a assinatura. Exemplo de P1Y e P1M
properties.termEndDate	string	A data de término do termo no horário UTC.
properties.termStartDate	string	A data de início do termo no horário UTC.
type	string	Tipo de recurso.

BillingSubscriptionStatus

O status da assinatura. Esse campo não está disponível para contas de cobrança Enterprise Agreement.

Nome	Tipo	Description
Active	string
AutoRenew	string
Cancelled	string
Deleted	string
Disabled	string
Expired	string
Expiring	string
Suspended	string
Unknown	string
Warned	string

ErrorDetails

Os detalhes do erro.

Nome	Tipo	Description
code	string	Código do erro.
details	ErrorSubDetails[]	Os sub-detalhes do erro.
message	string	Mensagem de erro indicando por que a operação falhou.
target	string	O destino do erro específico.

ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Nome	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

ErrorSubDetails

Os sub-detalhes do erro.

Nome	Tipo	Description
code	string	Código do erro.
message	string	Mensagem de erro indicando por que a operação falhou.
target	string	O destino do erro específico.

NextBillingCycleDetails

O próximo ciclo de cobrança detalhes da assinatura.

Nome	Tipo	Description
billingFrequency	string	A frequência de cobrança da assinatura no próximo ciclo de cobrança.

RenewalTermDetails

Os detalhes do termo da assinatura na renovação.

Nome	Tipo	Description
billingFrequency	string	A frequência de cobrança da assinatura.
productTypeId	string	A ID do produto.
quantity	integer	O número de licenças
skuId	string	A ID de SKU do produto
termDuration	string	A duração do termo da assinatura. Exemplo de P1M e P1Y

Reseller

Detalhes do revendedor.

Nome	Tipo	Description
description	string	O nome do revendedor.
resellerId	string	A ID do MPN do revendedor.

SubscriptionEnrollmentAccountStatus

A conta de registro atual status da assinatura. Esse campo está disponível apenas para as contas de cobrança do Enterprise Agreement.

Nome	Tipo	Description
Active	string
Cancelled	string
Deleted	string
Expired	string
TransferredOut	string
Transferring	string

Billing Subscriptions - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

BillingSubscription

Sample Request

Sample Response

Definições

Amount

AutoRenew

BillingSubscription

BillingSubscriptionStatus

ErrorDetails

ErrorResponse

ErrorSubDetails

NextBillingCycleDetails

RenewalTermDetails

Reseller

SubscriptionEnrollmentAccountStatus

Recursos adicionais