Reservations Summaries - List

Serviço:: Consumption

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

Lista os resumos de reservas para o escopo definido diariamente ou mensalmente. Observação: o ARM tem um limite de tamanho de carga de 12 MB, portanto, atualmente, os chamadores recebem 400 quando o tamanho da resposta excede o limite do ARM. Nesses casos, a chamada à API deve ser feita com intervalos de datas menores.

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain={grain}

Com parâmetros opcionais:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain={grain}&startDate={startDate}&endDate={endDate}&$filter={$filter}&reservationId={reservationId}&reservationOrderId={reservationOrderId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceScope	path	True	string	O identificador totalmente qualificado do Azure Resource Manager do recurso.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
grain	query	True	Datagrain	Pode ser diário ou mensal
$filter	query		string	Necessário apenas para grãos diários. As propriedades/UsageDate para data de início e data de término. O filtro dá suporte a 'le' e 'ge'. Não aplicável ao consultar com o perfil de cobrança
endDate	query		string	Data de término. Aplicável somente ao consultar com o perfil de cobrança
reservationId	query		string	GUID de ID de reserva. Válido somente se reservationOrderId também for fornecido. Filtrar para uma reserva específica
reservationOrderId	query		string	GUID da ID do Pedido de Reserva. Obrigatório se reservationId for fornecido. Filtrar para uma ordem de reserva específica
startDate	query		string	Data de início. Aplicável somente ao consultar com o perfil de cobrança

Respostas

Nome	Tipo	Description
200 OK	ReservationSummariesListResult	A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

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

ReservationSummariesDailyWithBillingAccountId

ReservationSummariesDailyWithBillingProfileId

ReservationSummariesMonthlyWithBillingAccountId

ReservationSummariesMonthlyWithBillingProfileId

ReservationSummariesMonthlyWithBillingProfileIdReservationId

ReservationSummariesDailyWithBillingAccountId

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain=daily&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "properties": {
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 720,
        "skuName": "Standard_B1s",
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0
      },
      "tags": null
    }
  ]
}

ReservationSummariesDailyWithBillingProfileId

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain=daily&startDate=2017-10-01&endDate=2017-11-20

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "properties": {
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 720,
        "skuName": "Standard_B1s",
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0
      },
      "tags": null
    }
  ]
}

ReservationSummariesMonthlyWithBillingAccountId

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain=monthly

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "properties": {
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 720,
        "skuName": "Standard_B1s",
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0
      },
      "tags": null
    }
  ]
}

ReservationSummariesMonthlyWithBillingProfileId

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain=monthly

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "properties": {
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservedHours": 720,
        "skuName": "Standard_B1s",
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0
      },
      "tags": null
    }
  ]
}

ReservationSummariesMonthlyWithBillingProfileIdReservationId

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?api-version=2024-08-01&grain=monthly&reservationId=1c6b6358-709f-484c-85f1-72e862a0cf3b&reservationOrderId=9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "properties": {
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "minUtilizationPercentage": 0,
        "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
        "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc",
        "reservedHours": 720,
        "skuName": "Standard_B1s",
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0
      },
      "tags": null
    }
  ]
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
Datagrain
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ReservationSummariesListResult	Resultado da listagem de resumos de reserva.
ReservationSummary	recurso de resumo de reserva.
systemData	Metadados relativos à 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

Datagrain

Enumeração

Valor	Description
daily	Grão diário de dados
monthly	Grão mensal de dados

ErrorAdditionalInfo

Objeto

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

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ReservationSummariesListResult

Objeto

Resultado da listagem de resumos de reserva.

Nome	Tipo	Description
nextLink	string	O link (url) para a próxima página de resultados.
value	ReservationSummary[]	A lista de resumos de reserva.

ReservationSummary

Objeto

recurso de resumo de reserva.

Nome	Tipo	Description
etag	string	A etag do recurso.
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.avgUtilizationPercentage	number (decimal)	Essa é a utilização média para todo o intervalo de tempo. (dia ou mês, dependendo do grão)
properties.kind	string	O tipo de reserva.
properties.maxUtilizationPercentage	number (decimal)	Essa é a utilização máxima por hora na hora de uso (dia ou mês). Por exemplo, se o registro de uso corresponder a 10/12/2017 e, nesse caso, para as horas 4 e 5, a utilização for de 100%, esse campo retornará 100% para esse dia.
properties.minUtilizationPercentage	number (decimal)	Essa é a utilização mínima por hora na hora de uso (dia ou mês). Por exemplo, se o registro de uso corresponder a 10/12/2017 e, na hora 4 e 5, a utilização for de 10%, esse campo retornará 10% para esse dia
properties.purchasedQuantity	number (decimal)	Essa é a quantidade adquirida para a reservationId.
properties.remainingQuantity	number (decimal)	Essa é a quantidade restante para a reservationId.
properties.reservationId	string	A ID da reserva é o identificador de uma reserva em uma ordem de reserva. Cada reserva é o agrupamento para aplicar o escopo do benefício e também especifica o número de instâncias às quais o benefício de reserva pode ser aplicado.
properties.reservationOrderId	string	A ID do pedido de reserva é o identificador de uma compra de reserva. Cada ID de pedido de reserva representa uma única transação de compra. Um pedido de reserva contém reservas. A ordem de reserva especifica o tamanho e a região da VM para as reservas.
properties.reservedHours	number (decimal)	Esse é o total de horas reservadas. Por exemplo, se a reserva para 1 instância foi feita às 13h, serão 11 horas para esse dia e 24 horas a partir dos dias seguintes
properties.skuName	string	Este é o nome do ARM Sku. Ele pode ser usado para ingressar no campo serviceType em informações adicionais nos registros de uso.
properties.totalReservedQuantity	number (decimal)	Essa é a contagem total de instâncias reservadas para a reservationId.
properties.usageDate	string (date-time)	Dados correspondentes ao registro de utilização. Se a granulação de dados for mensal, será o primeiro dia do mês.
properties.usedHours	number (decimal)	Total de horas usadas pela reserva
properties.usedQuantity	number (decimal)	Essa é a quantidade usada para a reservationId.
properties.utilizedPercentage	number (decimal)	Esse é o percentual utilizado para a ID da reserva.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Marcas de recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

systemData

Objeto

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

Nome	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.

Compartilhar via

Reservations Summaries - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ReservationSummariesDailyWithBillingAccountId

Solicitação de exemplo

Resposta de exemplo

ReservationSummariesDailyWithBillingProfileId

Solicitação de exemplo

Resposta de exemplo

ReservationSummariesMonthlyWithBillingAccountId

Solicitação de exemplo

Resposta de exemplo

ReservationSummariesMonthlyWithBillingProfileId

Solicitação de exemplo

Resposta de exemplo

ReservationSummariesMonthlyWithBillingProfileIdReservationId

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

Datagrain

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ReservationSummariesListResult

ReservationSummary

systemData