Billing Subscriptions - Get

Odwołanie

Service:: Billing

API Version:: 2021-10-01

Pobiera subskrypcję według jej identyfikatora. Ta operacja jest obecnie obsługiwana dla kont rozliczeniowych z typem umowy Umowa z Klientem Microsoft, Microsoft Partner Agreement i Microsoft Online Services Program.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
billingAccountName	path	True	string	Identyfikator, który jednoznacznie identyfikuje konto rozliczeniowe.
billingSubscriptionName	path	True	string	Identyfikator, który jednoznacznie identyfikuje subskrypcję.
api-version	query	True	string	Wersja interfejsu API, która ma być używana z żądaniem klienta. Bieżąca wersja to 2021-10-01.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BillingSubscription	OK. Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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"
  }
}

Definicje

Nazwa	Opis
Amount	Kwota.
AutoRenew	Wskazuje, czy automatyczne odnawianie jest włączone, czy wyłączone dla subskrypcji.
BillingSubscription	Subskrypcja rozliczeń.
BillingSubscriptionStatus	Stan subskrypcji. To pole nie jest dostępne dla kont rozliczeniowych Enterprise Agreement.
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.
ErrorSubDetails	Szczegóły podrzędne błędu.
NextBillingCycleDetails	Szczegóły następnego cyklu rozliczeniowego subskrypcji.
RenewalTermDetails	Termin szczegóły subskrypcji podczas odnawiania.
Reseller	Szczegóły odsprzedawcy.
SubscriptionEnrollmentAccountStatus	Bieżący stan konta rejestracji subskrypcji. To pole jest dostępne tylko dla kont rozliczeniowych Enterprise Agreement.

Amount

Kwota.

Nazwa	Typ	Opis
currency	string	Waluta dla wartości kwoty.
value	number	Wartość kwoty.

AutoRenew

Wskazuje, czy automatyczne odnawianie jest włączone, czy wyłączone dla subskrypcji.

Nazwa	Typ	Opis
Off	string
On	string

BillingSubscription

Subskrypcja rozliczeń.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.autoRenew	AutoRenew	Wskazuje, czy automatyczne odnawianie jest włączone, czy wyłączone dla subskrypcji.
properties.beneficiaryTenantId	string	Dzierżawa aprowizacji subskrypcji.
properties.billingFrequency	string	Częstotliwość rozliczeń subskrypcji w formacie ISO8601. Przykład: P1M, P3M, P1Y
properties.billingPolicies	object	Słownik zasad rozliczeń skojarzonych z subskrypcją.
properties.billingProfileDisplayName	string	Nazwa wyświetlana profilu rozliczeniowego, do którego jest rozliczana subskrypcja. To pole dotyczy tylko kont rozliczeniowych Umowa z Klientem Microsoft.
properties.billingProfileId	string	Identyfikator profilu rozliczeniowego, do którego jest rozliczana subskrypcja. To pole dotyczy tylko kont rozliczeniowych Umowa z Klientem Microsoft.
properties.billingProfileName	string	Nazwa profilu rozliczeniowego, do którego jest rozliczana subskrypcja. To pole dotyczy tylko kont rozliczeniowych Umowa z Klientem Microsoft.
properties.consumptionCostCenter	string	Centrum kosztów zastosowane do subskrypcji. To pole jest dostępne tylko dla subskrypcji użycia Umowa z Klientem Microsoft Typ kont rozliczeniowych.
properties.customerDisplayName	string	Nazwa klienta, dla którego utworzono subskrypcję. Pole ma zastosowanie tylko dla kont rozliczeniowych Microsoft Partner Agreement.
properties.customerId	string	Identyfikator klienta, dla którego utworzono subskrypcję. Pole ma zastosowanie tylko dla kont rozliczeniowych Microsoft Partner Agreement.
properties.customerName	string	Nazwa klienta, dla którego utworzono subskrypcję. Pole ma zastosowanie tylko dla kont rozliczeniowych Microsoft Partner Agreement.
properties.displayName	string	Nazwa subskrypcji.
properties.enrollmentAccountDisplayName	string	Nazwa konta rejestracji skojarzona z subskrypcją. To pole jest dostępne tylko dla kont rozliczeniowych Enterprise Agreement.
properties.enrollmentAccountId	string	Identyfikator konta rejestracji skojarzony z subskrypcją. To pole jest dostępne tylko dla kont rozliczeniowych Enterprise Agreement.
properties.enrollmentAccountSubscriptionDetails.enrollmentAccountStartDate	string	Konto rejestracji i data rozpoczęcia skojarzenia subskrypcji. To pole jest dostępne tylko dla kont rozliczeniowych Enterprise Agreement.
properties.enrollmentAccountSubscriptionDetails.subscriptionEnrollmentAccountStatus	SubscriptionEnrollmentAccountStatus	Bieżący stan konta rejestracji subskrypcji. To pole jest dostępne tylko dla kont rozliczeniowych Enterprise Agreement.
properties.invoiceSectionDisplayName	string	Nazwa wyświetlana sekcji faktury, do której jest rozliczana subskrypcja. Pole ma zastosowanie tylko dla kont rozliczeniowych Microsoft Partner Agreement.
properties.invoiceSectionId	string	Identyfikator sekcji faktury, do której jest rozliczana subskrypcja. Pole ma zastosowanie tylko dla kont rozliczeniowych Microsoft Partner Agreement.
properties.invoiceSectionName	string	Nazwa sekcji faktury, do której jest rozliczana subskrypcja. Pole ma zastosowanie tylko dla kont rozliczeniowych Microsoft Partner Agreement.
properties.lastMonthCharges	Amount	Opłaty za ostatni miesiąc. To pole jest dostępne tylko dla subskrypcji opartych na użyciu kont rozliczeniowych Umowa z Klientem Microsoft.
properties.monthToDateCharges	Amount	Opłaty za bieżący miesiąc do daty. To pole jest dostępne tylko dla subskrypcji opartych na użyciu kont rozliczeniowych Umowa z Klientem Microsoft.
properties.nextBillingCycleDetails	NextBillingCycleDetails	Następne szczegóły cyklu rozliczeniowego subskrypcji.
properties.offerId	string	Identyfikator oferty dla subskrypcji. To pole jest dostępne tylko dla kont rozliczeniowych programu Microsoft Online Services.
properties.productCategory	string	Kategoria produktu, dla którego zakupiono subskrypcję. Możliwe wartości obejmują: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other
properties.productType	string	Typ produktu, dla którego zakupiono subskrypcję
properties.productTypeId	string	Identyfikator produktu, dla którego zakupiono subskrypcję
properties.purchaseDate	string	Data zakupu subskrypcji w czasie UTC.
properties.quantity	integer	Liczba licencji zakupionych dla subskrypcji
properties.renewalTermDetails	RenewalTermDetails	Termin szczegóły subskrypcji podczas następnego odnawiania.
properties.reseller	Reseller	Odsprzedawca, dla którego utworzono subskrypcję. Pole jest dostępne dla kont rozliczeniowych Microsoft Partner Agreement.
properties.skuDescription	string	Opis jednostki SKU produktu, dla którego zakupiono subskrypcję. To pole jest dostępne tylko dla kont rozliczeniowych Umowa z Klientem Microsoft.
properties.skuId	string	Identyfikator jednostki SKU produktu, dla którego zakupiono subskrypcję. To pole jest dostępne tylko dla kont rozliczeniowych Umowa z Klientem Microsoft.
properties.status	BillingSubscriptionStatus	Stan subskrypcji. To pole nie jest dostępne dla kont rozliczeniowych Enterprise Agreement.
properties.subscriptionId	string	Identyfikator subskrypcji opartej na użyciu. To pole jest dostępne tylko dla subskrypcji opartych na użyciu kont rozliczeniowych Umowa z Klientem Microsoft.
properties.suspensionReasons	string[]	Przyczyna zawieszenia subskrypcji. To pole nie jest dostępne dla kont rozliczeniowych Enterprise Agreement.
properties.termDuration	string	Czas trwania, przez który można użyć subskrypcji. Przykład P1Y i P1M
properties.termEndDate	string	Data zakończenia terminu w czasie UTC.
properties.termStartDate	string	Data rozpoczęcia terminu w czasie UTC.
type	string	Typ zasobu.

