Billing Subscriptions - List By Billing Profile

Referencia

Service:: Billing

API Version:: 2020-05-01

Enumera las suscripciones que se facturan a un perfil de facturación. La operación se admite para las cuentas de facturación con tipo de contrato Contrato de cliente de Microsoft o Microsoft Partner Agreement.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions?api-version=2020-05-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.
billingProfileName	path	True	string	Identificador que identifica de forma única un perfil de facturació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 2020-05-01.

Respuestas

Nombre	Tipo	Description
200 OK	BillingSubscriptionsListResult	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

BillingSubscriptionsListByBillingProfile

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions?api-version=2020-05-01

/** Samples for BillingSubscriptions ListByBillingProfile. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json
     */
    /**
     * Sample code: BillingSubscriptionsListByBillingProfile.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingSubscriptionsListByBillingProfile(
        com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .billingSubscriptions()
            .listByBillingProfile("{billingAccountName}", "{billingProfileName}", com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python billing_subscriptions_list_by_billing_profile.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.billing_subscriptions.list_by_billing_profile(
        billing_account_name="{billingAccountName}",
        billing_profile_name="{billingProfileName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json
if __name__ == "__main__":
    main()

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

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json
func ExampleSubscriptionsClient_NewListByBillingProfilePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSubscriptionsClient().NewListByBillingProfilePager("{billingAccountName}", "{billingProfileName}", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SubscriptionsListResult = armbilling.SubscriptionsListResult{
		// 	Value: []*armbilling.Subscription{
		// 		{
		// 			Name: to.Ptr("billingSubscriptionId1"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1"),
		// 			Properties: &armbilling.SubscriptionProperties{
		// 				BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 				CostCenter: to.Ptr("ABC1234"),
		// 				DisplayName: to.Ptr("My subscription"),
		// 				InvoiceSectionDisplayName: to.Ptr("Contoso operations invoiceSection"),
		// 				InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000"),
		// 				LastMonthCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](5000),
		// 				},
		// 				MonthToDateCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](600),
		// 				},
		// 				SKUDescription: to.Ptr("Microsoft Azure Plan"),
		// 				SKUID: to.Ptr("0001"),
		// 				SubscriptionBillingStatus: to.Ptr(armbilling.BillingSubscriptionStatusTypeActive),
		// 				SubscriptionID: to.Ptr("6b96d3f2-9008-4a9d-912f-f87744185aa3"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("billingSubscriptionId2"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2"),
		// 			Properties: &armbilling.SubscriptionProperties{
		// 				BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 				CostCenter: to.Ptr("ABC1234"),
		// 				DisplayName: to.Ptr("Test subscription"),
		// 				InvoiceSectionDisplayName: to.Ptr("Contoso operations invoiceSection"),
		// 				InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000"),
		// 				LastMonthCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](1000),
		// 				},
		// 				MonthToDateCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](400),
		// 				},
		// 				SKUDescription: to.Ptr("Microsoft Azure Plan"),
		// 				SKUID: to.Ptr("0001"),
		// 				SubscriptionBillingStatus: to.Ptr(armbilling.BillingSubscriptionStatusTypeActive),
		// 				SubscriptionID: to.Ptr("6b96d3f2-9008-4a9d-912f-6b96d3f2"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("billingSubscriptionId3"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId3"),
		// 			Properties: &armbilling.SubscriptionProperties{
		// 				BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}"),
		// 				CostCenter: to.Ptr("ABC1234"),
		// 				DisplayName: to.Ptr("Dev Subscription"),
		// 				InvoiceSectionDisplayName: to.Ptr("Contoso operations invoiceSection"),
		// 				InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000"),
		// 				LastMonthCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](6000),
		// 				},
		// 				MonthToDateCharges: &armbilling.Amount{
		// 					Currency: to.Ptr("USD"),
		// 					Value: to.Ptr[float32](900),
		// 				},
		// 				SKUDescription: to.Ptr("Microsoft Azure Plan"),
		// 				SKUID: to.Ptr("0001"),
		// 				SubscriptionBillingStatus: to.Ptr(armbilling.BillingSubscriptionStatusTypeActive),
		// 				SubscriptionID: to.Ptr("6b96d3f2-4a9d-9008-912f-f87744185aa3"),
		// 			},
		// 	}},
		// }
	}
}

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

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
 *
 * @summary Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json
 */
async function billingSubscriptionsListByBillingProfile() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const billingProfileName = "{billingProfileName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.billingSubscriptions.listByBillingProfile(
    billingAccountName,
    billingProfileName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

