Compartilhar via

Views - Get By Scope

  • Referência
Serviço:
Cost Management
Versão da API:
2024-08-01

Obtém a exibição do escopo definido por nome de exibição.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/views/{viewName}?api-version=2024-08-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
scope
 path True

string

O escopo associado às operações de exibição. Isso inclui 'subscriptions/{subscriptionId}' para escopo de assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo da Conta de Cobrança, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para o escopo do Departamento, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para escopo EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo billingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para o escopo InvoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' para o escopo do Grupo de Gerenciamento, 'providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' para escopo da Conta de Cobrança Externa e 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para escopo de Assinatura Externa.
viewName
 path True

string

Nome da exibição
api-version
 query True

string

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

View

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

ResourceGroupView

Solicitação de exemplo

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample?api-version=2024-08-01

Resposta de exemplo

Código de status:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "properties": {
    "displayName": "swagger Example",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG",
    "query": {
      "type": "Usage",
      "timeframe": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "aggregation": {
          "totalCost": {
            "name": "PreTaxCost",
            "function": "Sum"
          }
        },
        "grouping": [],
        "sorting": [
          {
            "direction": "Ascending",
            "name": "UsageDate"
          }
        ]
      }
    },
    "chart": "Table",
    "accumulated": "true",
    "metric": "ActualCost",
    "kpis": [
      {
        "type": "Forecast",
        "id": null,
        "enabled": true
      },
      {
        "type": "Budget",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo",
        "enabled": true
      }
    ],
    "pivots": [
      {
        "type": "Dimension",
        "name": "ServiceName"
      },
      {
        "type": "Dimension",
        "name": "MeterCategory"
      },
      {
        "type": "TagKey",
        "name": "swaggerTagKey"
      }
    ]
  }
}

Definições

Nome Description
AccumulatedType

Mostrar os custos acumulados ao longo do tempo.
ChartType

Tipo de gráfico da exibição principal na Análise de Custo. Necessário.
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.

Algumas respostas de erro:

  • 429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".
FunctionType

O nome da função de agregação a ser usada.
KpiProperties

Cada KPI deve conter uma chave "tipo" e "habilitada".
KpiTypeType

Tipo de KPI (Previsão, Orçamento).
MetricType

Métrica a ser usada ao exibir custos.
OperatorType

O operador a ser usado para comparação.
PivotProperties

Cada pivô deve conter um "tipo" e um "nome".
PivotTypeType

Tipo de dados a ser mostrado na exibição.
QueryColumnType

O tipo da coluna na exportação.
ReportConfigAggregation

A expressão de agregação a ser usada no relatório.
ReportConfigComparisonExpression

A expressão de comparação a ser usada no relatório.
ReportConfigDataset

A definição de dados presentes no relatório.
ReportConfigDatasetConfiguration

A configuração do conjunto de dados no relatório.
ReportConfigFilter

A expressão de filtro a ser usada no relatório.
ReportConfigGrouping

O grupo por expressão a ser usado no relatório.
ReportConfigSorting

A ordem por expressão a ser usada no relatório.
ReportConfigSortingType

Direção de classificação.
ReportConfigTimePeriod

A data de início e término para efetuar pull de dados para o relatório.
ReportGranularityType

A granularidade das linhas no relatório.
ReportTimeframeType

O período para efetuar pull de dados para o relatório. Se personalizado, um período de tempo específico deve ser fornecido.
ReportType

O tipo do relatório. O uso representa o uso real, a previsão representa os dados previstos e UsageAndForecast representa o uso e os dados previstos. O uso real e os dados previstos podem ser diferenciados com base em datas.
View

Estados e configurações da Análise de Custos.

AccumulatedType

Mostrar os custos acumulados ao longo do tempo.

Nome Tipo Description
false

string

true

string

ChartType

Tipo de gráfico da exibição principal na Análise de Custo. Necessário.

Nome Tipo Description
Area

string

GroupedColumn

string

Line

string

StackedColumn

string

Table

string

ErrorDetails

Os detalhes do erro.

Nome Tipo 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 a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Nome Tipo Description
error

ErrorDetails

Os detalhes do erro.

FunctionType

O nome da função de agregação a ser usada.

Nome Tipo Description
Sum

string

KpiProperties

Cada KPI deve conter uma chave "tipo" e "habilitada".

Nome Tipo Description
enabled

boolean

mostrar o KPI na interface do usuário?
id

string

ID do recurso relacionado à métrica (orçamento).
type

KpiTypeType

Tipo de KPI (Previsão, Orçamento).

KpiTypeType

Tipo de KPI (Previsão, Orçamento).

Nome Tipo Description
Budget

string

Forecast

string

MetricType

Métrica a ser usada ao exibir custos.

Nome Tipo Description
AHUB

string

ActualCost

string

AmortizedCost

string

OperatorType

O operador a ser usado para comparação.

Nome Tipo Description
Contains

string

In

string

PivotProperties

Cada pivô deve conter um "tipo" e um "nome".

Nome Tipo Description
name

string

Campo de dados a ser mostrado na exibição.
type

PivotTypeType

Tipo de dados a ser mostrado na exibição.

PivotTypeType

Tipo de dados a ser mostrado na exibição.

Nome Tipo Description
Dimension

string

TagKey

string

QueryColumnType

O tipo da coluna na exportação.

Nome Tipo Description
Dimension

string

A dimensão dos dados de custo.
TagKey

string

A marca associada aos dados de custo.

ReportConfigAggregation

A expressão de agregação a ser usada no relatório.

Nome Tipo Description
function

FunctionType

