Udostępnij za pośrednictwem


Billing Accounts - List

Wyświetla listę kont rozliczeniowych, do których użytkownik ma dostęp.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?includeAll={includeAll}&includeAllWithoutBillingProfiles={includeAllWithoutBillingProfiles}&includeDeleted={includeDeleted}&includePendingAgreement={includePendingAgreement}&includeResellee={includeResellee}&legalOwnerTID={legalOwnerTID}&legalOwnerOID={legalOwnerOID}&api-version=2024-04-01&filter={filter}&expand={expand}&top={top}&skip={skip}&search={search}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
api-version
query True

string

Wersja interfejsu API, która ma być używana z żądaniem klienta. Bieżąca wersja to 2024-04-01.

expand
query

string

Rozszerzenie jest dozwolone dla kolumn SoldTo i EnrollmentDetails/PONumber.

filter
query

string

Opcja zapytania filtru umożliwia klientom filtrowanie kolekcji zasobów, które są adresowane przez adres URL żądania.

includeAll
query

boolean

Jeśli to prawda, wyniki będą zawierać konta rozliczeniowe, na których użytkownik nie ma bezpośredniego przypisania roli, jeśli użytkownik ma jedną z następujących ról usługi AAD: Administrator globalny, Czytelnik globalny, Administrator rozliczeń.

includeAllWithoutBillingProfiles
query

boolean

W przypadku wartości true wyniki będą obejmować konta rozliczeniowe, które nie są w pełni utworzone, jeśli użytkownik ma jedną z następujących ról usługi AAD: Administrator globalny, Czytelnik globalny, Administrator rozliczeń.

includeDeleted
query

boolean

W przypadku wartości true wyniki będą zawierać wszystkie konta rozliczeniowe w stanie usuniętym.

includePendingAgreement
query

boolean

Obejmuje konta rozliczeniowe z umową oczekującą na podpis, do którego użytkownik ma dostęp.

includeResellee
query

boolean

Obejmuje konto rozliczeniowe klienta umowy Microsoft Partner Agreement, do którego użytkownik ma dostęp.

legalOwnerOID
query

string

Muszą być łączone z prawemOwnerTID, wyniki będą obejmować tylko konta rozliczeniowe, dla których są prawnie odpowiedzialne za konta rozliczeniowe. Fakultatywny.

legalOwnerTID
query

string

Muszą być połączone z legalOwnerOID, wyniki będą obejmować tylko konta rozliczeniowe, dla których są prawnie odpowiedzialne za konta rozliczeniowe. Fakultatywny.

search
query

string

Opcja kwerendy wyszukiwania umożliwia klientom żądanie elementów w kolekcji zgodnej z wyrażeniem wyszukiwania w tekście. wyszukiwanie jest obsługiwane tylko w przypadku pól ciągów.

skip
query

integer (int64)

Opcja pomiń zapytanie żąda liczby elementów w kolekcji zapytań, które mają zostać pominięte i nie zostaną uwzględnione w wyniku.

top
query

integer (int64)

Opcja zapytania najwyższego poziomu żąda liczby elementów w kolekcji zapytań, które mają zostać uwzględnione w wyniku. Maksymalna obsługiwana wartość dla góry to 50.

Odpowiedzi

Nazwa Typ Opis
200 OK

BillingAccountListResult

Lista kont rozliczeniowych.

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

BillingAccountForLegacyAccountDetails
BillingAccountsList
BillingAccountsListWithExpandForPONumber

BillingAccountForLegacyAccountDetails

Przykładowe żądanie

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01

Przykładowa odpowiedź

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001",
      "name": "20000000-0000-0000-0000-000000000001",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Individual",
        "agreementType": "MicrosoftOnlineServicesProgram",
        "displayName": "Individual Account 2",
        "hasReadAccess": true,
        "notificationEmailAddress": "individual@domain.com"
      },
      "type": "Microsoft.Billing/billingAccounts"
    }
  ]
}

BillingAccountsList

Przykładowe żądanie

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01

