Billing Property - Get

Reference

Service:: Billing

API Version:: 2020-05-01

Get the billing properties for a subscription. This operation is not supported for billing accounts with agreement type Enterprise Agreement.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default?api-version=2020-05-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID that uniquely identifies an Azure subscription.
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	BillingProperty	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

BillingProperty

Sample Request

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default?api-version=2020-05-01

/** Samples for BillingProperty Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProperty.json
     */
    /**
     * Sample code: BillingProperty.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingProperty(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingProperties().getWithResponse(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_property.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="{subscriptionId}",
    )

    response = client.billing_property.get()
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProperty.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/BillingProperty.json
func ExamplePropertyClient_Get() {
	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)
	}
	res, err := clientFactory.NewPropertyClient().Get(ctx, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Property = armbilling.Property{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Billing/billingProperty"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default"),
	// 	Properties: &armbilling.PropertyProperties{
	// 		AccountAdminNotificationEmailAddress: to.Ptr("test@contoso.com"),
	// 		BillingAccountDisplayName: to.Ptr("My Account"),
	// 		BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000"),
	// 		BillingProfileDisplayName: to.Ptr("Contoso operations billing"),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000"),
	// 		BillingProfileSpendingLimit: to.Ptr(armbilling.BillingProfileSpendingLimitOn),
	// 		BillingProfileStatus: to.Ptr(armbilling.BillingProfileStatusWarned),
	// 		BillingProfileStatusReasonCode: to.Ptr(armbilling.BillingProfileStatusReasonCodePastDue),
	// 		BillingTenantID: to.Ptr("90000000-0000-0000-0000-000000000011"),
	// 		CostCenter: to.Ptr("1010"),
	// 		InvoiceSectionDisplayName: to.Ptr("Contoso operations invoice section"),
	// 		InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000"),
	// 		IsAccountAdmin: to.Ptr(true),
	// 		ProductID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000/products/44000000-0000-0000-0000-000000000000"),
	// 		ProductName: to.Ptr("Standard Dev"),
	// 		SKUDescription: to.Ptr("Microsoft Azure Plan for DevTest"),
	// 		SKUID: to.Ptr("0001"),
	// 	},
	// }
}

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 Get the billing properties for a subscription. This operation is not supported for billing accounts with agreement type Enterprise Agreement.
 *
 * @summary Get the billing properties for a subscription. This operation is not supported for billing accounts with agreement type Enterprise Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProperty.json
 */
async function billingProperty() {
  const subscriptionId = "{subscriptionId}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.billingPropertyOperations.get();
  console.log(result);
}

billingProperty().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

{
  "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default",
  "name": "default",
  "type": "Microsoft.Billing/billingProperty",
  "properties": {
    "accountAdminNotificationEmailAddress": "test@contoso.com",
    "billingTenantId": "90000000-0000-0000-0000-000000000011",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000",
    "billingAccountDisplayName": "My Account",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000",
    "billingProfileDisplayName": "Contoso operations billing",
    "billingProfileStatus": "Warned",
    "billingProfileStatusReasonCode": "PastDue",
    "billingProfileSpendingLimit": "On",
    "costCenter": "1010",
    "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000",
    "invoiceSectionDisplayName": "Contoso operations invoice section",
    "isAccountAdmin": true,
    "productId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000/products/44000000-0000-0000-0000-000000000000",
    "productName": "Standard Dev",
    "skuId": "0001",
    "skuDescription": "Microsoft Azure Plan for DevTest"
  }
}

Definitions

Name	Description
BillingProfileSpendingLimit	The billing profile spending limit.
BillingProfileStatus	The status of the billing profile.
BillingProfileStatusReasonCode	Reason for the specified billing profile status.
BillingProperty	A billing property.
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

BillingProfileSpendingLimit

The billing profile spending limit.

Name	Type	Description
Off	string
On	string

BillingProfileStatus

The status of the billing profile.

Name	Type	Description
Active	string
Disabled	string
Warned	string

BillingProfileStatusReasonCode

Reason for the specified billing profile status.

Name	Type	Description
PastDue	string
SpendingLimitExpired	string
SpendingLimitReached	string

BillingProperty

A billing property.

Name	Type	Description
id	string	Resource Id.
name	string	Resource name.
properties.accountAdminNotificationEmailAddress	string	The email address on which the account admin gets all Azure notifications.
properties.billingAccountDisplayName	string	The name of the billing account to which the subscription is billed.
properties.billingAccountId	string	The ID of the billing account to which the subscription is billed.
properties.billingProfileDisplayName	string	The name of the billing profile to which the subscription is billed.
properties.billingProfileId	string	The ID of the billing profile to which the subscription is billed.
properties.billingProfileSpendingLimit	BillingProfileSpendingLimit	The billing profile spending limit.
properties.billingProfileStatus	BillingProfileStatus	The status of the billing profile.
properties.billingProfileStatusReasonCode	BillingProfileStatusReasonCode	Reason for the specified billing profile status.
properties.billingTenantId	string	The Azure AD tenant ID of the billing account for the subscription.
properties.costCenter	string	The cost center applied to the subscription.
properties.invoiceSectionDisplayName	string	The name of the invoice section to which the subscription is billed.
properties.invoiceSectionId	string	The ID of the invoice section to which the subscription is billed.
properties.isAccountAdmin	boolean	Indicates whether user is the account admin.
properties.productId	string	The product ID of the Azure plan.
properties.productName	string	The product name of the Azure plan.
properties.skuDescription	string	The sku description of the Azure plan for the subscription.
properties.skuId	string	The sku ID of the Azure plan for the subscription.
type	string	Resource type.

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.

Billing Property - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

BillingProperty

Sample Request

Sample Response

Definitions

BillingProfileSpendingLimit

BillingProfileStatus

BillingProfileStatusReasonCode

BillingProperty

ErrorDetails

ErrorResponse

ErrorSubDetails

Additional resources