O nome da função de agregação a ser usada.
name

string

O nome da coluna a ser agregada.

ReportConfigComparisonExpression

A expressão de comparação a ser usada no relatório.

Nome Tipo Description
name

string

O nome da coluna a ser usada em comparação.
operator

OperatorType

O operador a ser usado para comparação.
values

string[]

Matriz de valores a serem usados para comparação

ReportConfigDataset

A definição de dados presentes no relatório.

Nome Tipo Description
aggregation

<string,  ReportConfigAggregation>

Dicionário de expressão de agregação a ser usado no relatório. A chave de cada item no dicionário é o alias da coluna agregada. O relatório pode ter até 2 cláusulas de agregação.
configuration

ReportConfigDatasetConfiguration

Tem informações de configuração para os dados no relatório. A configuração será ignorada se a agregação e o agrupamento forem fornecidos.
filter

ReportConfigFilter

Tem expressão de filtro a ser usada no relatório.
granularity

ReportGranularityType

A granularidade das linhas no relatório.
grouping

ReportConfigGrouping[]

Matriz de grupo por expressão a ser usada no relatório. O relatório pode ter até 2 cláusulas de grupo por.
sorting

ReportConfigSorting[]

Matriz de ordem por expressão a ser usada no relatório.

ReportConfigDatasetConfiguration

A configuração do conjunto de dados no relatório.

Nome Tipo Description
columns

string[]

Matriz de nomes de coluna a serem incluídos no relatório. Qualquer nome de coluna de relatório válido é permitido. Se não for fornecido, o relatório inclui todas as colunas.

ReportConfigFilter

A expressão de filtro a ser usada no relatório.

Nome Tipo Description
and

ReportConfigFilter[]

A expressão lógica "AND". Deve ter pelo menos 2 itens.
dimensions

ReportConfigComparisonExpression

Tem expressão de comparação para uma dimensão
or

ReportConfigFilter[]

A expressão lógica "OR". Deve ter pelo menos 2 itens.
tags

ReportConfigComparisonExpression

Tem expressão de comparação para uma marca

ReportConfigGrouping

O grupo por expressão a ser usado no relatório.

Nome Tipo Description
name

string

O nome da coluna a ser agrupada. Esta versão dá suporte à assinatura de menor granulação possível.
type

QueryColumnType

Tem o tipo da coluna a ser agrupada.

ReportConfigSorting

A ordem por expressão a ser usada no relatório.

Nome Tipo Description
direction

ReportConfigSortingType

Direção de classificação.
name

string

O nome da coluna a ser classificada.

ReportConfigSortingType

Direção de classificação.

Nome Tipo Description
Ascending

string

Descending

string

ReportConfigTimePeriod

A data de início e término para efetuar pull de dados para o relatório.

Nome Tipo Description
from

string

A data de início da qual os dados serão extraídos.
to

string

A data de término para a qual efetuar pull de dados.

ReportGranularityType

A granularidade das linhas no relatório.

Nome Tipo Description
Daily

string

Monthly

string

ReportTimeframeType

O período para efetuar pull de dados para o relatório. Se personalizado, um período de tempo específico deve ser fornecido.

Nome Tipo Description
Custom

string

MonthToDate

string

WeekToDate

string

YearToDate

string

ReportType

O tipo do relatório. O uso representa o uso real, a previsão representa os dados previstos e UsageAndForecast representa o uso e os dados previstos. O uso real e os dados previstos podem ser diferenciados com base em datas.

Nome Tipo Description
Usage

string

View

Estados e configurações da Análise de Custos.

Nome 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 do recurso.
name

string

Nome do recurso.
properties.accumulated

AccumulatedType

Mostrar os custos acumulados ao longo do tempo.
properties.chart

ChartType

Tipo de gráfico da exibição principal na Análise de Custo. Necessário.
properties.createdOn

string

Data em que o usuário criou essa exibição.
properties.currency

string

Moeda do modo de exibição atual.
properties.dateRange

string

Intervalo de datas do modo de exibição atual.
properties.displayName

string

Nome de entrada do usuário da exibição. Necessário.
properties.kpis

KpiProperties[]

Lista de KPIs a serem mostrados na interface do usuário da Análise de Custos.
properties.metric

MetricType

Métrica a ser usada ao exibir custos.
properties.modifiedOn

string

Data em que o usuário modificou essa exibição pela última vez.
properties.pivots

PivotProperties[]

Configuração de 3 subexibições na interface do usuário da Análise de Custo.
properties.query.dataSet

ReportConfigDataset

Tem definição de dados nesta configuração de relatório.
properties.query.includeMonetaryCommitment

boolean

Se for verdadeiro, o relatório inclui o compromisso monetário.
properties.query.timePeriod

ReportConfigTimePeriod

Tem um período de tempo para efetuar pull de dados para o relatório.
properties.query.timeframe

ReportTimeframeType

O período para efetuar pull de dados para o relatório. Se personalizado, um período de tempo específico deve ser fornecido.
properties.query.type

ReportType

O tipo do relatório. O uso representa o uso real, a previsão representa os dados previstos e UsageAndForecast representa o uso e os dados previstos. O uso real e os dados previstos podem ser diferenciados com base em datas.
properties.scope

string

Escopo de Gerenciamento de Custos no qual salvar a exibição. Isso inclui 'subscriptions/{subscriptionId}' para escopo de assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo da Conta de Cobrança, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para o escopo do Departamento, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para escopo EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo billingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para o escopo InvoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' para escopo do Grupo de Gerenciamento, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' para o escopo ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para escopo ExternalSubscription.
type

string

Tipo de recurso.