billingSubscriptionsListByBillingProfile().catch(console.error);

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

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1",
      "name": "billingSubscriptionId1",
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "properties": {
        "displayName": "My subscription",
        "subscriptionId": "88100ba7-38e2-4369-aa8e-544313e0c90b",
        "subscriptionBillingStatus": "Active",
        "lastMonthCharges": {
          "currency": "USD",
          "value": 5000
        },
        "monthToDateCharges": {
          "currency": "USD",
          "value": 600
        },
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
        "invoiceSectionDisplayName": "Contoso operations invoiceSection",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
        "billingProfileDisplayName": "Contoso operations billing",
        "costCenter": "ABC1234",
        "skuId": "0001",
        "skuDescription": "Microsoft Azure Plan"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2",
      "name": "billingSubscriptionId2",
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "properties": {
        "displayName": "Test subscription",
        "subscriptionId": "66e1ffd8-0f9d-4190-a5a3-910db5a20795",
        "subscriptionBillingStatus": "Active",
        "lastMonthCharges": {
          "currency": "USD",
          "value": 1000
        },
        "monthToDateCharges": {
          "currency": "USD",
          "value": 400
        },
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
        "invoiceSectionDisplayName": "Contoso operations invoiceSection",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
        "billingProfileDisplayName": "Contoso operations billing",
        "costCenter": "ABC1234",
        "skuId": "0001",
        "skuDescription": "Microsoft Azure Plan"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId3",
      "name": "billingSubscriptionId3",
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "properties": {
        "displayName": "Dev Subscription",
        "subscriptionId": "87607149-63a6-4644-8dc1-1d2e368f4994",
        "subscriptionBillingStatus": "Active",
        "lastMonthCharges": {
          "currency": "USD",
          "value": 6000
        },
        "monthToDateCharges": {
          "currency": "USD",
          "value": 900
        },
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000",
        "invoiceSectionDisplayName": "Contoso operations invoiceSection",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
        "billingProfileDisplayName": "Contoso operations billing",
        "costCenter": "ABC1234",
        "skuId": "0001",
        "skuDescription": "Microsoft Azure Plan"
      }
    }
  ]
}

Definiciones

Nombre	Description
Amount	Cantidad.
BillingSubscription	Una suscripción de facturación.
BillingSubscriptionsListResult	Lista de suscripciones de facturación.
BillingSubscriptionStatusType	Estado de facturación actual de la suscripció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
Reseller	Detalles del revendedor.

Amount

Cantidad.

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

BillingSubscription

Una suscripción de facturación.

Nombre	Tipo	Description
id	string	Id. de recurso.
name	string	Nombre del recurso.
properties.billingProfileDisplayName	string	Nombre del perfil de facturación al que se factura la suscripción.
properties.billingProfileId	string	Identificador del perfil de facturación al que se factura la suscripción.
properties.costCenter	string	Centro de costos aplicado a la suscripción.
properties.customerDisplayName	string	Nombre del cliente para el que se creó la suscripción. El campo solo es aplicable a la cuenta 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 la cuenta de facturación de Microsoft Partner Agreement.
properties.displayName	string	Nombre de la suscripción.
properties.invoiceSectionDisplayName	string	Nombre de la sección de factura a la que se factura la suscripción.
properties.invoiceSectionId	string	Identificador de la sección de factura a la que se factura la suscripción.
properties.lastMonthCharges	Amount	El último mes cobra.
properties.monthToDateCharges	Amount	Los cargos del mes actual hasta la fecha.
properties.reseller	Reseller	Revendedor de esta suscripción.
properties.skuDescription	string	Descripción de la SKU del plan de Azure para la suscripción.
properties.skuId	string	Identificador de SKU del plan de Azure para la suscripción.
properties.subscriptionBillingStatus	BillingSubscriptionStatusType	Estado de facturación actual de la suscripción.
properties.subscriptionId	string	Identificador de la suscripción.
properties.suspensionReasons	string[]	Motivo de suspensión de una suscripción. Solo se aplica a las suscripciones de las cuentas de facturación del Programa Microsoft Online Services.
type	string	Tipo de recurso.

BillingSubscriptionsListResult

Lista de suscripciones de facturación.

Nombre	Tipo	Description
nextLink	string	Vínculo (url) a la página siguiente de resultados.
totalCount	number	Número total de registros.
value	BillingSubscription[]	Lista de suscripciones de facturación.

BillingSubscriptionStatusType

Estado de facturación actual de la suscripción.

Nombre	Tipo	Description
Abandoned	string
Active	string
Deleted	string
Inactive	string
Warning	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

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.

Reseller

Detalles del revendedor.

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

Billing Subscriptions - List By Billing Profile

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

BillingSubscriptionsListByBillingProfile

Sample Request

Sample Response

Definiciones

Amount

BillingSubscription

BillingSubscriptionsListResult

BillingSubscriptionStatusType

ErrorDetails

ErrorResponse

ErrorSubDetails

Reseller

Recursos adicionales