Поделиться через


Billing Accounts - List

Выводит список учетных записей выставления счетов, к которым у пользователя есть доступ.

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}

Параметры URI

Имя В Обязательно Тип Описание
api-version
query True

string

Версия API, используемая с клиентским запросом. Текущая версия — 2024-04-01.

expand
query

string

Расширение разрешено для SoldTo и EnrollmentDetails/PONumber.

filter
query

string

Параметр запроса фильтра позволяет клиентам фильтровать коллекцию ресурсов, адресованных URL-адресом запроса.

includeAll
query

boolean

Если задано значение true, результаты включают учетные записи выставления счетов, на которые у пользователя нет прямого назначения ролей, если у пользователя есть одна из следующих ролей AAD: глобальный администратор, глобальный читатель, администратор выставления счетов.

includeAllWithoutBillingProfiles
query

boolean

Если задано значение true, результаты будут включать учетные записи выставления счетов, которые не полностью созданы, если у пользователя есть одна из следующих ролей AAD: глобальный администратор, глобальный читатель, администратор выставления счетов.

includeDeleted
query

boolean

Если значение равно true, результаты будут содержать все учетные записи выставления счетов в удаленном состоянии.

includePendingAgreement
query

boolean

Включает учетные записи выставления счетов с ожидающей подписью соглашения, к которому у пользователя есть доступ.

includeResellee
query

boolean

Включает учетную запись выставления счетов клиента соглашения с партнером Майкрософт, к которому у пользователя есть доступ.

legalOwnerOID
query

string

Необходимо объединить с legalOwnerTID, результаты будут включать только учетные записи выставления счетов, для которых юридически отвечает за учетные записи выставления счетов. Необязательный.

legalOwnerTID
query

string

Необходимо объединить с legalOwnerOID, результаты будут включать только учетные записи выставления счетов, для которых юридически отвечает за учетные записи выставления счетов. Необязательный.

search
query

string

Параметр запроса поиска позволяет клиентам запрашивать элементы в коллекции, соответствующее выражению свободного текста. поиск поддерживается только для строковых полей.

skip
query

integer

int64

Параметр пропуска запроса запрашивает количество элементов в запрашиваемой коллекции, которые должны быть пропущены и не включены в результат.

top
query

integer

int64

Верхний параметр запроса запрашивает количество элементов в запрашиваемой коллекции, которые будут включены в результат. Максимальное поддерживаемое значение для верхней части — 50.

Ответы

Имя Тип Описание
200 OK

BillingAccountListResult

Список учетных записей выставления счетов.

Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Примеры

BillingAccountForLegacyAccountDetails
BillingAccountsList
BillingAccountsListWithExpandForPONumber

BillingAccountForLegacyAccountDetails

Образец запроса

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

Пример ответа

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

Образец запроса

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

Пример ответа

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

Образец запроса

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

Пример ответа

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

Определения

Имя Описание
AccountStatus

Текущее состояние учетной записи выставления счетов.

AccountSubType

Уровень учетной записи.

AccountType

Тип клиента.

AgreementType

Тип соглашения.

BillingAccount

Учетная запись выставления счетов.

BillingAccountListResult

Контейнер для списка ресурсов

BillingAccountProperties

Учетная запись выставления счетов.

BillingAccountStatusReasonCode

Причина указанного состояния учетной записи выставления счетов.

BillingRelationshipType

Определяет связи выставления счетов, представленные учетной записью выставления счетов. Связь с выставлением счетов может быть между корпорацией Майкрософт, клиентом и /или сторонним поставщиком.

createdByType

Тип удостоверения, создавшего ресурс.

EnrollmentDetails

Свойства регистрации.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Ответ на ошибку

ExtendedTermOption

Расширение учетной записи выставления счетов, предоставленное компанией.

IndirectRelationshipInfo

Определяет профиль выставления счетов, связанный с другим профилем выставления счетов в непрямом движении покупки.

MarkupStatus

Состояние регистрации разметки, применимое только для косвенных регистраций.

ProvisioningState

Состояние подготовки ресурса во время длительной операции.

RegistrationNumber

Описывает номер регистрации организации, связанной с учетной записью выставления счетов.

SoldTo

Адрес лица или организации, ответственной за учетную запись выставления счетов.

SupportLevel

Предложение уровня поддержки, связанное с регистрацией.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

TaxIdentifier

Идентификатор налога для учетной записи выставления счетов.

TaxIdentifierStatus