Przykładowa odpowiedź

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Business",
        "accountSubType": "Enterprise",
        "agreementType": "MicrosoftCustomerAgreement",
        "displayName": "Premier Business Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "type": "Microsoft.Billing/billingAccounts",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "name": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Business",
        "accountSubType": "Professional",
        "agreementType": "MicrosoftCustomerAgreement",
        "displayName": "Standard Business Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "type": "Microsoft.Billing/billingAccounts",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "name": "30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Individual",
        "accountSubType": "Individual",
        "agreementType": "MicrosoftCustomerAgreement",
        "displayName": "Individual Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "type": "Microsoft.Billing/billingAccounts",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "name": "40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Business",
        "accountSubType": "Enterprise",
        "agreementType": "MicrosoftPartnerAgreement",
        "displayName": "Premier Business Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "type": "Microsoft.Billing/billingAccounts",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    }
  ]
}

BillingAccountsListWithExpandForPONumber

Przykładowe żądanie

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01&expand=soldTo,enrollmentDetails/poNumber

Przykładowa odpowiedź

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/6564892",
      "name": "6564892",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Enterprise",
        "accountSubType": "None",
        "agreementType": "EnterpriseAgreement",
        "displayName": "Enterprise Account",
        "enrollmentDetails": {
          "startDate": "2018-05-01T17:32:28Z",
          "endDate": "2019-05-31T17:32:28Z",
          "currency": "USD",
          "channel": "EaDirect",
          "language": "en",
          "countryCode": "US",
          "billingCycle": "Monthly",
          "extendedTermOption": "Opted-Out",
          "supportLevel": "Standard",
          "supportCoverage": "1/26/2021 - 6/30/2021",
          "cloud": "Azure Commercial",
          "poNumber": "poNumber123"
        },
        "hasReadAccess": true,
        "soldTo": {
          "addressLine1": "Test Address",
          "city": "City",
          "companyName": "Enterprise Company",
          "country": "US",
          "postalCode": "00000-1111",
          "region": "WA"
        }
      },
      "type": "Microsoft.Billing/billingAccounts",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    }
  ]
}

Definicje

Nazwa Opis
AccountStatus

Bieżący stan konta rozliczeniowego.

AccountSubType

Warstwa konta.

AccountType

Typ klienta.

AgreementType

Typ umowy.

BillingAccount

Konto rozliczeniowe.

BillingAccountListResult

Kontener dla listy zasobów

BillingAccountProperties

Konto rozliczeniowe.

BillingAccountStatusReasonCode

Przyczyna określonego stanu konta rozliczeniowego.

BillingRelationshipType

Identyfikuje relacje rozliczeń reprezentowane przez konto rozliczeniowe. Relacja rozliczeń może być między firmą Microsoft, klientem i/lub inną firmą.

createdByType

Typ tożsamości, która utworzyła zasób.

EnrollmentDetails

Właściwości rejestracji.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

ExtendedTermOption

Rozszerzenie konta rozliczeniowego zdecydowało się na firmę.

IndirectRelationshipInfo

Identyfikuje profil rozliczeniowy połączony z innym profilem rozliczeniowym w ramach pośredniego ruchu zakupu.

MarkupStatus

Stan znaczników rejestracji, dotyczy tylko rejestracji pośrednich.

ProvisioningState

Stan aprowizacji zasobu podczas długotrwałej operacji.

RegistrationNumber

Opisuje numer rejestracji organizacji połączonej z kontem rozliczeniowym.

SoldTo

Adres osoby lub organizacji odpowiedzialnej za konto rozliczeniowe.

SupportLevel

Oferta poziomu pomocy technicznej skojarzona z rejestracją.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

TaxIdentifier

Identyfikator podatkowy dla konta rozliczeniowego.

TaxIdentifierStatus

Stan identyfikatora podatkowego.

TaxIdentifierType

Typ identyfikatora podatkowego.

AccountStatus

Bieżący stan konta rozliczeniowego.

Wartość Opis
Active
Deleted
Disabled
Expired
Extended
New
Other
Pending
Terminated
Transferred
UnderReview

AccountSubType

Warstwa konta.

Wartość Opis
Enterprise
Individual
None
Other
Professional

AccountType

Typ klienta.

Wartość Opis
Business
ClassicPartner
Enterprise
Individual
Internal
Other
Partner
Reseller
Tenant

AgreementType

