Price Sheet - Get

Serviço:: Consumption

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

Obtém a planilha de preços de uma assinatura. 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.Consumption/pricesheets/default?api-version=2024-08-01

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
$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	Operação do Azure concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

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

PriceSheet

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "name": "default",
  "type": "Microsoft.Consumption/pricesheets",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default",
  "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",
    "pricesheets": [
      {
        "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702",
        "currencyCode": "EUR",
        "includedQuantity": 100,
        "meterId": "00000000-0000-0000-0000-000000000000",
        "offerId": "OfferId 1",
        "partNumber": "XX-11110",
        "savingsPlan": {
          "effectivePrice": 0.002,
          "marketPrice": 0.00328,
          "term": "P3Y"
        },
        "unitOfMeasure": "100 Hours",
        "unitPrice": 0.00328
      }
    ]
  }
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
MeterDetails	As propriedades do detalhe do medidor.
PriceSheetProperties	As propriedades da folha de preços.
PriceSheetResult	Um recurso de folha de preços.
SavingsPlan	As propriedades do SavingsPlan.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

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

As propriedades do detalhe do medidor.

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

As propriedades da 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	eTag do recurso. Para lidar com o cenário de atualização simultânea, esse campo será usado para determinar se o usuário está atualizando a versão mais recente ou não.
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
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
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SavingsPlan

Object

As propriedades 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

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Price Sheet - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

PriceSheet

Pedido de amostra

Resposta da amostra

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

MeterDetails

PriceSheetProperties

PriceSheetResult

SavingsPlan

systemData