Состояние идентификатора налога.

TaxIdentifierType

Тип идентификатора налога.

AccountStatus

Текущее состояние учетной записи выставления счетов.

Имя Тип Описание
Active

string

Deleted

string

Disabled

string

Expired

string

Extended

string

New

string

Other

string

Pending

string

Terminated

string

Transferred

string

UnderReview

string

AccountSubType

Уровень учетной записи.

Имя Тип Описание
Enterprise

string

Individual

string

None

string

Other

string

Professional

string

AccountType

Тип клиента.

Имя Тип Описание
Business

string

ClassicPartner

string

Enterprise

string

Individual

string

Internal

string

Other

string

Partner

string

Reseller

string

Tenant

string

AgreementType

Тип соглашения.

Имя Тип Описание
EnterpriseAgreement

string

MicrosoftCustomerAgreement

string

MicrosoftOnlineServicesProgram

string

MicrosoftPartnerAgreement

string

Other

string

BillingAccount

Учетная запись выставления счетов.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Имя ресурса

properties

BillingAccountProperties

Учетная запись выставления счетов.

systemData

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.

tags

object

Словарь метаданных, связанных с ресурсом. Он не может быть заполнен для всех типов ресурсов. Максимальная длина ключа и значения, поддерживаемая 256 символами. Ключи или значение не должны пустыми значениями и значениями NULL. Ключи не могут содержать <> % & \ ? /

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

BillingAccountListResult

Контейнер для списка ресурсов

Имя Тип Описание
nextLink

string

Ссылка (URL-адрес) на следующую страницу результатов.

value

BillingAccount[]

Список ресурсов.

BillingAccountProperties

Учетная запись выставления счетов.

Имя Тип Описание
accountStatus

AccountStatus

Текущее состояние учетной записи выставления счетов.

accountStatusReasonCode

BillingAccountStatusReasonCode

Причина указанного состояния учетной записи выставления счетов.

accountSubType

AccountSubType

Уровень учетной записи.

accountType

AccountType

Тип клиента.

agreementType

AgreementType

Тип соглашения.

billingRelationshipTypes

BillingRelationshipType[]

Определяет связи выставления счетов, представленные учетной записью выставления счетов. Связь с выставлением счетов может быть между корпорацией Майкрософт, клиентом и /или сторонним поставщиком.

displayName

string

Имя учетной записи выставления счетов.

enrollmentDetails

EnrollmentDetails

Свойства регистрации.

hasNoBillingProfiles

boolean

Указывает, имеет ли учетная запись выставления счетов какие-либо профили выставления счетов.

hasReadAccess

boolean

Указывает, имеет ли пользователь доступ на чтение к учетной записи выставления счетов.

notificationEmailAddress

string

Адрес электронной почты уведомления для устаревшей учетной записи. Доступно для типа соглашения Microsoft Online Services Program.

primaryBillingTenantId

string

Клиент, который использовался для настройки учетной записи выставления счетов. По умолчанию только пользователи из этого клиента могут получать назначения ролей в учетной записи выставления счетов, а все покупки подготавливаются в этом клиенте.

provisioningState

ProvisioningState

Состояние подготовки ресурса во время длительной операции.

qualifications

string[]

Квалификация по ценам на учетную запись выставления счетов. Значения могут быть коммерческими, образовательными, благотворительным или государственными.

registrationNumber

RegistrationNumber

Описывает номер регистрации организации, связанной с учетной записью выставления счетов.

soldTo

SoldTo

Адрес лица или организации, ответственной за учетную запись выставления счетов.

taxIds

TaxIdentifier[]

Список идентификаторов налогов для учетной записи выставления счетов.

BillingAccountStatusReasonCode

Причина указанного состояния учетной записи выставления счетов.

Имя Тип Описание
Expired

string

ManuallyTerminated

string

Other

string

TerminateProcessing

string

Transferred

string

UnusualActivity

string

BillingRelationshipType

Определяет связи выставления счетов, представленные учетной записью выставления счетов. Связь с выставлением счетов может быть между корпорацией Майкрософт, клиентом и /или сторонним поставщиком.

Имя Тип Описание
CSPCustomer

string

CSPPartner

string

Direct

string

IndirectCustomer

string

IndirectPartner

string

Other

string

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

EnrollmentDetails

Свойства регистрации.

Имя Тип Описание
billingCycle

string

Цикл выставления счетов для регистрации.

channel

string

Тип канала регистрации.

cloud