Typ umowy.

Wartość Opis
EnterpriseAgreement
MicrosoftCustomerAgreement
MicrosoftOnlineServicesProgram
MicrosoftPartnerAgreement
Other

BillingAccount

Konto rozliczeniowe.

Nazwa Typ Opis
id

string (arm-id)

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Nazwa zasobu

properties

BillingAccountProperties

Konto rozliczeniowe.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

tags

object

Słownik metadanych skojarzonych z zasobem. Nie można go wypełnić dla wszystkich typów zasobów. 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ć <> % & \ ? /

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

BillingAccountListResult

Kontener dla listy zasobów

Nazwa Typ Opis
nextLink

string

Link (adres URL) do następnej strony wyników.

value

BillingAccount[]

Lista zasobów.

BillingAccountProperties

Konto rozliczeniowe.

Nazwa Typ Opis
accountStatus

AccountStatus

Bieżący stan konta rozliczeniowego.

accountStatusReasonCode

BillingAccountStatusReasonCode

Przyczyna określonego stanu konta rozliczeniowego.

accountSubType

AccountSubType

Warstwa konta.

accountType

AccountType

Typ klienta.

agreementType

AgreementType

Typ umowy.

billingRelationshipTypes

BillingRelationshipType[]

Identyfikuje relacje rozliczeń reprezentowane przez konto rozliczeniowe. Relacja rozliczeń może być między firmą Microsoft, klientem i/lub inną firmą.

displayName

string

Nazwa konta rozliczeniowego.

enrollmentDetails

EnrollmentDetails

Właściwości rejestracji.

hasNoBillingProfiles

boolean

Wskazuje, czy konto rozliczeniowe ma jakiekolwiek profile rozliczeniowe.

hasReadAccess

boolean

Wskazuje, czy użytkownik ma dostęp do odczytu do konta rozliczeniowego.

notificationEmailAddress

string

Adres e-mail powiadomienia dla starszego konta. Dostępny dla typu umowy Microsoft Online Services Program.

primaryBillingTenantId

string

Dzierżawa, która została użyta do skonfigurowania konta rozliczeniowego. Domyślnie tylko użytkownicy z tej dzierżawy mogą uzyskiwać przypisania ról na koncie rozliczeniowym, a wszystkie zakupy są aprowizowane w tej dzierżawie.

provisioningState

ProvisioningState

Stan aprowizacji zasobu podczas długotrwałej operacji.

qualifications

string[]

Kwalifikacje dotyczące cen na koncie rozliczeniowym. Wartości mogą być komercyjne, edukacyjne, charytatywne lub rządowe.

registrationNumber

RegistrationNumber

Opisuje numer rejestracji organizacji połączonej z kontem rozliczeniowym.

soldTo

SoldTo

Adres osoby lub organizacji odpowiedzialnej za konto rozliczeniowe.

taxIds

TaxIdentifier[]

Lista identyfikatorów podatkowych dla konta rozliczeniowego.

BillingAccountStatusReasonCode

Przyczyna określonego stanu konta rozliczeniowego.

Wartość Opis
Expired
ManuallyTerminated
Other
TerminateProcessing
Transferred
UnusualActivity

BillingRelationshipType

Identyfikuje relacje rozliczeń reprezentowane przez konto rozliczeniowe. Relacja rozliczeń może być między firmą Microsoft, klientem i/lub inną firmą.

Wartość Opis
CSPCustomer
CSPPartner
Direct
IndirectCustomer
IndirectPartner
Other

createdByType

Typ tożsamości, która utworzyła zasób.

Wartość Opis
Application
Key
ManagedIdentity
User

EnrollmentDetails

Właściwości rejestracji.

Nazwa Typ Opis
billingCycle

string

Cykl rozliczeniowy rejestracji.

channel

string

Typ kanału rejestracji.

cloud

string

Chmura rejestracji.

countryCode

string

Kod kraju rejestracji.

currency

string

Waluta rozliczeniowa dla rejestracji.

endDate

string (date-time)

Data zakończenia rejestracji.

extendedTermOption

ExtendedTermOption

Rozszerzenie konta rozliczeniowego zdecydowało się na firmę.

indirectRelationshipInfo

