Billing Subscriptions - Get

Referens

Service:: Billing

API Version:: 2021-10-01

Hämtar en prenumeration med sitt ID. Åtgärden stöds för närvarande för faktureringskonton med avtalstyp Microsoft-kundavtal, Microsoft-partneravtal och Microsoft Online Services-program.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}?api-version=2021-10-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
billingAccountName	path	True	string	Det ID som unikt identifierar ett faktureringskonto.
billingSubscriptionName	path	True	string	Det ID som unikt identifierar en prenumeration.
api-version	query	True	string	Den version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2021-10-01.

Svar

Name	Typ	Description
200 OK	BillingSubscription	OK. Begäran har slutförts.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

BillingSubscription

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/418b0e9c-5dc3-4260-918f-30b90619fe07?api-version=2021-10-01

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Billing;
using Azure.ResourceManager.Billing.Models;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2021-10-01/examples/BillingSubscription.json
// this example is just showing the usage of "BillingSubscriptions_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingSubscriptionResource created on azure
// for more information of creating BillingSubscriptionResource, please refer to the document of BillingSubscriptionResource
string billingAccountName = "{billingAccountName}";
string billingSubscriptionName = "418b0e9c-5dc3-4260-918f-30b90619fe07";
ResourceIdentifier billingSubscriptionResourceId = BillingSubscriptionResource.CreateResourceIdentifier(billingAccountName, billingSubscriptionName);
BillingSubscriptionResource billingSubscription = client.GetBillingSubscriptionResource(billingSubscriptionResourceId);

// invoke the operation
BillingSubscriptionResource result = await billingSubscription.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BillingSubscriptionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/418b0e9c-5dc3-4260-918f-30b90619fe07",
  "name": "418b0e9c-5dc3-4260-918f-30b90619fe07",
  "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
  "properties": {
    "autoRenew": "Off",
    "billingFrequency": "P1M",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/2b72f936-0166-47d6-91a3-ef9f84f36664",
    "billingProfileDisplayName": "Contoso operations billing profile",
    "billingProfileName": "2b72f936-0166-47d6-91a3-ef9f84f36664",
    "displayName": "Subscription 1",
    "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/2b72f936-0166-47d6-91a3-ef9f84f36664/invoiceSections/5c562559-e31b-4bfe-b608-f8b5b3fbd073",
    "invoiceSectionDisplayName": "Contoso operations invoice section",
    "invoiceSectionName": "5c562559-e31b-4bfe-b608-f8b5b3fbd073",
    "lastMonthCharges": {
      "currency": "USD",
      "value": 5000
    },
    "monthToDateCharges": {
      "currency": "USD",
      "value": 600
    },
    "productCategory": "UsageBased",
    "productType": "Usage based",
    "productTypeId": "DZH318Z0BPS6",
    "purchaseDate": "2021-10-01T00:00:00Z",
    "quantity": 1,
    "skuId": "0001",
    "skuDescription": "Microsoft Azure Plan",
    "status": "Active",
    "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3"
  }
}

Definitioner

Name	Description
Amount	Beloppet.
AutoRenew	Anger om automatisk förnyelse är aktiverat eller inaktiverat för en prenumeration.
BillingSubscription	En faktureringsprenumeration.
BillingSubscriptionStatus	Status för prenumerationen. Det här fältet är inte tillgängligt för Enterprise-avtal faktureringskonton.
ErrorDetails	Information om felet.
ErrorResponse	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.
ErrorSubDetails	Underinformationen om felet.
NextBillingCycleDetails	Nästa faktureringsperiod för prenumerationen.
RenewalTermDetails	Terminformationen för prenumerationen vid förnyelse.
Reseller	Information om återförsäljaren.
SubscriptionEnrollmentAccountStatus	Aktuell status för registreringskontot för prenumerationen. Det här fältet är endast tillgängligt för Enterprise-avtal faktureringskonton.

Amount

Beloppet.

Name	Typ	Description
currency	string	Valutan för beloppsvärdet.
value	number	Beloppsvärde.

AutoRenew

