Billing Subscriptions - Get
Získá předplatné podle svého ID. Tato operace se v současné době podporuje pro fakturační účty s typem smlouvy Smlouva se zákazníkem Microsoftu, Smlouva s partnerem Microsoftu a Program služeb Microsoft Online Services.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}?api-version=2021-10-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
billing
|
path | True |
string |
ID, které jednoznačně identifikuje fakturační účet. |
billing
|
path | True |
string |
ID, které jednoznačně identifikuje předplatné. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 2021-10-01. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK. Žádost byla úspěšná. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
BillingSubscription
Sample Request
Sample Response
{
"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"
}
}
Definice
Name | Description |
---|---|
Amount |
Částka. |
Auto |
Určuje, jestli je u předplatného zapnuté nebo vypnuté automatické prodlužování platnosti. |
Billing |
Fakturační předplatné. |
Billing |
Stav předplatného. Toto pole není k dispozici pro fakturační účty smlouva Enterprise. |
Error |
Podrobnosti o chybě. |
Error |
Chybová odpověď znamená, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě. |
Error |
Dílčí podrobnosti o chybě. |
Next |
Další fakturační cyklus podrobně popisuje předplatné. |
Renewal |
Podrobnosti o období předplatného při prodloužení. |
Reseller |
Podrobnosti o prodejci |
Subscription |
Aktuální stav registračního účtu předplatného. Toto pole je dostupné jenom pro fakturační účty smlouva Enterprise. |
Amount
Částka.
Name | Typ | Description |
---|---|---|
currency |
string |
Měna pro hodnotu částky. |
value |
number |
Hodnota množství. |
AutoRenew
Určuje, jestli je u předplatného zapnuté nebo vypnuté automatické prodlužování platnosti.
Name | Typ | Description |
---|---|---|
Off |
string |
|
On |
string |
BillingSubscription
Fakturační předplatné.
Name | Typ | Description |
---|---|---|
id |
string |
ID prostředku. |
name |
string |
Název prostředku. |
properties.autoRenew |
Určuje, jestli je u předplatného zapnuté nebo vypnuté automatické prodlužování platnosti. |
|
properties.beneficiaryTenantId |
string |
Zřizovací tenant předplatného. |
properties.billingFrequency |
string |
Četnost fakturace předplatného ve formátu ISO8601. Příklad: P1M, P3M, P1Y |
properties.billingPolicies |
object |
Slovník zásad fakturace přidružených k předplatnému. |
properties.billingProfileDisplayName |
string |
Zobrazovaný název fakturačního profilu, kterému se předplatné fakturuje. Toto pole platí jenom pro fakturační účty Smlouva se zákazníkem Microsoftu. |
properties.billingProfileId |
string |
ID fakturačního profilu, kterému se předplatné fakturuje. Toto pole platí jenom pro fakturační účty Smlouva se zákazníkem Microsoftu. |
properties.billingProfileName |
string |
Název fakturačního profilu, kterému se předplatné fakturuje. Toto pole platí jenom pro fakturační účty Smlouva se zákazníkem Microsoftu. |
properties.consumptionCostCenter |
string |
Nákladové středisko použité pro předplatné Toto pole je k dispozici pouze pro předplatná consumption Smlouva se zákazníkem Microsoftu Typ fakturačních účtů. |
properties.customerDisplayName |
string |
Jméno zákazníka, pro kterého bylo předplatné vytvořeno. Pole platí jenom pro fakturační účty Smlouva s partnerem Microsoftu. |
properties.customerId |
string |
ID zákazníka, pro kterého bylo předplatné vytvořeno. Pole platí jenom pro fakturační účty Smlouva s partnerem Microsoftu. |
properties.customerName |
string |
Jméno zákazníka, pro kterého bylo předplatné vytvořeno. Pole platí jenom pro fakturační účty Smlouva s partnerem Microsoftu. |
properties.displayName |
string |
Název předplatného. |
properties.enrollmentAccountDisplayName |
string |
Název registračního účtu přidruženého k předplatnému. Toto pole je dostupné jenom pro fakturační účty smlouva Enterprise. |
properties.enrollmentAccountId |
string |
ID registračního účtu přidruženého k předplatnému. Toto pole je dostupné jenom pro fakturační účty smlouva Enterprise. |
properties.enrollmentAccountSubscriptionDetails.enrollmentAccountStartDate |
string |
Registrační účet a počáteční datum přidružení předplatného. Toto pole je dostupné jenom pro fakturační účty smlouva Enterprise. |
properties.enrollmentAccountSubscriptionDetails.subscriptionEnrollmentAccountStatus |
Aktuální stav registračního účtu předplatného. Toto pole je dostupné jenom pro fakturační účty smlouva Enterprise. |
|
properties.invoiceSectionDisplayName |
string |
Zobrazovaný název oddílu faktury, do kterého se předplatné fakturuje. Pole platí jenom pro fakturační účty Smlouva s partnerem Microsoftu. |
properties.invoiceSectionId |
string |
ID oddílu faktury, do kterého se předplatné fakturuje. Pole platí jenom pro fakturační účty Smlouva s partnerem Microsoftu. |
properties.invoiceSectionName |
string |
Název oddílu faktury, do kterého se předplatné fakturuje. Pole platí jenom pro fakturační účty Smlouva s partnerem Microsoftu. |
properties.lastMonthCharges |
Poplatky za poslední měsíc. Toto pole je k dispozici pouze pro předplatná založená na využití Smlouva se zákazníkem Microsoftu fakturačních účtů. |
|
properties.monthToDateCharges |
Poplatky za aktuální měsíc. Toto pole je k dispozici pouze pro předplatná založená na využití Smlouva se zákazníkem Microsoftu fakturačních účtů. |
|
properties.nextBillingCycleDetails |
Podrobnosti o dalším fakturačním období předplatného |
|
properties.offerId |
string |
ID nabídky pro předplatné. Toto pole je k dispozici pouze pro fakturační účty programu Microsoft Online Services. |
properties.productCategory |
string |
Kategorie produktu, pro který se předplatné zakoupilo. Mezi možné hodnoty patří: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Jiné |
properties.productType |
string |
Typ produktu, pro který je předplatné zakoupeno |
properties.productTypeId |
string |
ID produktu, pro který se předplatné zakoupilo |
properties.purchaseDate |
string |
Datum nákupu předplatného v čase UTC. |
properties.quantity |
integer |
Počet licencí zakoupených pro předplatné |
properties.renewalTermDetails |
Podrobnosti o období předplatného při příštím prodloužení. |
|
properties.reseller |
Prodejce, pro kterého je předplatné vytvořené. Pole je k dispozici pro fakturační účty Smlouva s partnerem Microsoftu. |
|
properties.skuDescription |
string |
Popis skladové položky produktu, pro který je předplatné zakoupeno. Toto pole je dostupné jenom pro fakturační účty Smlouva se zákazníkem Microsoftu. |
properties.skuId |
string |
ID skladové položky produktu, pro který je předplatné zakoupeno. Toto pole je dostupné jenom pro fakturační účty Smlouva se zákazníkem Microsoftu. |
properties.status |
Stav předplatného. Toto pole není k dispozici pro fakturační účty smlouva Enterprise. |
|
properties.subscriptionId |
string |
ID předplatného založeného na využití. Toto pole je dostupné jenom pro předplatná Smlouva se zákazníkem Microsoftu fakturačních účtů založených na využití. |
properties.suspensionReasons |
string[] |
Důvod pozastavení předplatného. Toto pole není k dispozici pro fakturační účty smlouva Enterprise. |
properties.termDuration |
string |
Doba, po kterou můžete předplatné používat. Příklad P1Y a P1M |
properties.termEndDate |
string |
Koncové datum termínu v čase UTC. |
properties.termStartDate |
string |
Počáteční datum termínu v čase UTC. |
type |
string |
Typ prostředku. |
BillingSubscriptionStatus
Stav předplatného. Toto pole není k dispozici pro fakturační účty smlouva Enterprise.
Name | Typ | Description |
---|---|---|
Active |
string |
|
AutoRenew |
string |
|
Cancelled |
string |
|
Deleted |
string |
|
Disabled |
string |
|
Expired |
string |
|
Expiring |
string |
|
Suspended |
string |
|
Unknown |
string |
|
Warned |
string |
ErrorDetails
Podrobnosti o chybě.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby |
details |
Dílčí podrobnosti o chybě. |
|
message |
string |
Chybová zpráva s informacemi o tom, proč operace selhala. |
target |
string |
Cíl konkrétní chyby. |
ErrorResponse
Chybová odpověď znamená, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.
Name | Typ | Description |
---|---|---|
error |
Podrobnosti o chybě. |
ErrorSubDetails
Dílčí podrobnosti o chybě.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby |
message |
string |
Chybová zpráva s informacemi o tom, proč operace selhala. |
target |
string |
Cíl konkrétní chyby. |
NextBillingCycleDetails
Další fakturační cyklus podrobně popisuje předplatné.
Name | Typ | Description |
---|---|---|
billingFrequency |
string |
Četnost fakturace předplatného v dalším fakturačním období. |
RenewalTermDetails
Podrobnosti o období předplatného při prodloužení.
Name | Typ | Description |
---|---|---|
billingFrequency |
string |
Četnost fakturace předplatného. |
productTypeId |
string |
ID produktu. |
quantity |
integer |
Počet licencí |
skuId |
string |
ID skladové položky produktu |
termDuration |
string |
Doba trvání předplatného. Příklad P1M a P1Y |
Reseller
Podrobnosti o prodejci
Name | Typ | Description |
---|---|---|
description |
string |
Název prodejce. |
resellerId |
string |
ID MPN prodejce. |
SubscriptionEnrollmentAccountStatus
Aktuální stav registračního účtu předplatného. Toto pole je dostupné jenom pro fakturační účty smlouva Enterprise.
Name | Typ | Description |
---|---|---|
Active |
string |
|
Cancelled |
string |
|
Deleted |
string |
|
Expired |
string |
|
TransferredOut |
string |
|
Transferring |
string |