Price Sheet - Get By Billing Period

Obtenha a folha de preços para um âmbito por subscriçãoId e período de faturação. A folha de preços está disponível através desta API apenas para 1 de maio de 2014 ou mais tarde.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default?api-version=2019-10-01
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=2019-10-01

Parâmetros do URI

Name In Required Type Description
billingPeriodName
path True
  • string

Nome do período de faturação.

subscriptionId
path True
  • string

ID de assinatura Azure.

api-version
query True
  • string

Versão da API a ser usada com o pedido do cliente. A versão atual é 2019-10-01.

$expand
query
  • string

Pode ser usado para expandir as propriedades/meterDetails dentro de uma folha de preço. Por padrão, estes campos não estão incluídos na folha de preços de devolução.

$skiptoken
query
  • string

Skiptoken só é utilizado se uma operação anterior devolver 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 para utilizar para chamadas posteriores.

$top
query
  • integer
int32

Pode ser usado para limitar o número de resultados aos melhores resultados N.

Respostas

Name Type Description
200 OK

OK. O pedido foi bem sucedido.

Other Status Codes

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

PriceSheetExpand
PriceSheetForBillingPeriod

PriceSheetExpand

Sample Request

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=2019-10-01

Sample Response

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

Sample Request

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

Sample Response

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

ErrorDetails

Os detalhes do erro.

ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar o pedido de entrada. A razão está na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests - O pedido é acelerado. Redabilizar depois de esperar pelo tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiçoUn disponível - O serviço está temporariamente indisponível. Relemca depois de esperar pelo tempo especificado no cabeçalho "Retry-After".

MeterDetails

As propriedades do detalhe do medidor.

PriceSheetProperties

As propriedades da folha de preços.

PriceSheetResult

Um recurso de folha de preço.

ErrorDetails

Os detalhes do erro.

Name Type Description
code
  • string

Código de erro.

message
  • string

Mensagem de erro indicando por que a operação falhou.

ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar o pedido de entrada. A razão está na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests - O pedido é acelerado. Redabilizar depois de esperar pelo tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiçoUn disponível - O serviço está temporariamente indisponível. Relemca depois de esperar pelo tempo especificado no cabeçalho "Retry-After".

Name Type Description
error

Os detalhes do erro.

MeterDetails

As propriedades do detalhe do medidor.

Name Type Description
meterCategory
  • string

A categoria do contador, por exemplo, "Serviços cloud", "Networking", etc..

meterLocation
  • string

O local onde o serviço Azure está disponível.

meterName
  • string

O nome do contador, dentro da categoria de contador dado

meterSubCategory
  • string

A subcategoria do contador, por exemplo, 'Serviços A6 Cloud', 'ExpressRoute (IXP)', etc..

pretaxStandardRate
  • number

O preço da listagem de pré-impostos.

serviceName
  • string

O nome do serviço.

serviceTier
  • string

O nível de serviço.

totalIncludedQuantity
  • number

O total incluiu a quantidade associada à oferta.

unit
  • string

A unidade em que o consumo do contador é cobrado, por exemplo, 'Horas', 'GB', etc.

PriceSheetProperties

As propriedades da folha de preços.

Name Type Description
billingPeriodId
  • string

A identificação do recurso do período de faturação a que o uso pertence.

currencyCode
  • string

Código de Moeda

includedQuantity
  • number

Qualidade incluída para uma oferta

meterDetails

Os detalhes sobre o taxímetro. Por padrão, isto não é povoado, a menos que seja especificado em $expand.

meterId
  • string

O id do medidor (GUID)

offerId
  • string

Id oferta

partNumber
  • string

Número de peça

unitOfMeasure
  • string

Unidade de medida

unitPrice
  • number

Preço Unitário

PriceSheetResult

Um recurso de folha de preço.

Name Type Description
etag
  • string

Etag de recursos.

id
  • string

Identificação de recursos.

name
  • string

Nome de recurso.

properties.download

Detalhes do download da folha de preços.

properties.nextLink
  • string

O link (url) para a página seguinte dos resultados.

properties.pricesheets

Folha de preços

tags
  • object

Etiquetas de recursos.

type
  • string

Tipo de recurso.