Anger om automatisk förnyelse är aktiverat eller inaktiverat för en prenumeration.

Name	Typ	Description
Off	string
On	string

BillingSubscription

En faktureringsprenumeration.

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.autoRenew	AutoRenew	Anger om automatisk förnyelse är aktiverat eller inaktiverat för en prenumeration.
properties.beneficiaryTenantId	string	Prenumerationens etableringsklientorganisation.
properties.billingFrequency	string	Faktureringsfrekvensen för prenumerationen i ISO8601 format. Exempel: P1M, P3M, P1Y
properties.billingPolicies	object	Ordlista över faktureringsprinciper som är associerade med prenumerationen.
properties.billingProfileDisplayName	string	Visningsnamnet för den faktureringsprofil som prenumerationen faktureras till. Det här fältet gäller endast för Microsoft-kundavtal faktureringskonton.
properties.billingProfileId	string	ID:t för den faktureringsprofil som prenumerationen faktureras till. Det här fältet gäller endast för Microsoft-kundavtal faktureringskonton.
properties.billingProfileName	string	Namnet på den faktureringsprofil som prenumerationen faktureras till. Det här fältet gäller endast för Microsoft-kundavtal faktureringskonton.
properties.consumptionCostCenter	string	Kostnadsställe som tillämpas på prenumerationen. Det här fältet är endast tillgängligt för förbrukningsprenumerationer av faktureringskonton av Microsoft-kundavtal typ.
properties.customerDisplayName	string	Namnet på kunden som prenumerationen skapades för. Fältet gäller endast för Microsoft-partneravtal faktureringskonton.
properties.customerId	string	ID för kunden som prenumerationen skapades för. Fältet gäller endast för Microsoft-partneravtal faktureringskonton.
properties.customerName	string	Namnet på kunden som prenumerationen skapades för. Fältet gäller endast för Microsoft-partneravtal faktureringskonton.
properties.displayName	string	Namnet på prenumerationen.
properties.enrollmentAccountDisplayName	string	Registreringskontonamnet som är associerat med prenumerationen. Det här fältet är endast tillgängligt för Enterprise-avtal faktureringskonton.
properties.enrollmentAccountId	string	Registreringskonto-ID som är associerat med prenumerationen. Det här fältet är endast tillgängligt för Enterprise-avtal faktureringskonton.
properties.enrollmentAccountSubscriptionDetails.enrollmentAccountStartDate	string	Registreringskontot och startdatumet för prenumerationsassociationen. Det här fältet är endast tillgängligt för Enterprise-avtal faktureringskonton.
properties.enrollmentAccountSubscriptionDetails.subscriptionEnrollmentAccountStatus	SubscriptionEnrollmentAccountStatus	Aktuell status för registreringskontot för prenumerationen. Det här fältet är endast tillgängligt för Enterprise-avtal faktureringskonton.
properties.invoiceSectionDisplayName	string	Visningsnamnet för fakturaavsnittet som prenumerationen faktureras till. Fältet gäller endast för Microsoft-partneravtal faktureringskonton.
properties.invoiceSectionId	string	ID:t för fakturaavsnittet som prenumerationen faktureras till. Fältet gäller endast för Microsoft-partneravtal faktureringskonton.
properties.invoiceSectionName	string	Namnet på fakturaavsnittet som prenumerationen faktureras till. Fältet gäller endast för Microsoft-partneravtal faktureringskonton.
properties.lastMonthCharges	Amount	Den senaste månadens avgifter. Det här fältet är endast tillgängligt för användningsbaserade prenumerationer på Microsoft-kundavtal faktureringskonton.
properties.monthToDateCharges	Amount	Aktuell månad hittills avgifter. Det här fältet är endast tillgängligt för användningsbaserade prenumerationer på Microsoft-kundavtal faktureringskonton.
properties.nextBillingCycleDetails	NextBillingCycleDetails	Information om nästa faktureringsperiod för prenumerationen.
properties.offerId	string	Erbjudande-ID för prenumerationen. Det här fältet är endast tillgängligt för faktureringskontona för Microsoft Online Services-programmet.
properties.productCategory	string	Kategorin för den produkt som prenumerationen har köpts för. Möjliga värden är: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other
properties.productType	string	Typen av produkt som prenumerationen har köpts för
properties.productTypeId	string	ID:t för produkten som prenumerationen har köpts för
properties.purchaseDate	string	Inköpsdatumet för prenumerationen i UTC-tid.
properties.quantity	integer	Antalet licenser som köpts för prenumerationen
properties.renewalTermDetails	RenewalTermDetails	Terminformationen för prenumerationen vid nästa förnyelse.
properties.reseller	Reseller	Återförsäljaren som prenumerationen skapas för. Fältet är tillgängligt för Microsoft-partneravtal faktureringskonton.
properties.skuDescription	string	SKU-beskrivningen av produkten som prenumerationen har köpts för. Det här fältet är endast tillgängligt för Microsoft-kundavtal faktureringskonton.
properties.skuId	string	SKU-ID:t för produkten som prenumerationen har köpts för. Det här fältet är endast tillgängligt för Microsoft-kundavtal faktureringskonton.
properties.status	BillingSubscriptionStatus	Status för prenumerationen. Det här fältet är inte tillgängligt för Enterprise-avtal faktureringskonton.
properties.subscriptionId	string	ID för den användningsbaserade prenumerationen. Det här fältet är endast tillgängligt för användningsbaserade prenumerationer på Microsoft-kundavtal faktureringskonton.
properties.suspensionReasons	string[]	Uppsägningsorsaken till prenumerationen. Det här fältet är inte tillgängligt för Enterprise-avtal faktureringskonton.
properties.termDuration	string	Hur länge du kan använda prenumerationen. Exempel P1Y och P1M
properties.termEndDate	string	Slutdatumet för termen i UTC-tid.
properties.termStartDate	string	Startdatumet för termen i UTC-tid.
type	string	Resurstyp.

