Billing Accounts - List
Lista as contas de cobrança às quais um usuário tem acesso.
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}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
A versão da API a ser usada com a solicitação do cliente. A versão atual é 2024-04-01. |
expand
|
query |
string |
Expanda é permitido para SoldTo e EnrollmentDetails/PONumber. |
|
filter
|
query |
string |
A opção de consulta de filtro permite que os clientes filtrem uma coleção de recursos que são endereçados por uma URL de solicitação. |
|
include
|
query |
boolean |
Quando verdadeiro, os resultados incluirão contas de cobrança nas quais o usuário não tem uma atribuição de função direta se o usuário tiver uma das seguintes funções do AAD: Administrador Global, Leitor Global, Administrador de Cobrança. |
|
include
|
query |
boolean |
Quando verdadeiro, os resultados incluirão contas de cobrança que não são totalmente criadas se o usuário tiver uma das seguintes funções do AAD: Administrador Global, Leitor Global, Administrador de Cobrança. |
|
include
|
query |
boolean |
Quando verdadeiro, os resultados incluirão quaisquer contas de cobrança em um estado excluído. |
|
include
|
query |
boolean |
Inclui contas de cobrança com assinatura pendente de contrato à qual o usuário tem acesso. |
|
include
|
query |
boolean |
Inclui a conta de cobrança do cliente do Contrato de Parceiro da Microsoft ao qual o usuário tem acesso. |
|
legal
|
query |
string |
Deve ser combinado com legalOwnerTID, os resultados incluirão apenas contas de cobrança para quem é legalmente responsável pelas Contas de Cobrança. Opcional. |
|
legal
|
query |
string |
Deve ser combinado com legalOwnerOID, os resultados incluirão apenas contas de cobrança para quem é legalmente responsável pelas Contas de Cobrança. Opcional. |
|
search
|
query |
string |
A opção de consulta de pesquisa permite que os clientes solicitem itens em uma coleção que corresponda a uma expressão de pesquisa de texto livre. A pesquisa só tem suporte para campos de cadeia de caracteres. |
|
skip
|
query |
integer int64 |
A opção ignorar consulta solicita o número de itens na coleção consultada que devem ser ignorados e não incluídos no resultado. |
|
top
|
query |
integer int64 |
A opção de consulta superior solicita que o número de itens na coleção consultada seja incluído no resultado. O valor máximo com suporte para a parte superior é 50. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A lista de contas de cobrança. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Exemplos
Billing |
Billing |
Billing |
BillingAccountForLegacyAccountDetails
Solicitação de exemplo
Resposta de exemplo
{
"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
Solicitação de exemplo
Resposta de exemplo
{
"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
Solicitação de exemplo
Resposta de exemplo
{
"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"
}
}
]
}
Definições
Nome | Description |
---|---|
Account |
O status atual da conta de cobrança. |
Account |
A camada da conta. |
Account |
O tipo de cliente. |
Agreement |
O tipo de contrato. |
Billing |
Uma conta de cobrança. |
Billing |
Um contêiner para uma lista de recursos |
Billing |
Uma conta de cobrança. |
Billing |
Motivo do status da conta de cobrança especificada. |
Billing |
Identifica as relações de cobrança representadas por uma conta de cobrança. A relação de cobrança pode ser entre a Microsoft, o cliente e/ou terceiros. |
created |
O tipo de identidade que criou o recurso. |
Enrollment |
As propriedades de um registro. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Extended |
A extensão da conta de cobrança aceita pela empresa. |
Indirect |
Identifica o perfil de cobrança vinculado a outro perfil de cobrança no movimento de compra indireto. |
Markup |
Status de marcação do registro, aplicável somente para registros indiretos. |
Provisioning |
O estado de provisionamento do recurso durante uma operação de execução prolongada. |
Registration |
Descreve o número de registro da organização vinculada à conta de cobrança. |
Sold |
O endereço do indivíduo ou organização responsável pela conta de cobrança. |
Support |
A oferta de nível de suporte associada a um registro. |
system |
Metadados relativos à criação e última modificação do recurso. |
Tax |
Um identificador de imposto para a conta de cobrança. |
Tax |
O status do identificador de imposto. |
Tax |
O tipo do identificador de imposto. |
AccountStatus
O status atual da conta de cobrança.
Nome | Tipo | Description |
---|---|---|
Active |
string |
|
Deleted |
string |
|
Disabled |
string |
|
Expired |
string |
|
Extended |
string |
|
New |
string |
|
Other |
string |
|
Pending |
string |
|
Terminated |
string |
|
Transferred |
string |
|
UnderReview |
string |
AccountSubType
A camada da conta.
Nome | Tipo | Description |
---|---|---|
Enterprise |
string |
|
Individual |
string |
|
None |
string |
|
Other |
string |
|
Professional |
string |
AccountType
O tipo de cliente.
Nome | Tipo | Description |
---|---|---|
Business |
string |
|
ClassicPartner |
string |
|
Enterprise |
string |
|
Individual |
string |
|
Internal |
string |
|
Other |
string |
|
Partner |
string |
|
Reseller |
string |
|
Tenant |
string |
AgreementType
O tipo de contrato.
Nome | Tipo | Description |
---|---|---|
EnterpriseAgreement |
string |
|
MicrosoftCustomerAgreement |
string |
|
MicrosoftOnlineServicesProgram |
string |
|
MicrosoftPartnerAgreement |
string |
|
Other |
string |
BillingAccount
Uma conta de cobrança.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
O nome do recurso |
properties |
Uma conta de cobrança. |
|
systemData |
Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy. |
|
tags |
object |
Dicionário de metadados associados ao recurso. Ele pode não ser preenchido para todos os tipos de recursos. Comprimento máximo de chave/valor com suporte de 256 caracteres. Chaves/valor não devem esvaziar valor nem nulo. As chaves não podem conter <> % & \ ? / |
type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
BillingAccountListResult
Um contêiner para uma lista de recursos
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
O link (url) para a próxima página de resultados. |
value |
A lista de recursos. |
BillingAccountProperties
Uma conta de cobrança.
Nome | Tipo | Description |
---|---|---|
accountStatus |
O status atual da conta de cobrança. |
|
accountStatusReasonCode |
Motivo do status da conta de cobrança especificada. |
|
accountSubType |
A camada da conta. |
|
accountType |
O tipo de cliente. |
|
agreementType |
O tipo de contrato. |
|
billingRelationshipTypes |
Identifica as relações de cobrança representadas por uma conta de cobrança. A relação de cobrança pode ser entre a Microsoft, o cliente e/ou terceiros. |
|
displayName |
string |
O nome da conta de cobrança. |
enrollmentDetails |
As propriedades de um registro. |
|
hasNoBillingProfiles |
boolean |
Indica se a conta de cobrança tem ou não perfis de cobrança. |
hasReadAccess |
boolean |
Indica se o usuário tem acesso de leitura à conta de cobrança. |
notificationEmailAddress |
string |
Endereço de email de notificação da conta herdada. Disponível para o tipo de contrato Microsoft Online Services Program. |
primaryBillingTenantId |
string |
O locatário usado para configurar a conta de cobrança. Por padrão, somente usuários desse locatário podem obter atribuições de função na conta de cobrança e todas as compras são provisionadas nesse locatário. |
provisioningState |
O estado de provisionamento do recurso durante uma operação de execução prolongada. |
|
qualifications |
string[] |
Qualificações para preços em uma conta de cobrança. Os valores podem ser Comercial, Educação, Caridade ou Governo. |
registrationNumber |
Descreve o número de registro da organização vinculada à conta de cobrança. |
|
soldTo |
O endereço do indivíduo ou organização responsável pela conta de cobrança. |
|
taxIds |
Uma lista de identificadores fiscais para a conta de cobrança. |
BillingAccountStatusReasonCode
Motivo do status da conta de cobrança especificada.
Nome | Tipo | Description |
---|---|---|
Expired |
string |
|
ManuallyTerminated |
string |
|
Other |
string |
|
TerminateProcessing |
string |
|
Transferred |
string |
|
UnusualActivity |
string |
BillingRelationshipType
Identifica as relações de cobrança representadas por uma conta de cobrança. A relação de cobrança pode ser entre a Microsoft, o cliente e/ou terceiros.
Nome | Tipo | Description |
---|---|---|
CSPCustomer |
string |
|
CSPPartner |
string |
|
Direct |
string |
|
IndirectCustomer |
string |
|
IndirectPartner |
string |
|
Other |
string |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EnrollmentDetails
As propriedades de um registro.
Nome | Tipo | Description |
---|---|---|
billingCycle |
string |
O ciclo de cobrança do registro. |
channel |
string |
O tipo de canal do registro. |
cloud |
string |
A nuvem do registro. |
countryCode |
string |
O código do país do registro. |
currency |
string |
A moeda de cobrança do registro. |
endDate |
string |
A data de término do registro. |
extendedTermOption |
A extensão da conta de cobrança aceita pela empresa. |
|
indirectRelationshipInfo |
As propriedades de um registro que são aplicáveis somente para registros indiretos. |
|
invoiceRecipient |
string |
O contato que recebe faturas do registro. |
language |
string |
O idioma do registro. |
markupStatus |
Status de marcação do registro, aplicável somente para registros indiretos. |
|
poNumber |
string |
O número da ordem de compra do registro. |
startDate |
string |
A data de início do registro. |
supportCoverage |
string |
O período de cobertura de suporte para o registro. |
supportLevel |
A oferta de nível de suporte associada a um registro. |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
ExtendedTermOption
A extensão da conta de cobrança aceita pela empresa.
Nome | Tipo | Description |
---|---|---|
Opted-In |
string |
|
Opted-Out |
string |
|
Other |
string |
IndirectRelationshipInfo
Identifica o perfil de cobrança vinculado a outro perfil de cobrança no movimento de compra indireto.
Nome | Tipo | Description |
---|---|---|
billingAccountName |
string |
O nome da conta de cobrança do parceiro ou do cliente para um movimento indireto. |
billingProfileName |
string |
O nome do perfil de cobrança do parceiro ou do cliente para um movimento indireto. |
displayName |
string |
O nome de exibição do parceiro ou do cliente para um movimento indireto. |
MarkupStatus
Status de marcação do registro, aplicável somente para registros indiretos.
Nome | Tipo | Description |
---|---|---|
Disabled |
string |
|
Locked |
string |
|
Other |
string |
|
Preview |
string |
|
Published |
string |
ProvisioningState
O estado de provisionamento do recurso durante uma operação de execução prolongada.
Nome | Tipo | Description |
---|---|---|
Canceled |
string |
|
Failed |
string |
|
New |
string |
|
Pending |
string |
|
Provisioning |
string |
|
Succeeded |
string |
RegistrationNumber
Descreve o número de registro da organização vinculada à conta de cobrança.
Nome | Tipo | Description |
---|---|---|
id |
string |
O número de identificação exclusivo da organização vinculada à conta de cobrança. |
required |
boolean |
Identifica se o número de registro é necessário para a conta de cobrança. |
type |
string[] |
Os tipos de número de registro permitidos com base no país da conta de cobrança. |
SoldTo
O endereço do indivíduo ou organização responsável pela conta de cobrança.
Nome | Tipo | Description |
---|---|---|
addressLine1 |
string |
Linha de endereço 1. |
addressLine2 |
string |
Linha de endereço 2. |
addressLine3 |
string |
Linha de endereço 3. |
city |
string |
Cidade do endereço. |
companyName |
string |
Nome da empresa. Opcional para MCA Individual (pagamento conforme o uso). |
country |
string |
O código do país usa o formato ISO 3166-1 Alpha-2. |
district |
string |
Distrito de endereços. |
string |
Endereço eletrônico. |
|
firstName |
string |
Nome próprio. Opcional para MCA Enterprise. |
isValidAddress |
boolean |
Indica se o endereço está incompleto. |
lastName |
string |
Apelido. Opcional para MCA Enterprise. |
middleName |
string |
Nome do meio. |
phoneNumber |
string |
Número de telefone. |
postalCode |
string |
Código postal. |
region |
string |
Região do endereço. |
SupportLevel
A oferta de nível de suporte associada a um registro.
Nome | Tipo | Description |
---|---|---|
Developer |
string |
|
Other |
string |
|
Pro-Direct |
string |
|
Standard |
string |
systemData
Metadados relativos à criação e última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |
TaxIdentifier
Um identificador de imposto para a conta de cobrança.
Nome | Tipo | Description |
---|---|---|
country |
string |
O país do identificador fiscal. |
id |
string |
A ID do identificador de imposto. |
scope |
string |
O escopo do identificador de imposto. |
status |
O status do identificador de imposto. |
|
type |
O tipo do identificador de imposto. |
TaxIdentifierStatus
O status do identificador de imposto.
Nome | Tipo | Description |
---|---|---|
Invalid |
string |
|
Other |
string |
|
Valid |
string |
TaxIdentifierType
O tipo do identificador de imposto.
Nome | Tipo | Description |
---|---|---|
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 |