Billing Subscriptions - Get

Referencia

Service:: Billing

API Version:: 2021-10-01

Obtiene una suscripción por su identificador. Actualmente, la operación se admite para las cuentas de facturación con tipo de contrato Contrato de cliente de Microsoft, Microsoft Partner Agreement y el Programa microsoft Online Services.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
billingAccountName	path	True	string	Identificador que identifica de forma única una cuenta de facturación.
billingSubscriptionName	path	True	string	Identificador que identifica de forma única una suscripción.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2021-10-01.

Respuestas

Nombre	Tipo	Description
200 OK	BillingSubscription	Aceptar. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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"
  }
}

Definiciones

Nombre	Description
Amount	Cantidad.
AutoRenew	Indica si la renovación automática está activada o desactivada para una suscripción.
BillingSubscription	Una suscripción de facturación.
BillingSubscriptionStatus	Estado de la suscripción. Este campo no está disponible para Enterprise Agreement cuentas de facturación.
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
ErrorSubDetails	Los subdelementos del error.
NextBillingCycleDetails	Los detalles del siguiente ciclo de facturación de la suscripción.
RenewalTermDetails	Detalles del término de la suscripción en renovación.
Reseller	Detalles del revendedor.
SubscriptionEnrollmentAccountStatus	Estado de la cuenta de inscripción actual de la suscripción. Este campo solo está disponible para las cuentas de facturación de Enterprise Agreement.

Amount

Cantidad.

Nombre	Tipo	Description
currency	string	Moneda del valor de importe.
value	number	Valor de la cantidad.

AutoRenew

Indica si la renovación automática está activada o desactivada para una suscripción.

Nombre	Tipo	Description
Off	string
On	string

BillingSubscription

Una suscripción de facturación.