BillingSubscriptionStatus

Stan subskrypcji. To pole nie jest dostępne dla kont rozliczeniowych Enterprise Agreement.

Nazwa	Typ	Opis
Active	string
AutoRenew	string
Cancelled	string
Deleted	string
Disabled	string
Expired	string
Expiring	string
Suspended	string
Unknown	string
Warned	string

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ErrorSubDetails[]	Szczegóły podrzędne błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.
target	string	Element docelowy określonego błędu.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.

ErrorSubDetails

Szczegóły podrzędne błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.
target	string	Element docelowy określonego błędu.

NextBillingCycleDetails

Szczegóły następnego cyklu rozliczeniowego subskrypcji.

Nazwa	Typ	Opis
billingFrequency	string	Częstotliwość rozliczeń subskrypcji w następnym cyklu rozliczeniowym.

RenewalTermDetails

Termin szczegóły subskrypcji podczas odnawiania.

Nazwa	Typ	Opis
billingFrequency	string	Częstotliwość rozliczeń subskrypcji.
productTypeId	string	Identyfikator produktu.
quantity	integer	Liczba licencji
skuId	string	Identyfikator jednostki SKU produktu
termDuration	string	Okres trwania subskrypcji. Przykład P1M i P1Y

Reseller

Szczegóły odsprzedawcy.

Nazwa	Typ	Opis
description	string	Nazwa odsprzedawcy.
resellerId	string	Identyfikator MPN odsprzedawcy.

SubscriptionEnrollmentAccountStatus

Bieżący stan konta rejestracji subskrypcji. To pole jest dostępne tylko dla kont rozliczeniowych Enterprise Agreement.

Nazwa	Typ	Opis
Active	string
Cancelled	string
Deleted	string
Expired	string
TransferredOut	string
Transferring	string

Share via

Billing Subscriptions - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

BillingSubscription

Sample Request

Sample Response

Definicje

Amount

AutoRenew

BillingSubscription

BillingSubscriptionStatus

ErrorDetails

ErrorResponse

ErrorSubDetails

NextBillingCycleDetails

RenewalTermDetails

Reseller

SubscriptionEnrollmentAccountStatus

Dodatkowe zasoby