Products - Get By Customer

Serviço:

Billing

Versão da API:

2019-10-01-preview

Obtém um produto por ID. A operação tem suporte apenas para contas de cobrança com o tipo de contrato Microsoft Partner Agreement.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products/{productName}?api-version=2019-10-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
billingAccountName	path	True	string	A ID que identifica exclusivamente uma conta de cobrança.
customerName	path	True	string	A ID que identifica exclusivamente um cliente.
productName	path	True	string	A ID que identifica exclusivamente um produto.
api-version	query	True	string	A versão da API a ser usada com a solicitação do cliente. A versão atual é 2019-10-01-preview.

Respostas

Nome	Tipo	Description
200 OK	Product	OKEY. A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Product

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products/{productName}?api-version=2019-10-01-preview

Resposta de exemplo

Código de status:

200

{
  "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/customers/{customerName}/products/{productName}",
  "name": "{productName}",
  "type": "Microsoft.Billing/billingAccounts/customers/products",
  "properties": {
    "productTypeId": "A12345",
    "productType": "Subscription",
    "displayName": "AIP Dev",
    "status": "Active",
    "purchaseDate": "2018-05-01T17:32:28Z",
    "lastCharge": {
      "currency": "USD",
      "value": 5000
    },
    "lastChargeDate": "2018-06-15T17:32:28Z",
    "billingFrequency": "Monthly",
    "quantity": 4,
    "skuId": "0001",
    "skuDescription": "Enterprise Agreement Development",
    "availabilityId": "AvailabilityId1",
    "parentProductId": "45000000-0000-0000-0000-0000000001242",
    "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
    "customerDisplayName": "Customer 1",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
    "billingProfileDisplayName": "Contoso operations billing",
    "reseller": {
      "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19",
      "description": "Reseller2"
    }
  }
}

Definições

Nome	Description
Amount	O valor.
BillingFrequency	A frequência em que o produto será cobrado.
ErrorDetails	Os detalhes do erro.
ErrorResponse	A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
ErrorSubDetails
Product	Um produto.
ProductStatusType	O status atual do produto.
Reseller	Detalhes do revendedor.

Amount

Objeto

O valor.

Nome	Tipo	Description
currency	string	A moeda do valor do valor.
value	number	Valor da quantidade.

BillingFrequency

Enumeração

A frequência em que o produto será cobrado.

Valor	Description
Monthly
OneTime
UsageBased

ErrorDetails

Objeto

Os detalhes do erro.

Nome	Tipo	Description
code	string	Código de erro.
details	ErrorSubDetails[]	Os sub-detalhes do erro.
message	string	Mensagem de erro indicando por que a operação falhou.
target	string	O destino do erro específico.

ErrorResponse

Objeto

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Nome	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

ErrorSubDetails

Objeto

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.
target	string	O destino do erro específico.

Product

Objeto

Um produto.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.availabilityId	string	A disponibilidade do produto.
properties.billingFrequency	BillingFrequency	A frequência em que o produto será cobrado.
properties.billingProfileDisplayName	string	O nome do perfil de cobrança ao qual o produto é cobrado.
properties.billingProfileId	string	A ID do perfil de cobrança ao qual o produto é cobrado.
properties.customerDisplayName	string	O nome do cliente para quem o produto foi comprado. O campo é aplicável somente para a conta de cobrança do Contrato de Parceiro da Microsoft.
properties.customerId	string	A ID do cliente para quem o produto foi comprado. O campo é aplicável somente para a conta de cobrança do Contrato de Parceiro da Microsoft.
properties.displayName	string	O nome de exibição do produto.
properties.endDate	string (date-time)	A data em que o produto será renovado ou cancelado.
properties.invoiceSectionDisplayName	string	O nome da seção da fatura à qual o produto é cobrado.
properties.invoiceSectionId	string	A ID da seção da fatura à qual o produto é cobrado.
properties.lastCharge	Amount	As acusações do mês passado.
properties.lastChargeDate	string (date-time)	A data da última cobrança.
properties.parentProductId	string	ID do produto pai.
properties.productType	string	A descrição do tipo de produto.
properties.productTypeId	string	A ID do tipo de produto.
properties.purchaseDate	string (date-time)	A data em que o produto foi comprado.
properties.quantity	number	A quantidade comprada para o produto.
properties.reseller	Reseller	Revendedor para este produto.
properties.skuDescription	string	A descrição do sku do produto.
properties.skuId	string	A ID de sku do produto.
properties.status	ProductStatusType	O status atual do produto.
properties.tenantId	string	A ID do locatário no qual o produto é usado.
type	string	Tipo de recurso.

ProductStatusType

Enumeração

O status atual do produto.

Valor	Description
Active
AutoRenew
Cancelled
Disabled
Expired
Expiring
Inactive
PastDue

Reseller

Objeto

Detalhes do revendedor.

Nome	Tipo	Description
description	string	O nome do revendedor.
resellerId	string	A ID do MPN do revendedor.