Billing Accounts - Get
Pobiera konto rozliczeniowe według jego identyfikatora.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}?api-version=2020-05-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}?api-version=2020-05-01&$expand={$expand}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
billing
|
path | True |
string |
Identyfikator, który jednoznacznie identyfikuje konto rozliczeniowe. |
api-version
|
query | True |
string |
Wersja interfejsu API, która ma być używana z żądaniem klienta. Bieżąca wersja to 2020-05-01. |
$expand
|
query |
string |
Może służyć do rozszerzania kolumny soldTo, sekcji faktur i profilów rozliczeniowych. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK. Żądanie zakończyło się pomyślnie. |
|
Other Status Codes |
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
Billing |
Billing |
BillingAccounts
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}?api-version=2020-05-01
Sample Response
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}",
"name": "{billingAccountName}",
"type": "Microsoft.Billing/billingAccounts",
"properties": {
"displayName": "Test Account",
"agreementType": "MicrosoftCustomerAgreement",
"accountStatus": "Active",
"accountType": "Enterprise",
"hasReadAccess": true
}
}
BillingAccountWithExpand
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}?api-version=2020-05-01&$expand=soldTo,billingProfiles,billingProfiles/invoiceSections
Sample Response
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}",
"name": "{billingAccountName}",
"type": "Microsoft.Billing/billingAccounts",
"properties": {
"displayName": "Test Account 1",
"agreementType": "MicrosoftCustomerAgreement",
"accountStatus": "Active",
"soldTo": {
"companyName": "Contoso",
"firstName": "Test",
"lastName": "User",
"addressLine1": "Test Address",
"addressLine2": "Test Address",
"addressLine3": "Test Address",
"city": "City",
"postalCode": "00000",
"region": "WA",
"country": "US",
"email": "abc@contoso.com",
"phoneNumber": "000-000-0000"
},
"accountType": "Enterprise",
"billingProfiles": {
"hasMoreResults": true,
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
"name": "11000000-0000-0000-0000-000000000000",
"type": "Microsoft.Billing/billingAccounts/billingProfiles",
"properties": {
"displayName": "BillingProfile1",
"billingRelationshipType": "Direct",
"billTo": {
"companyName": "Contoso",
"firstName": "Test",
"lastName": "User",
"addressLine1": "Test Address1",
"addressLine2": "Test Address2",
"addressLine3": "Test Address3",
"city": "City",
"postalCode": "00000",
"region": "WA",
"country": "US",
"email": "abc@contoso.com",
"phoneNumber": "000-000-0000"
},
"currency": "USD",
"enabledAzurePlans": [
{
"skuId": "0001",
"skuDescription": "Microsoft Azure Plan"
},
{
"skuId": "0002",
"skuDescription": "Microsoft Azure Plan for DevTest"
}
],
"invoiceDay": 5,
"invoiceEmailOptIn": true,
"poNumber": "ABC12345",
"hasReadAccess": true,
"systemId": "1XXX-11XX-XX1-XXXX-XXX",
"status": "Warned",
"statusReasonCode": "PastDue",
"spendingLimit": "On",
"invoiceSections": {
"hasMoreResults": true,
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/invoiceSectionId1",
"name": "invoiceSectionId1",
"type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
"properties": {
"displayName": "invoiceSectionName1",
"labels": {
"pcCode": "A123456",
"costCategory": "Support"
},
"state": "Active",
"systemId": "9XXX-11XX-XX1-XXXX-XXX"
}
}
]
}
}
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001",
"name": "11000000-0000-0000-0000-000000000001",
"type": "Microsoft.Billing/billingAccounts/billingProfiles",
"properties": {
"displayName": "BillingProfile2",
"billingRelationshipType": "IndirectCustomer",
"billTo": {
"companyName": "Contoso",
"firstName": "Test",
"lastName": "User",
"addressLine1": "Test Address1",
"addressLine2": "Test Address2",
"addressLine3": "Test Address3",
"city": "City",
"postalCode": "00000",
"region": "WA",
"country": "US",
"email": "abc@contoso.com",
"phoneNumber": "000-000-0000"
},
"currency": "USD",
"enabledAzurePlans": [
{
"skuId": "0001",
"skuDescription": "Microsoft Azure Plan"
},
{
"skuId": "0002",
"skuDescription": "Microsoft Azure Plan for DevTest"
}
],
"indirectRelationshipInfo": {
"billingAccountName": "30000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000",
"billingProfileName": "33000000-0000-0000-0000-000000000001",
"displayName": "Partner1"
},
"invoiceDay": 5,
"invoiceEmailOptIn": true,
"poNumber": "ABC12345",
"hasReadAccess": true,
"systemId": "2XXX-22XX-XX1-XXXX-XXX",
"status": "Active",
"spendingLimit": "Off",
"invoiceSections": {
"hasMoreResults": true,
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001/invoiceSections/invoiceSectionId2",
"name": "invoiceSectionId2",
"type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
"properties": {
"displayName": "invoiceSectionName2",
"labels": {
"pcCode": "Z223456",
"costCategory": "Marketing"
},
"state": "Active",
"systemId": "9XXX-22XX-XX1-XXXX-XXX"
}
}
]
}
}
}
]
},
"hasReadAccess": true
}
}
Definicje
Nazwa | Opis |
---|---|
Account |
Bieżący stan konta rozliczeniowego. |
Account |
Typ klienta. |
Address |
Szczegóły adresu. |
Agreement |
Typ umowy. |
Azure |
Szczegóły planu platformy Azure. |
Billing |
Konto rozliczeniowe. |
Billing |
Profil rozliczeniowy. |
Billing |
Profile rozliczeniowe skojarzone z kontem rozliczeniowym. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand. |
Billing |
Stan profilu rozliczeniowego. |
Billing |
Określa, które usługi i zakupy są opłacane przez profil rozliczeniowy. |
Department |
Dział. |
Enrollment |
Właściwości rejestracji. |
Enrollment |
Konto rejestracji. |
Enrollment |
Zasady rejestracji Enterprise Agreement. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie. |
Error |
|
Indirect |
Szczegóły profilu rozliczeniowego partnera klienta dla ruchu pośredniego. |
Invoice |
Sekcja faktury. |
Invoice |
Sekcje faktur skojarzone z profilem rozliczeniowym. Domyślnie ta wartość nie jest wypełniana, chyba że jest określona w $expand. |
Invoice |
Określa stan sekcji faktury. |
Spending |
Limit wydatków w profilu rozliczeniowym. |
Status |
Przyczyna określonego stanu profilu rozliczeniowego. |
target |
Identyfikuje środowiska chmury skojarzone z sekcją faktury. Jest to pole opcjonalne zarządzane przez system i jest aktualizowane, ponieważ sekcja faktury jest skojarzona z kontami w różnych chmurach. |
AccountStatus
Bieżący stan konta rozliczeniowego.
Nazwa | Typ | Opis |
---|---|---|
Active |
string |
|
Deleted |
string |
|
Disabled |
string |
|
Expired |
string |
|
Extended |
string |
|
Terminated |
string |
|
Transferred |
string |
AccountType
Typ klienta.
Nazwa | Typ | Opis |
---|---|---|
Enterprise |
string |
|
Individual |
string |
|
Partner |
string |
AddressDetails
Szczegóły adresu.
Nazwa | Typ | Opis |
---|---|---|
addressLine1 |
string |
Wiersz adresu 1. |
addressLine2 |
string |
Wiersz adresu 2. |
addressLine3 |
string |
Wiersz adresu 3. |
city |
string |
Miasto adresów. |
companyName |
string |
Nazwa firmy. |
country |
string |
Kod kraju używa formatu ISO2, 2-cyfrowego. |
district |
string |
Dystrykt adresu. |
string |
Adres e-mail. |
|
firstName |
string |
Imię. |
lastName |
string |
Nazwisko. |
middleName |
string |
Nazwa środkowa. |
phoneNumber |
string |
Numer telefonu. |
postalCode |
string |
Kod pocztowy. |
region |
string |
Region adresu. |
AgreementType
Typ umowy.
Nazwa | Typ | Opis |
---|---|---|
EnterpriseAgreement |
string |
|
MicrosoftCustomerAgreement |
string |
|
MicrosoftOnlineServicesProgram |
string |
|
MicrosoftPartnerAgreement |
string |
AzurePlan
Szczegóły planu platformy Azure.
Nazwa | Typ | Opis |
---|---|---|
skuDescription |
string |
Opis jednostki SKU. |
skuId |
string |
Identyfikator jednostki SKU. |
BillingAccount
Konto rozliczeniowe.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
name |
string |
Nazwa zasobu. |
properties.accountStatus |
Bieżący stan konta rozliczeniowego. |
|
properties.accountType |
Typ klienta. |
|
properties.agreementType |
Typ umowy. |
|
properties.billingProfiles |
Profile rozliczeniowe skojarzone z kontem rozliczeniowym. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand. |
|
properties.departments |
Działy skojarzone z rejestracją. |
|
properties.displayName |
string |
Nazwa konta rozliczeniowego. |
properties.enrollmentAccounts |
Konta skojarzone z rejestracją. |
|
properties.enrollmentDetails |
Szczegółowe informacje o skojarzonej starszej rejestracji. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand. |
|
properties.hasReadAccess |
boolean |
Wskazuje, czy użytkownik ma dostęp do odczytu do konta rozliczeniowego. |
properties.notificationEmailAddress |
string |
Adres e-mail z powiadomieniem tylko dla starszych kont |
properties.soldTo |
Adres osoby lub organizacji odpowiedzialnej za konto rozliczeniowe. |
|
type |
string |
Typ zasobu. |
BillingProfile
Profil rozliczeniowy.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
name |
string |
Nazwa zasobu. |
properties.billTo |
Adres rozliczeniowy. |
|
properties.billingRelationshipType |
Określa, które usługi i zakupy są opłacane przez profil rozliczeniowy. |
|
properties.currency |
string |
Waluta, w której są naliczane opłaty za profil rozliczeniowy. |
properties.displayName |
string |
Nazwa profilu rozliczeniowego. |
properties.enabledAzurePlans |
Informacje o włączonych planach platformy Azure. |
|
properties.hasReadAccess |
boolean |
Wskazuje, czy użytkownik ma dostęp do odczytu do profilu rozliczeniowego. |
properties.indirectRelationshipInfo |
Identyfikuje profil rozliczeniowy połączony z innym profilem rozliczeniowym w ruchu pośrednim zakupu. |
|
properties.invoiceDay |
integer |
Dzień miesiąca wygenerowania faktury dla profilu rozliczeniowego. |
properties.invoiceEmailOptIn |
boolean |
Flaga kontrolująca, czy faktury dla profilu rozliczeniowego są wysyłane za pośrednictwem poczty e-mail. |
properties.invoiceSections |
Sekcje faktur skojarzone z profilem rozliczeniowym. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand. |
|
properties.poNumber |
string |
Nazwa zamówienia zakupu wyświetlana na fakturach wygenerowanych dla profilu rozliczeniowego. |
properties.spendingLimit |
Limit wydatków profilu rozliczeniowego. |
|
properties.status |
Stan profilu rozliczeniowego. |
|
properties.statusReasonCode |
Przyczyna określonego stanu profilu rozliczeniowego. |
|
properties.systemId |
string |
System wygenerował unikatowy identyfikator profilu rozliczeniowego. |
properties.tags |
object |
Tagi profilów rozliczeniowych. |
properties.targetClouds |
Identyfikuje środowiska chmury skojarzone z profilem rozliczeniowym. Jest to pole opcjonalne zarządzane przez system i jest aktualizowane, ponieważ profil rozliczeniowy jest skojarzony z kontami w różnych chmurach. |
|
type |
string |
Typ zasobu. |
BillingProfilesOnExpand
Profile rozliczeniowe skojarzone z kontem rozliczeniowym. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand.
Nazwa | Typ | Opis |
---|---|---|
hasMoreResults |
boolean |
Wskazuje, czy istnieje więcej profilów rozliczeniowych niż te wymienione w tej kolekcji. Kolekcja zawiera maksymalnie 50 profilów rozliczeniowych. Aby uzyskać wszystkie profile rozliczeniowe, użyj interfejsu API profilów rozliczeniowych listy. |
value |
Profile rozliczeniowe skojarzone z kontem rozliczeniowym. |
BillingProfileStatus
Stan profilu rozliczeniowego.
Nazwa | Typ | Opis |
---|---|---|
Active |
string |
|
Disabled |
string |
|
Warned |
string |
BillingRelationshipType
Określa, które usługi i zakupy są opłacane przez profil rozliczeniowy.
Nazwa | Typ | Opis |
---|---|---|
CSPPartner |
string |
|
Direct |
string |
|
IndirectCustomer |
string |
|
IndirectPartner |
string |
Department
Dział.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
name |
string |
Nazwa zasobu. |
properties.costCenter |
string |
Centrum kosztów skojarzone z działem. |
properties.departmentName |
string |
Nazwa działu. |
properties.enrollmentAccounts |
Skojarzone konta rejestracji. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand. |
|
properties.status |
string |
Stan działu. |
type |
string |
Typ zasobu. |
Enrollment
Właściwości rejestracji.
Nazwa | Typ | Opis |
---|---|---|
billingCycle |
string |
Cykl rozliczeniowy rejestracji. |
channel |
string |
Typ kanału rejestracji. |
countryCode |
string |
Kod kraju rejestracji. |
currency |
string |
Waluta rozliczeń dla rejestracji. |
endDate |
string |
Data zakończenia rejestracji. |
language |
string |
Język rejestracji. |
policies |
Zasady rejestracji Enterprise Agreement. |
|
startDate |
string |
Data rozpoczęcia rejestracji. |
status |
string |
Bieżący stan rejestracji. |
EnrollmentAccount
Konto rejestracji.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
name |
string |
Nazwa zasobu. |
properties.accountName |
string |
Nazwa konta rejestracji. |
properties.accountOwner |
string |
Właściciel konta rejestracji. |
properties.accountOwnerEmail |
string |
Adres e-mail właściciela konta rejestracji. |
properties.costCenter |
string |
Centrum kosztów skojarzone z kontem rejestracji. |
properties.department |
Skojarzony dział. Domyślnie ta opcja nie jest wypełniana, chyba że jest określona w $expand. |
|
properties.endDate |
string |
Data zakończenia konta rejestracji. |
properties.startDate |
string |
Data rozpoczęcia konta rejestracji. |
properties.status |
string |
Stan konta rejestracji. |
type |
string |
Typ zasobu. |
EnrollmentPolicies
Zasady rejestracji Enterprise Agreement.
Nazwa | Typ | Opis |
---|---|---|
accountOwnerViewCharges |
boolean |
Zasady kontrolujące, czy właściciele kont mogą wyświetlać opłaty. |
departmentAdminViewCharges |
boolean |
Zasady kontrolujące, czy administratorzy działu mogą wyświetlać opłaty. |
marketplaceEnabled |
boolean |
Zasady kontrolujące, czy zakupy w witrynie Azure Marketplace są dozwolone w rejestracji. |
reservedInstancesEnabled |
boolean |
Zasady kontrolujące, czy zakupy rezerwacji platformy Azure są dozwolone w rejestracji. |
ErrorDetails
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
details |
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 |
Szczegóły błędu. |
ErrorSubDetails
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. |
IndirectRelationshipInfo
Szczegóły profilu rozliczeniowego partnera klienta dla ruchu pośredniego.
Nazwa | Typ | Opis |
---|---|---|
billingAccountName |
string |
Nazwa konta rozliczeniowego partnera lub klienta dla ruchu pośredniego. |
billingProfileName |
string |
Nazwa profilu rozliczeniowego partnera lub klienta dla ruchu pośredniego. |
displayName |
string |
Nazwa wyświetlana partnera lub klienta dla ruchu pośredniego. |
InvoiceSection
Sekcja faktury.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
name |
string |
Nazwa zasobu. |
properties.displayName |
string |
Nazwa sekcji faktury. |
properties.labels |
object |
Słownik metadanych skojarzonych z sekcją faktury. |
properties.state |
Określa stan sekcji faktury. |
|
properties.systemId |
string |
System wygenerował unikatowy identyfikator sekcji faktury. |
properties.tags |
object |
Słownik metadanych skojarzonych z sekcją faktury. Maksymalna długość klucza/wartości obsługiwana przez 256 znaków. Klucze/wartość nie powinny być puste ani mieć wartości null. Klucze nie mogą zawierać <> % & \ ? / |
properties.targetCloud |
Identyfikuje środowiska chmury skojarzone z sekcją faktury. Jest to pole opcjonalne zarządzane przez system i jest aktualizowane, ponieważ sekcja faktury jest skojarzona z kontami w różnych chmurach. |
|
type |
string |
Typ zasobu. |
InvoiceSectionsOnExpand
Sekcje faktur skojarzone z profilem rozliczeniowym. Domyślnie ta wartość nie jest wypełniana, chyba że jest określona w $expand.
Nazwa | Typ | Opis |
---|---|---|
hasMoreResults |
boolean |
Wskazuje, czy w tej kolekcji znajduje się więcej sekcji faktur niż te wymienione w tej kolekcji. Kolekcja zawiera maksymalnie 50 sekcji faktur. Aby uzyskać wszystkie sekcje faktur, użyj interfejsu API sekcji faktur listy. |
value |
Sekcje faktur skojarzone z profilem rozliczeniowym. |
InvoiceSectionState
Określa stan sekcji faktury.
Nazwa | Typ | Opis |
---|---|---|
Active |
string |
|
Restricted |
string |
SpendingLimit
Limit wydatków w profilu rozliczeniowym.
Nazwa | Typ | Opis |
---|---|---|
Off |
string |
|
On |
string |
StatusReasonCode
Przyczyna określonego stanu profilu rozliczeniowego.
Nazwa | Typ | Opis |
---|---|---|
PastDue |
string |
|
SpendingLimitExpired |
string |
|
SpendingLimitReached |
string |
targetCloud
Identyfikuje środowiska chmury skojarzone z sekcją faktury. Jest to pole opcjonalne zarządzane przez system i jest aktualizowane, ponieważ sekcja faktury jest skojarzona z kontami w różnych chmurach.
Nazwa | Typ | Opis |
---|---|---|
USGov |
string |
|
USNat |
string |
|
USSec |
string |