Billing Subscriptions - List By Billing Profile

Referência

Service:: Billing

API Version:: 2020-05-01

Lista as subscrições que são faturadas num perfil de faturação. A operação é suportada para contas de faturação com tipo de contrato Contrato de Cliente Microsoft ou Contrato de Parceiro da Microsoft.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
billingAccountName	path	True	string	O ID que identifica exclusivamente uma conta de faturação.
billingProfileName	path	True	string	O ID que identifica exclusivamente um perfil de faturação.
api-version	query	True	string	A versão da API a ser utilizada com o pedido de cliente. A versão atual é 2020-05-01.

Respostas

Name	Tipo	Description
200 OK	BillingSubscriptionsListResult	OK. O pedido foi efetuada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual 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

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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

Definições

Name	Description
Amount	O montante.
BillingSubscription	Uma subscrição de faturação.
BillingSubscriptionsListResult	A lista de subscrições de faturação.
BillingSubscriptionStatusType	O estado de faturação atual da subscrição.
ErrorDetails	Os detalhes do erro.
ErrorResponse	A resposta de erro indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.
ErrorSubDetails
Reseller	Detalhes do revendedor.

Amount

O montante.

Name	Tipo	Description
currency	string	A moeda do valor de montante.
value	number	Valor de montante.

BillingSubscription

Uma subscrição de faturação.

Name	Tipo	Description
id	string	ID do Recurso.
name	string	Nome do recurso.
properties.billingProfileDisplayName	string	O nome do perfil de faturação ao qual a subscrição é faturada.
properties.billingProfileId	string	O ID do perfil de faturação ao qual a subscrição é faturada.
properties.costCenter	string	O centro de custos aplicado à subscrição.
properties.customerDisplayName	string	O nome do cliente para o qual a subscrição foi criada. O campo é aplicável apenas para Contrato de Parceiro da Microsoft conta de faturação.
properties.customerId	string	O ID do cliente para o qual a subscrição foi criada. O campo é aplicável apenas para Contrato de Parceiro da Microsoft conta de faturação.
properties.displayName	string	O nome da subscrição.
properties.invoiceSectionDisplayName	string	O nome da secção da fatura à qual a subscrição é faturada.
properties.invoiceSectionId	string	O ID da secção da fatura à qual a subscrição é faturada.
properties.lastMonthCharges	Amount	Os custos do último mês.
properties.monthToDateCharges	Amount	Os custos do mês atual até à data.
properties.reseller	Reseller	Revendedor para esta subscrição.
properties.skuDescription	string	A descrição do SKU do plano do Azure para a subscrição.
properties.skuId	string	O ID do SKU do plano do Azure para a subscrição.
properties.subscriptionBillingStatus	BillingSubscriptionStatusType	O estado de faturação atual da subscrição.
properties.subscriptionId	string	O ID da subscrição.
properties.suspensionReasons	string[]	O motivo da suspensão de uma subscrição. Aplica-se apenas a subscrições em contas de faturação do Programa Microsoft Online Services.
type	string	Tipo de recurso.

BillingSubscriptionsListResult

A lista de subscrições de faturação.

Name	Tipo	Description
nextLink	string	A ligação (URL) para a página seguinte dos resultados.
totalCount	number	Número total de registos.
value	BillingSubscription[]	A lista de subscrições de faturação.

BillingSubscriptionStatusType

O estado de faturação atual da subscrição.

Name	Tipo	Description
Abandoned	string
Active	string
Deleted	string
Inactive	string
Warning	string

ErrorDetails

Os detalhes do erro.

Name	Tipo	Description
code	string	Código de erro.
details	ErrorSubDetails[]	Os sub detalhes do erro.
message	string	Mensagem de erro a indicar o motivo pela qual a operação falhou.
target	string	O destino do erro específico.

ErrorResponse

A resposta de erro indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Name	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

ErrorSubDetails

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro a indicar o motivo pela qual a operação falhou.
target	string	O destino do erro específico.

Reseller

Detalhes do revendedor.

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

Billing Subscriptions - List By Billing Profile

Parâmetros do URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

BillingSubscriptionsListByBillingProfile

Sample Request

Sample Response

Definições

Amount

BillingSubscription

BillingSubscriptionsListResult

BillingSubscriptionStatusType

ErrorDetails

ErrorResponse

ErrorSubDetails

Reseller

Recursos adicionais