Price Sheet - Get By Billing Period

Referência

Serviço:: Consumption

Versão da API:: 2024-08-01

Obtenha a folha de preços de um escopo por subscriptionId e período de cobrança. A folha de preços está disponível através desta API apenas para 1 de maio de 2014 ou posterior.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default?api-version=2024-08-01

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default?$expand={$expand}&$skiptoken={$skiptoken}&$top={$top}&api-version=2024-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
billingPeriodName	path	True	string	Nome do período de faturamento.
subscriptionId	path	True	string	ID de Subscrição do Azure.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2023-03-01.
$expand	query		string	Pode ser usado para expandir as propriedades/meterDetails dentro de uma folha de preços. Por padrão, esses campos não são incluídos ao retornar a planilha de preços.
$skiptoken	query		string	Skiptoken só é usado se uma operação anterior retornou um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro skiptoken que especifica um ponto de partida a ser usado para chamadas subsequentes.
$top	query		integer (int32) minimum: 1 maximum: 1000	Pode ser usado para limitar o número de resultados aos melhores resultados N.

Respostas

Name	Tipo	Description
200 OK	PriceSheetResult	OK. O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

PriceSheetExpand

PriceSheetForBillingPeriod

PriceSheetExpand

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201801/providers/Microsoft.Consumption/pricesheets/default?$expand=meterDetails&api-version=2024-08-01

Resposta da amostra

Código de estado:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default",
  "name": "default",
  "type": "Microsoft.Consumption/pricesheets",
  "properties": {
    "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31&$skiptoken=AQAAAA%3D%3D&$expand=properties/pricesheets/meterDetails",
    "pricesheets": [
      {
        "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "unitOfMeasure": "100 Hours",
        "includedQuantity": 100,
        "partNumber": "XX-11110",
        "unitPrice": 0.00328,
        "currencyCode": "EUR",
        "offerId": "OfferId 1",
        "meterDetails": {
          "meterName": "Data Transfer Out (GB)",
          "meterCategory": "Networking",
          "unit": "GB",
          "meterLocation": "Zone 2",
          "totalIncludedQuantity": 0,
          "pretaxStandardRate": 0.138
        }
      }
    ]
  }
}

PriceSheetForBillingPeriod

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201801/providers/Microsoft.Consumption/pricesheets/default?api-version=2024-08-01

Resposta da amostra

Código de estado:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default",
  "name": "default",
  "type": "Microsoft.Consumption/pricesheets",
  "properties": {
    "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31",
    "pricesheets": [
      {
        "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "unitOfMeasure": "100 Hours",
        "includedQuantity": 100,
        "partNumber": "XX-11110",
        "unitPrice": 0.00328,
        "currencyCode": "EUR",
        "offerId": "OfferId 1"
      }
    ]
  }
}

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
MeterDetails	Os detalhes sobre o medidor. Por padrão, isso não é preenchido, a menos que seja especificado no $expand.
PriceSheetProperties	Folha de preços
PriceSheetResult	Um recurso de folha de preços.
SavingsPlan	Detalhes do SavingsPlan

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

MeterDetails

Object

Os detalhes sobre o medidor. Por padrão, isso não é preenchido, a menos que seja especificado no $expand.

Name	Tipo	Description
meterCategory	string	A categoria do contador, por exemplo, «Serviços em nuvem», «Ligação em rede», etc.
meterLocation	string	O local no qual o serviço do Azure está disponível.
meterName	string	O nome do contador, dentro da categoria de contador em causa
meterSubCategory	string	A subcategoria do contador, por exemplo, «A6 Cloud services», «ExpressRoute (IXP)», etc.
pretaxStandardRate	number (decimal)	O preço de listagem antes de impostos.
serviceName	string	O nome do serviço.
serviceTier	string	A camada de serviço.
totalIncludedQuantity	number (decimal)	A quantidade total incluída associada à oferta.
unit	string	A unidade em que o consumo do contador é cobrado, por exemplo, 'Horas', 'GB', etc.

PriceSheetProperties

Object

Folha de preços

Name	Tipo	Description
billingPeriodId	string	A id do recurso do período de faturamento ao qual o uso pertence.
currencyCode	string	Código de Moeda
includedQuantity	number (decimal)	Qualidade incluída para uma oferta
meterDetails	MeterDetails	Os detalhes sobre o medidor. Por padrão, isso não é preenchido, a menos que seja especificado no $expand.
meterId	string (uuid)	O ID do medidor (GUID)
offerId	string	ID da oferta
partNumber	string	Número da peça
savingsPlan	SavingsPlan	Detalhes do SavingsPlan
unitOfMeasure	string	Unidade de medida
unitPrice	number (decimal)	Preço por Unidade

PriceSheetResult

Object

Um recurso de folha de preços.

Name	Tipo	Description
etag	string	O etag para o recurso.
id	string	O ID ARM qualificado completo de um evento.
name	string	A ID que identifica exclusivamente um evento.
properties.download	MeterDetails	Detalhes do download da folha de preços.
properties.nextLink	string	O link (url) para a próxima página de resultados.
properties.pricesheets	PriceSheetProperties[]	Folha de preços
tags	object	Tags de recursos.
type	string	Tipo de recurso.

SavingsPlan

Object

Detalhes do SavingsPlan

Name	Tipo	Description
effectivePrice	number (decimal)	PoupançaPlano Preço Efetivo
marketPrice	number (decimal)	SavingsPlan Preço de Mercado
term	string	Prazo do Plano de Poupança

Partilhar via

Price Sheet - Get By Billing Period

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

PriceSheetExpand

Pedido de amostra

Resposta da amostra

PriceSheetForBillingPeriod

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

MeterDetails

PriceSheetProperties

PriceSheetResult

SavingsPlan

Recursos adicionais