string

Облако регистрации.

countryCode

string

Код страны регистрации.

currency

string

Валюта выставления счетов для регистрации.

endDate

string

Дата окончания регистрации.

extendedTermOption

ExtendedTermOption

Расширение учетной записи выставления счетов, предоставленное компанией.

indirectRelationshipInfo

IndirectRelationshipInfo

Свойства регистрации, применимые только для косвенных регистраций.

invoiceRecipient

string

Контакт, получающий счета регистрации.

language

string

Язык регистрации.

markupStatus

MarkupStatus

Состояние регистрации разметки, применимое только для косвенных регистраций.

poNumber

string

Номер заказа на покупку регистрации.

startDate

string

Дата начала регистрации.

supportCoverage

string

Период покрытия поддержки для регистрации.

supportLevel

SupportLevel

Предложение уровня поддержки, связанное с регистрацией.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

ExtendedTermOption

Расширение учетной записи выставления счетов, предоставленное компанией.

Имя Тип Описание
Opted-In

string

Opted-Out

string

Other

string

IndirectRelationshipInfo

Определяет профиль выставления счетов, связанный с другим профилем выставления счетов в непрямом движении покупки.

Имя Тип Описание
billingAccountName

string

Имя учетной записи выставления счетов партнера или клиента для косвенного перемещения.

billingProfileName

string

Имя профиля выставления счетов партнера или клиента для косвенного перемещения.

displayName

string

Отображаемое имя партнера или клиента для косвенного движения.

MarkupStatus

Состояние регистрации разметки, применимое только для косвенных регистраций.

Имя Тип Описание
Disabled

string

Locked

string

Other

string

Preview

string

Published

string

ProvisioningState

Состояние подготовки ресурса во время длительной операции.

Имя Тип Описание
Canceled

string

Failed

string

New

string

Pending

string

Provisioning

string

Succeeded

string

RegistrationNumber

Описывает номер регистрации организации, связанной с учетной записью выставления счетов.

Имя Тип Описание
id

string

Уникальный идентификационный номер организации, связанной с учетной записью выставления счетов.

required

boolean

Определяет, требуется ли номер регистрации для учетной записи выставления счетов.

type

string[]

Типы регистрационных номеров, разрешенных в зависимости от страны учетной записи выставления счетов.

SoldTo

Адрес лица или организации, ответственной за учетную запись выставления счетов.

Имя Тип Описание
addressLine1

string

Адресная строка 1.

addressLine2

string

Адресная строка 2.

addressLine3

string

Адресная строка 3.

city

string

Адрес города.

companyName

string

Название компании. Необязательно для MCA Individual (оплата по мере использования).

country

string

Код страны использует формат ISO 3166-1 Alpha-2.

district

string

Адресный район.

email

string

Адрес электронной почты.

firstName

string

Имя. Необязательно для MCA Enterprise.

isValidAddress

boolean

Указывает, является ли адрес неполным.

lastName

string

Фамилия. Необязательно для MCA Enterprise.

middleName

string

По промежуточному имени.

phoneNumber

string

Номер телефона.

postalCode

string

Почтовый индекс.

region

string

Адресная область.

SupportLevel

Предложение уровня поддержки, связанное с регистрацией.

Имя Тип Описание
Developer

string

Other

string

Pro-Direct

string

Standard

string

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.

lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.

TaxIdentifier

Идентификатор налога для учетной записи выставления счетов.

Имя Тип Описание
country

string

Страна идентификатора налога.

id

string

Идентификатор идентификатора налога.

scope

string

Область идентификатора налога.

status

TaxIdentifierStatus

Состояние идентификатора налога.

type

TaxIdentifierType

Тип идентификатора налога.

TaxIdentifierStatus

Состояние идентификатора налога.

Имя Тип Описание
Invalid

string

Other

string

Valid

string

TaxIdentifierType

Тип идентификатора налога.

Имя Тип Описание
BrazilCcmId

string

BrazilCnpjId

string

BrazilCpfId

string

CanadianFederalExempt

string

CanadianProvinceExempt

string

ExternalTaxation

string

IndiaFederalServiceTaxId

string

IndiaFederalTanId

string

IndiaPanId

string

IndiaStateCstId

string

IndiaStateGstINId

string

IndiaStateVatId

string

IntlExempt

string

LoveCode

string

MobileBarCode

string

NationalIdentificationNumber

string

Other

string

PublicSectorId

string

USExempt

string

VatId

string