Billing Accounts - List Invoice Sections By Create Subscription Permission

Reference

Service:: Billing

API Version:: 2020-05-01

Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission?api-version=2020-05-01

URI Parameters

Name	In	Required	Type	Description
billingAccountName	path	True	string	The ID that uniquely identifies a billing account.
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2020-05-01.

Responses

Name	Type	Description
200 OK	InvoiceSectionListWithCreateSubPermissionResult	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

InvoiceSectionsListWithCreateSubPermission

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission?api-version=2020-05-01

/** Samples for BillingAccounts ListInvoiceSectionsByCreateSubscriptionPermission. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListWithCreateSubPermission.json
     */
    /**
     * Sample code: InvoiceSectionsListWithCreateSubPermission.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void invoiceSectionsListWithCreateSubPermission(
        com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .billingAccounts()
            .listInvoiceSectionsByCreateSubscriptionPermission(
                "{billingAccountName}", 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 invoice_sections_list_with_create_sub_permission.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_accounts.list_invoice_sections_by_create_subscription_permission(
        billing_account_name="{billingAccountName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListWithCreateSubPermission.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/InvoiceSectionsListWithCreateSubPermission.json
func ExampleAccountsClient_NewListInvoiceSectionsByCreateSubscriptionPermissionPager() {
	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.NewAccountsClient().NewListInvoiceSectionsByCreateSubscriptionPermissionPager("{billingAccountName}", 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.InvoiceSectionListWithCreateSubPermissionResult = armbilling.InvoiceSectionListWithCreateSubPermissionResult{
		// 	Value: []*armbilling.InvoiceSectionWithCreateSubPermission{
		// 		{
		// 			BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
		// 			BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000"),
		// 			BillingProfileSpendingLimit: to.Ptr(armbilling.SpendingLimitForBillingProfileOn),
		// 			BillingProfileStatus: to.Ptr(armbilling.BillingProfileStatusWarned),
		// 			BillingProfileStatusReasonCode: to.Ptr(armbilling.StatusReasonCodeForBillingProfilePastDue),
		// 			BillingProfileSystemID: to.Ptr("1XXX-11XX-XX1-XXXX-XXX"),
		// 			EnabledAzurePlans: []*armbilling.AzurePlan{
		// 				{
		// 					SKUDescription: to.Ptr("Microsoft Azure Plan"),
		// 					SKUID: to.Ptr("0001"),
		// 				},
		// 				{
		// 					SKUDescription: to.Ptr("Microsoft Azure Plan for DevTest"),
		// 					SKUID: to.Ptr("0002"),
		// 			}},
		// 			InvoiceSectionDisplayName: to.Ptr("invoiceSection1"),
		// 			InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000"),
		// 			InvoiceSectionSystemID: to.Ptr("9XXX-11XX-XX1-XXXX-XXX"),
		// 	}},
		// }
	}
}

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 invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 *
 * @summary Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListWithCreateSubPermission.json
 */
async function invoiceSectionsListWithCreateSubPermission() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.billingAccounts.listInvoiceSectionsByCreateSubscriptionPermission(
    billingAccountName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

invoiceSectionsListWithCreateSubPermission().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": [
    {
      "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000",
      "invoiceSectionDisplayName": "invoiceSection1",
      "invoiceSectionSystemId": "9XXX-11XX-XX1-XXXX-XXX",
      "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
      "billingProfileDisplayName": "Contoso operations billing",
      "billingProfileStatus": "Warned",
      "billingProfileStatusReasonCode": "PastDue",
      "billingProfileSpendingLimit": "On",
      "billingProfileSystemId": "1XXX-11XX-XX1-XXXX-XXX",
      "enabledAzurePlans": [
        {
          "skuId": "0001",
          "skuDescription": "Microsoft Azure Plan"
        },
        {
          "skuId": "0002",
          "skuDescription": "Microsoft Azure Plan for DevTest"
        }
      ]
    }
  ]
}

Definitions

Name	Description
AzurePlan	Details of the Azure plan.
BillingProfileStatus	The status of the billing profile.
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
ErrorSubDetails
InvoiceSectionListWithCreateSubPermissionResult	The list of invoice section properties with create subscription permission.
InvoiceSectionWithCreateSubPermission	Invoice section properties with create subscription permission.
SpendingLimitForBillingProfile	The billing profile spending limit.
StatusReasonCodeForBillingProfile	Reason for the specified billing profile status.

AzurePlan

Details of the Azure plan.

Name	Type	Description
skuDescription	string	The sku description.
skuId	string	The sku id.

BillingProfileStatus

The status of the billing profile.

Name	Type	Description
Active	string
Disabled	string
Warned	string

ErrorDetails

The details of the error.

Name	Type	Description
code	string	Error code.
details	ErrorSubDetails[]	The sub details of the error.
message	string	Error message indicating why the operation failed.
target	string	The target of the particular error.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
error	ErrorDetails	The details of the error.

ErrorSubDetails

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.
target	string	The target of the particular error.

InvoiceSectionListWithCreateSubPermissionResult

The list of invoice section properties with create subscription permission.

Name	Type	Description
nextLink	string	The link (url) to the next page of results.
value	InvoiceSectionWithCreateSubPermission[]	The list of invoice section properties with create subscription permission.

InvoiceSectionWithCreateSubPermission

Invoice section properties with create subscription permission.

Name	Type	Description
billingProfileDisplayName	string	The name of the billing profile for the invoice section.
billingProfileId	string	The ID of the billing profile for the invoice section.
billingProfileSpendingLimit	SpendingLimitForBillingProfile	The billing profile spending limit.
billingProfileStatus	BillingProfileStatus	The status of the billing profile.
billingProfileStatusReasonCode	StatusReasonCodeForBillingProfile	Reason for the specified billing profile status.
billingProfileSystemId	string	The system generated unique identifier for a billing profile.
enabledAzurePlans	AzurePlan[]	Enabled azure plans for the associated billing profile.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The ID of the invoice section.
invoiceSectionSystemId	string	The system generated unique identifier for an invoice section.

SpendingLimitForBillingProfile

The billing profile spending limit.

Name	Type	Description
Off	string
On	string

StatusReasonCodeForBillingProfile

Reason for the specified billing profile status.

Name	Type	Description
PastDue	string
SpendingLimitExpired	string
SpendingLimitReached	string

Billing Accounts - List Invoice Sections By Create Subscription Permission

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

InvoiceSectionsListWithCreateSubPermission

Sample Request

Sample Response

Definitions

AzurePlan

BillingProfileStatus

ErrorDetails

ErrorResponse

ErrorSubDetails

InvoiceSectionListWithCreateSubPermissionResult

InvoiceSectionWithCreateSubPermission

SpendingLimitForBillingProfile

StatusReasonCodeForBillingProfile

Additional resources