IndirectRelationshipInfo

Właściwości rejestracji, które mają zastosowanie tylko w przypadku rejestracji pośrednich.

invoiceRecipient

string

Kontakt, który otrzymuje faktury rejestracji.

language

string

Język rejestracji.

markupStatus

MarkupStatus

Stan znaczników rejestracji, dotyczy tylko rejestracji pośrednich.

poNumber

string

Numer zamówienia zakupu rejestracji.

startDate

string (date-time)

Data rozpoczęcia rejestracji.

supportCoverage

string

Okres pokrycia pomocy technicznej dla rejestracji.

supportLevel

SupportLevel

Oferta poziomu pomocy technicznej skojarzona z rejestracją.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

ExtendedTermOption

Rozszerzenie konta rozliczeniowego zdecydowało się na firmę.

Wartość Opis
Opted-In
Opted-Out
Other

IndirectRelationshipInfo

Identyfikuje profil rozliczeniowy połączony z innym profilem rozliczeniowym w ramach pośredniego ruchu zakupu.

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.

MarkupStatus

Stan znaczników rejestracji, dotyczy tylko rejestracji pośrednich.

Wartość Opis
Disabled
Locked
Other
Preview
Published

ProvisioningState

Stan aprowizacji zasobu podczas długotrwałej operacji.

Wartość Opis
Canceled
Failed
New
Pending
Provisioning
Succeeded

RegistrationNumber

Opisuje numer rejestracji organizacji połączonej z kontem rozliczeniowym.

Nazwa Typ Opis
id

string

Unikatowy numer identyfikacyjny organizacji połączonej z kontem rozliczeniowym.

required

boolean

Określa, czy numer rejestracji jest wymagany dla konta rozliczeniowego.

type

string[]

Typy dozwolonych numerów rejestracji na podstawie kraju konta rozliczeniowego.

SoldTo

Adres osoby lub organizacji odpowiedzialnej za konto rozliczeniowe.

Nazwa Typ Opis
addressLine1

string

minLength: 1

Wiersz adresu 1.

addressLine2

string

Wiersz adresu 2.

addressLine3

string

Wiersz adresu 3.

city

string

Miasto adresowe.

companyName

string

Nazwa firmy. Opcjonalnie dla indywidualnej umowy MCA (płatność zgodnie z rzeczywistym użyciem).

country

string

minLength: 1

Kod kraju używa formatu ISO 3166-1 Alpha-2.

district

string

Dystrykt adresu.

email

string

Adres e-mail.

firstName

string

Imię. Opcjonalnie dla umowy MCA Enterprise.

isValidAddress

boolean

Wskazuje, czy adres jest niekompletny.

lastName

string

Nazwisko. Opcjonalnie dla umowy MCA Enterprise.

middleName

string

Imię i nazwisko.

phoneNumber

string

Numer.

postalCode

string

Kod pocztowy.

region

string

Region adresu.

SupportLevel

Oferta poziomu pomocy technicznej skojarzona z rejestracją.

Wartość Opis
Developer
Other
Pro-Direct
Standard

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string (date-time)

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string (date-time)

Znacznik czasu ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

TaxIdentifier

Identyfikator podatkowy dla konta rozliczeniowego.

Nazwa Typ Opis
country

string

Kraj identyfikatora podatkowego.

id

string

Identyfikator nip.

scope

string

Zakres identyfikatora podatkowego.

status

TaxIdentifierStatus

Stan identyfikatora podatkowego.

type

TaxIdentifierType

Typ identyfikatora podatkowego.

TaxIdentifierStatus

Stan identyfikatora podatkowego.

Wartość Opis
Invalid
Other
Valid

TaxIdentifierType

Typ identyfikatora podatkowego.

Wartość Opis
BrazilCcmId
BrazilCnpjId
BrazilCpfId
CanadianFederalExempt
CanadianProvinceExempt
ExternalTaxation
IndiaFederalServiceTaxId
IndiaFederalTanId
IndiaPanId
IndiaStateCstId
IndiaStateGstINId
IndiaStateVatId
IntlExempt
LoveCode
MobileBarCode
NationalIdentificationNumber
Other
PublicSectorId
USExempt
VatId