Billing Periods - List

Referenz

Dienst:: Billing

API-Version:: 2018-03-01-preview

Listet die verfügbaren Abrechnungszeiträume für ein Abonnement in umgekehrter chronologischer Reihenfolge auf. Dies wird nur für Azure Web-Direct-Abonnements unterstützt. Andere Abonnementtypen, die nicht direkt über das Azure-Webportal erworben wurden, werden über diese Vorschau-API nicht unterstützt.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Die ID, die ein Azure-Abonnement eindeutig identifiziert.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2018-03-01-preview.
$filter	query		string	Kann verwendet werden, um Abrechnungszeiträume nach billingPeriodEndDate zu filtern. Der Filter unterstützt "eq", "lt", "gt", "le", "ge" und "and". Es unterstützt derzeit weder 'ne', 'or' oder 'not'.
$skiptoken	query		string	Skiptoken wird nur verwendet, wenn ein vorheriger Vorgang ein Teilergebnis zurückgegeben hat. Wenn eine vorherige Antwort ein nextLink-Element enthält, enthält der Wert des nextLink-Elements einen Skiptoken-Parameter, der einen Ausgangspunkt angibt, der für nachfolgende Aufrufe verwendet werden soll.
$top	query		integer (int32) minimum: 1 maximum: 100	Kann verwendet werden, um die Anzahl der Ergebnisse auf die letzten N-Abrechnungszeiträume zu beschränken.

Antworten

Name	Typ	Beschreibung
200 OK	BillingPeriodsListResult	OKAY. Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

BillingPeriodsList

Beispielanforderung

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

/** Samples for BillingPeriods List. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/BillingPeriodsList.json
     */
    /**
     * Sample code: BillingPeriodsList.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void billingPeriodsList(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingPeriods().list(null, null, null, 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_periods_list.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.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/BillingPeriodsList.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/preview/2018-03-01-preview/examples/BillingPeriodsList.json
func ExamplePeriodsClient_NewListPager() {
	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.NewPeriodsClient().NewListPager(&armbilling.PeriodsClientListOptions{Filter: nil,
		Skiptoken: nil,
		Top:       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.PeriodsListResult = armbilling.PeriodsListResult{
		// 	Value: []*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

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

/**
 * This sample demonstrates how to Lists the available billing periods for a subscription in reverse chronological order. 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 Lists the available billing periods for a subscription in reverse chronological order. 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/BillingPeriodsList.json
 */
async function billingPeriodsList() {
  const subscriptionId = "subid";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.billingPeriods.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "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"
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
BillingPeriod	Eine Abrechnungszeitraumsressource.
BillingPeriodsListResult	Ergebnis der Auflistung von Abrechnungszeiträumen. Sie enthält eine Liste der verfügbaren Abrechnungszeiträume in umgekehrter chronologischer Reihenfolge.
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
ErrorSubDetails

BillingPeriod

Objekt

Eine Abrechnungszeitraumsressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.billingPeriodEndDate	string (date)	Das Ende des Datumsbereichs, der durch den Abrechnungszeitraum abgedeckt ist.
properties.billingPeriodStartDate	string (date)	Der Anfang des Datumsbereichs, der vom Abrechnungszeitraum abgedeckt wird.
properties.invoiceIds	string[]	Array von Rechnungs-IDs, die zugeordnet sind.
type	string	Ressourcentyp.

BillingPeriodsListResult

Objekt

Ergebnis der Auflistung von Abrechnungszeiträumen. Sie enthält eine Liste der verfügbaren Abrechnungszeiträume in umgekehrter chronologischer Reihenfolge.

Name	Typ	Beschreibung
nextLink	string	Der Link (URL) zur nächsten Seite der Ergebnisse.
value	BillingPeriod[]	Die Liste der Abrechnungszeiträume.

ErrorDetails

Objekt

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
details	ErrorSubDetails[]	Die Unterdetails des Fehlers.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.
target	string	Das Ziel des bestimmten Fehlers.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

ErrorSubDetails

Objekt

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.
target	string	Das Ziel des bestimmten Fehlers.

Freigeben über

Billing Periods - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

BillingPeriodsList

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BillingPeriod

BillingPeriodsListResult

ErrorDetails

ErrorResponse

ErrorSubDetails