Nombre	Tipo	Description
id	string	Id. de recurso.
name	string	Nombre del recurso.
properties.autoRenew	AutoRenew	Indica si la renovación automática está activada o desactivada para una suscripción.
properties.beneficiaryTenantId	string	El inquilino de aprovisionamiento de la suscripción.
properties.billingFrequency	string	Frecuencia de facturación de la suscripción en formato ISO8601. Ejemplo: P1M, P3M, P1Y
properties.billingPolicies	object	Diccionario de directivas de facturación asociadas a la suscripción.
properties.billingProfileDisplayName	string	Nombre para mostrar del perfil de facturación al que se factura la suscripción. Este campo solo es aplicable a Contrato de cliente de Microsoft cuentas de facturación.
properties.billingProfileId	string	Identificador del perfil de facturación al que se factura la suscripción. Este campo solo es aplicable a Contrato de cliente de Microsoft cuentas de facturación.
properties.billingProfileName	string	Nombre del perfil de facturación al que se factura la suscripción. Este campo solo es aplicable a Contrato de cliente de Microsoft cuentas de facturación.
properties.consumptionCostCenter	string	Centro de costos aplicado a la suscripción. Este campo solo está disponible para las suscripciones de consumo de Contrato de cliente de Microsoft Tipo de cuentas de facturación.
properties.customerDisplayName	string	Nombre del cliente para el que se creó la suscripción. El campo solo es aplicable a las cuentas de facturación de Microsoft Partner Agreement.
properties.customerId	string	Identificador del cliente para el que se creó la suscripción. El campo solo es aplicable a las cuentas de facturación de Microsoft Partner Agreement.
properties.customerName	string	Nombre del cliente para el que se creó la suscripción. El campo solo es aplicable a las cuentas de facturación de Microsoft Partner Agreement.
properties.displayName	string	Nombre de la suscripción.
properties.enrollmentAccountDisplayName	string	El nombre de la cuenta de inscripción asociado a la suscripción. Este campo solo está disponible para las cuentas de facturación de Enterprise Agreement.
properties.enrollmentAccountId	string	Identificador de cuenta de inscripción asociado a la suscripción. Este campo solo está disponible para las cuentas de facturación de Enterprise Agreement.
properties.enrollmentAccountSubscriptionDetails.enrollmentAccountStartDate	string	La cuenta de inscripción y la fecha de inicio de la asociación de suscripción. Este campo solo está disponible para las cuentas de facturación de Enterprise Agreement.
properties.enrollmentAccountSubscriptionDetails.subscriptionEnrollmentAccountStatus	SubscriptionEnrollmentAccountStatus	Estado de la cuenta de inscripción actual de la suscripción. Este campo solo está disponible para las cuentas de facturación de Enterprise Agreement.
properties.invoiceSectionDisplayName	string	Nombre para mostrar de la sección de factura a la que se factura la suscripción. El campo solo es aplicable a las cuentas de facturación de Microsoft Partner Agreement.
properties.invoiceSectionId	string	Identificador de la sección de factura a la que se factura la suscripción. El campo solo es aplicable a las cuentas de facturación de Microsoft Partner Agreement.
properties.invoiceSectionName	string	Nombre de la sección de factura a la que se factura la suscripción. El campo solo es aplicable a las cuentas de facturación de Microsoft Partner Agreement.
properties.lastMonthCharges	Amount	Los cargos del último mes. Este campo solo está disponible para las suscripciones basadas en el uso de Contrato de cliente de Microsoft cuentas de facturación.
properties.monthToDateCharges	Amount	Los cargos del mes actual hasta la fecha. Este campo solo está disponible para las suscripciones basadas en el uso de Contrato de cliente de Microsoft cuentas de facturación.
properties.nextBillingCycleDetails	NextBillingCycleDetails	Detalles del ciclo de facturación siguiente de la suscripción.
properties.offerId	string	Identificador de la oferta de la suscripción. Este campo solo está disponible para las cuentas de facturación del Programa microsoft Online Services.
properties.productCategory	string	Categoría del producto para el que se adquiere la suscripción. Entre los valores posibles se incluyen: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other
properties.productType	string	Tipo del producto para el que se compra la suscripción.
properties.productTypeId	string	El identificador del producto para el que se adquiere la suscripción.
properties.purchaseDate	string	Fecha de compra de la suscripción en hora UTC.
properties.quantity	integer	Número de licencias adquiridas para la suscripción
properties.renewalTermDetails	RenewalTermDetails	Detalles del término de la suscripción en la siguiente renovación.
properties.reseller	Reseller	Revendedor para el que se crea la suscripción. El campo está disponible para las cuentas de facturación de Microsoft Partner Agreement.
properties.skuDescription	string	Descripción de la SKU del producto para el que se adquiere la suscripción. Este campo solo está disponible para Contrato de cliente de Microsoft cuentas de facturación.
properties.skuId	string	Identificador de SKU del producto para el que se adquiere la suscripción. Este campo solo está disponible para Contrato de cliente de Microsoft cuentas de facturación.
properties.status	BillingSubscriptionStatus	Estado de la suscripción. Este campo no está disponible para Enterprise Agreement cuentas de facturación.
properties.subscriptionId	string	Identificador de la suscripción basada en el uso. Este campo solo está disponible para las suscripciones basadas en el uso de Contrato de cliente de Microsoft cuentas de facturación.
properties.suspensionReasons	string[]	Motivo de suspensión de la suscripción. Este campo no está disponible para Enterprise Agreement cuentas de facturación.
properties.termDuration	string	Duración para la que puede usar la suscripción. Ejemplo P1Y y P1M
properties.termEndDate	string	Fecha de finalización del término en hora UTC.
properties.termStartDate	string	Fecha de inicio del término en hora UTC.
type	string	Tipo de recurso.

BillingSubscriptionStatus

Estado de la suscripción. Este campo no está disponible para Enterprise Agreement cuentas de facturación.

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

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
details	ErrorSubDetails[]	Los subdelementos del error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.
target	string	Destino del error concreto.

ErrorResponse

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

ErrorSubDetails

Los subdelementos del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.
target	string	Destino del error concreto.

NextBillingCycleDetails

Los detalles del siguiente ciclo de facturación de la suscripción.

Nombre	Tipo	Description
billingFrequency	string	Frecuencia de facturación de la suscripción en el siguiente ciclo de facturación.

RenewalTermDetails

Detalles del término de la suscripción en renovación.

Nombre	Tipo	Description
billingFrequency	string	Frecuencia de facturación de la suscripción.
productTypeId	string	Identificador del producto.
quantity	integer	Número de licencias
skuId	string	Identificador de SKU del producto
termDuration	string	Duración del período de la suscripción. P1M de ejemplo y P1Y

Reseller

Detalles del revendedor.

Nombre	Tipo	Description
description	string	Nombre del revendedor.
resellerId	string	Identificador de MPN del revendedor.

SubscriptionEnrollmentAccountStatus

Estado de la cuenta de inscripción actual de la suscripción. Este campo solo está disponible para las cuentas de facturación de Enterprise Agreement.

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

Share via

Billing Subscriptions - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

BillingSubscription

Sample Request

Sample Response

Definiciones

Amount

AutoRenew

BillingSubscription

BillingSubscriptionStatus

ErrorDetails

ErrorResponse

ErrorSubDetails

NextBillingCycleDetails

RenewalTermDetails

Reseller

SubscriptionEnrollmentAccountStatus

Recursos adicionales