Partilhar via

Views - Get By Scope

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

Obtém a vista para o âmbito definido por nome de vista.

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

Parâmetros do URI

Name Em Necessário Tipo Description
scope
 path True

string

O âmbito associado às operações de visualização. Isto inclui "subscriptions/{subscriptionId}" para o âmbito da subscrição, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" para o âmbito resourceGroup, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" para o âmbito da Conta de Faturação, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" para o âmbito do Departamento, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" para o âmbito EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" para o âmbito BillingProfile, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" para o âmbito InvoiceSection, "providers/Microsoft.Management/managementGroups/{managementGroupId}" para o âmbito do Grupo de Gestão, "providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}" para o âmbito da Conta de Faturação Externa e "providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" para o âmbito da Subscrição Externa.
viewName
 path True

string

Ver nome
api-version
 query True

string

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

Respostas

Name Tipo Description
200 OK

View

OK. O pedido foi bem-sucedido.
Other Status Codes

ErrorResponse

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ResourceGroupView

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Name Description
AccumulatedType

Mostrar os custos acumulados ao longo do tempo.
ChartType

Tipo de gráfico da vista principal na Análise de Custos. Obrigatório.
ErrorDetails

Os detalhes do erro.
ErrorResponse

A resposta a erros indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

  • 429 TooManyRequests - O pedido é limitado. Repita 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 após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.
FunctionType

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

Cada KPI tem de conter uma chave "tipo" e "ativada".
KpiTypeType

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

Métrica a utilizar ao apresentar os custos.
OperatorType

O operador a utilizar para comparação.
PivotProperties

Cada pivô tem de conter um "tipo" e um "nome".
PivotTypeType

Tipo de dados a mostrar na vista.
QueryColumnType

O tipo da coluna na exportação.
ReportConfigAggregation

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

A expressão de comparação a utilizar 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 utilizar no relatório.
ReportConfigGrouping

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

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

Direção do tipo.
ReportConfigTimePeriod

A data de início e de fim para solicitar dados para o relatório.
ReportGranularityType

A granularidade das linhas no relatório.
ReportTimeframeType

O período de tempo para solicitar dados para o relatório. Se for personalizado, tem de ser fornecido um período de tempo específico.
ReportType

O tipo do relatório. A utilização representa a utilização real, a previsão representa os dados previstos e UsageAndForecast representa a utilização e os dados previstos. A utilização 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.

Name Tipo Description
false

string

true

string

ChartType

Tipo de gráfico da vista principal na Análise de Custos. Obrigatório.

Name Tipo Description
Area

string

GroupedColumn

string

Line

string

StackedColumn

string

Table

string

ErrorDetails

Os detalhes do erro.

Name Tipo Description
code

string

Código de erro.
message

string

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

ErrorResponse

A resposta a erros indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

  • 429 TooManyRequests - O pedido é limitado. Repita 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 após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

Name Tipo Description
error

ErrorDetails

Os detalhes do erro.

FunctionType

O nome da função de agregação a utilizar.

Name Tipo Description
Sum

string

KpiProperties

Cada KPI tem de conter uma chave "tipo" e "ativada".

Name Tipo Description
enabled

boolean

mostrar o KPI na IU?
id

string

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

KpiTypeType

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

KpiTypeType

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

Name Tipo Description
Budget

string

Forecast

string

MetricType

Métrica a utilizar ao apresentar os custos.

Name Tipo Description
AHUB

string

ActualCost

string

AmortizedCost

string

OperatorType

O operador a utilizar para comparação.

Name Tipo Description
Contains

string

In

string

PivotProperties

Cada pivô tem de conter um "tipo" e um "nome".

Name Tipo Description
name

string

Campo de dados a mostrar na vista.
type

PivotTypeType

Tipo de dados a mostrar na vista.

PivotTypeType

Tipo de dados a mostrar na vista.

Name Tipo Description
Dimension

string

TagKey

string

QueryColumnType

O tipo da coluna na exportação.

Name Tipo Description
Dimension

string

A dimensão dos dados de custos.
TagKey

string

A etiqueta associada aos dados de custos.