BillingSubscriptionStatus

Status för prenumerationen. Det här fältet är inte tillgängligt för Enterprise-avtal faktureringskonton.

Name	Typ	Description
Active	string
AutoRenew	string
Cancelled	string
Deleted	string
Disabled	string
Expired	string
Expiring	string
Suspended	string
Unknown	string
Warned	string

ErrorDetails

Information om felet.

Name	Typ	Description
code	string	Felkod.
details	ErrorSubDetails[]	Underinformationen om felet.
message	string	Felmeddelande som anger varför åtgärden misslyckades.
target	string	Målet för det specifika felet.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name	Typ	Description
error	ErrorDetails	Information om felet.

ErrorSubDetails

Underinformationen om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.
target	string	Målet för det specifika felet.

NextBillingCycleDetails

Nästa faktureringsperiod för prenumerationen.

Name	Typ	Description
billingFrequency	string	Faktureringsfrekvensen för prenumerationen under nästa faktureringsperiod.

RenewalTermDetails

Terminformationen för prenumerationen vid förnyelse.

Name	Typ	Description
billingFrequency	string	Faktureringsfrekvensen för prenumerationen.
productTypeId	string	ID för produkten.
quantity	integer	Antalet licenser
skuId	string	SKU-ID för produkten
termDuration	string	Prenumerationens varaktighet. Exempel P1M och P1Y

Reseller

Information om återförsäljaren.

Name	Typ	Description
description	string	Namnet på återförsäljaren.
resellerId	string	MPN-ID för återförsäljaren.

SubscriptionEnrollmentAccountStatus

Aktuell status för registreringskontot för prenumerationen. Det här fältet är endast tillgängligt för Enterprise-avtal faktureringskonton.

Name	Typ	Description
Active	string
Cancelled	string
Deleted	string
Expired	string
TransferredOut	string
Transferring	string

Billing Subscriptions - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

BillingSubscription

Sample Request

Sample Response

Definitioner

Amount

AutoRenew

BillingSubscription

BillingSubscriptionStatus

ErrorDetails

ErrorResponse

ErrorSubDetails

NextBillingCycleDetails

RenewalTermDetails

Reseller

SubscriptionEnrollmentAccountStatus

Ytterligare resurser