Billing Periods - Get

Service:

Billing

API Version:

2018-03-01-preview

Gets a named billing period. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}?api-version=2018-03-01-preview

URI Parameters

Name	In	Required	Type	Description
billingPeriodName	path	True	string	The name of a BillingPeriod resource.
subscriptionId	path	True	string	The ID that uniquely identifies an Azure subscription.
api-version	query	True	string	Version of the API to be used with the client request. The current version is 2018-03-01-preview.

Responses

Name	Type	Description
200 OK	BillingPeriod	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

BillingPeriodsGet

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1?api-version=2018-03-01-preview

Java

/** Samples for BillingPeriods Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/BillingPeriodsGet.json
     */
    /**
     * Sample code: BillingPeriodsGet.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingPeriodsGet(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingPeriods().getWithResponse("201702-1", 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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python billing_periods_get.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="subid",
    )

    response = client.billing_periods.get(
        billing_period_name="201702-1",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/BillingPeriodsGet.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

Go

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/preview/2018-03-01-preview/examples/BillingPeriodsGet.json
func ExamplePeriodsClient_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.NewPeriodsClient().Get(ctx, "201702-1", 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.Period = armbilling.Period{
	// 	Name: to.Ptr("201702-1"),
	// 	Type: to.Ptr("Microsoft.Billing/billingPeriods"),
	// 	ID: to.Ptr("/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1"),
	// 	Properties: &armbilling.PeriodProperties{
	// 		BillingPeriodEndDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2017-02-01"); return t}()),
	// 		BillingPeriodStartDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2017-01-01"); return t}()),
	// 		InvoiceIDs: []*string{
	// 			to.Ptr("/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789"),
	// 			to.Ptr("/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-01-05-987654321")},
	// 		},
	// 	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Gets a named billing period.  This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
 *
 * @summary Gets a named billing period.  This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/BillingPeriodsGet.json
 */
async function billingPeriodsGet() {
  const subscriptionId = "subid";
  const billingPeriodName = "201702-1";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.billingPeriods.get(billingPeriodName);
  console.log(result);
}

billingPeriodsGet().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/subid/providers/Microsoft.Billing/billingPeriods/201702-1",
  "name": "201702-1",
  "type": "Microsoft.Billing/billingPeriods",
  "properties": {
    "billingPeriodStartDate": "2017-01-01",
    "billingPeriodEndDate": "2017-02-01",
    "invoiceIds": [
      "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789",
      "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-01-05-987654321"
    ]
  }
}

Definitions

Name	Description
BillingPeriod	A billing period resource.
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

BillingPeriod

Object

A billing period resource.

Name	Type	Description
id	string	Resource Id.
name	string	Resource name.
properties.billingPeriodEndDate	string (date)	The end of the date range covered by the billing period.
properties.billingPeriodStartDate	string (date)	The start of the date range covered by the billing period.
properties.invoiceIds	string[]	Array of invoice ids that associated with.
type	string	Resource type.

ErrorDetails

Object

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

Object

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

Object

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