ReportConfigAggregation

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

Name Tipo Description
function

FunctionType

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

string

O nome da coluna a agregar.

ReportConfigComparisonExpression

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

Name Tipo Description
name

string

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

OperatorType

O operador a utilizar para comparação.
values

string[]

Matriz de valores a utilizar para comparação

ReportConfigDataset

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

Name Tipo Description
aggregation

<string,  ReportConfigAggregation>

Dicionário de expressão de agregação a utilizar no relatório. A chave de cada item no dicionário é o alias para a 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 utilizar no relatório.
granularity

ReportGranularityType

A granularidade das linhas no relatório.
grouping

ReportConfigGrouping[]

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

ReportConfigSorting[]

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

ReportConfigDatasetConfiguration

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

Name Tipo Description
columns

string[]

Matriz de nomes de colunas a incluir no relatório. É permitido qualquer nome de coluna de relatório válido. Se não for fornecido, o relatório inclui todas as colunas.

ReportConfigFilter

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

Name Tipo Description
and

ReportConfigFilter[]

A expressão lógica "E". Tem de 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". Tem de ter, pelo menos, 2 itens.
tags

ReportConfigComparisonExpression

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

ReportConfigGrouping

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

Name Tipo Description
name

string

O nome da coluna a agrupar. Esta versão suporta a subscrição com o nível mais baixo possível.
type

QueryColumnType

Tem o tipo da coluna a agrupar.

ReportConfigSorting

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

Name Tipo Description
direction

ReportConfigSortingType

Direção do tipo.
name

string

O nome da coluna a ordenar.

ReportConfigSortingType

Direção do tipo.

Name Tipo Description
Ascending

string

Descending

string

ReportConfigTimePeriod

A data de início e de fim para solicitar dados para o relatório.

Name Tipo Description
from

string

A data de início a partir da qual solicitar dados.
to

string

A data de fim para a qual solicitar dados.

ReportGranularityType

A granularidade das linhas no relatório.

Name Tipo Description
Daily

string

Monthly

string

ReportTimeframeType

O período de tempo para solicitar dados para o relatório. Se for personalizado, tem de ser fornecido um período de tempo específico.

Name Tipo Description
Custom

string

MonthToDate

string

WeekToDate

string

YearToDate

string

ReportType

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

Name Tipo Description
Usage

string

View

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

Name Tipo Description
eTag

string

eTag do recurso. Para lidar com o cenário de atualização em simultâneo, este campo será utilizado para determinar se o utilizador está ou não a atualizar a versão mais recente.
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 vista principal na Análise de Custos. Obrigatório.
properties.createdOn

string

Data em que o utilizador criou esta vista.
properties.currency

string

Moeda da vista atual.
properties.dateRange

string

Intervalo de datas da vista atual.
properties.displayName

string

Nome de entrada do utilizador da vista. Obrigatório.
properties.kpis

KpiProperties[]

Lista de KPIs a mostrar na IU do Cost Analysis.
properties.metric

MetricType

Métrica a utilizar ao apresentar os custos.
properties.modifiedOn

string

Data em que o utilizador modificou esta vista pela última vez.
properties.pivots

PivotProperties[]

Configuração de 3 sub vistas na IU do Cost Analysis.
properties.query.dataSet

ReportConfigDataset

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

boolean

Se for verdadeiro, o relatório inclui alocação monetária.
properties.query.timePeriod

ReportConfigTimePeriod

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

ReportTimeframeType

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

ReportType

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

string

Âmbito do Cost Management para guardar a vista. Isto inclui "subscriptions/{subscriptionId}" para o âmbito da subscrição, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" para o âmbito resourceGroup, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" para o âmbito da Conta de Faturação, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" para o âmbito do Departamento, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" para o âmbito EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" para o âmbito BillingProfile, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" para o âmbito InvoiceSection, "providers/Microsoft.Management/managementGroups/{managementGroupId}" para o âmbito do Grupo de Gestão, "/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}" para o âmbito ExternalBillingAccount e "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" para o âmbito ExternalSubscription.
type

string

Tipo de recurso.