Views - Create Or Update

Referência

Serviço:: Cost Management

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

A operação para criar ou atualizar um modo de exibição. A operação de atualização requer que o eTag mais recente seja definido na solicitação. Você pode obter o eTag mais recente executando uma operação get. Criar operação não requer eTag.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
viewName	path	True	string	Ver nome
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.query.timeframe	True	ReportTimeframeType	O período de tempo para extrair dados para o relatório. Se for habitual, deve ser fornecido um período de tempo específico.
properties.query.type	True	ReportType	O tipo de relatório. Usage representa o uso real, forecast representa 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.
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.
properties.accumulated		AccumulatedType	Mostrar custos acumulados ao longo do tempo.
properties.chart		ChartType	Tipo de gráfico da vista principal na Análise de Custos. Necessário.
properties.dateRange		string	Intervalo de datas da vista atual.
properties.displayName		string	Nome de entrada do usuário do modo de exibição. Necessário.
properties.kpis		KpiProperties[]	Lista de KPIs a serem exibidos na interface do usuário de análise de custos.
properties.metric		MetricType	Métrica a ser usada ao exibir custos.
properties.modifiedOn		string	Data em que o utilizador modificou esta vista pela última vez.
properties.pivots		PivotProperties[]	Configuração de 3 subvisualizações na interface do usuário de análise de custos.
properties.query.dataSet		ReportConfigDataset	Tem definição para dados nesta configuração de relatório.
properties.query.includeMonetaryCommitment		boolean	Se verdadeiro, o relatório inclui compromisso monetário.
properties.query.timePeriod		ReportConfigTimePeriod	Tem período de tempo para extrair dados para o relatório.
properties.scope		string	Escopo de gerenciamento de custos para salvar a exibição. Isso inclui 'subscriptions/{subscriptionId}' para o escopo da assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para o 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 o 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 o escopo ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para o escopo ExternalSubscription.

Respostas

Name	Tipo	Description
200 OK	View	OK. O pedido foi bem-sucedido.
201 Created	View	Criado.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

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

CreateOrUpdatePrivateView

Pedido de amostra

HTTP

PUT https://management.azure.com/providers/Microsoft.CostManagement/views/swaggerExample?api-version=2024-08-01

{
  "eTag": "\"1d4ff9fe66f1d10\"",
  "properties": {
    "displayName": "swagger Example",
    "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"
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 201

{
  "id": "/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ffa5a9c2430c\"",
  "properties": {
    "displayName": "swagger Example",
    "scope": "",
    "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"
      }
    ]
  }
}

Código de estado:: 200

{
  "id": "/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ffa5a9c2430c\"",
  "properties": {
    "displayName": "swagger Example",
    "scope": "",
    "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 custos acumulados ao longo do tempo.
ChartType	Tipo de gráfico da vista principal na Análise de Custos. 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 está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiçoIndisponível - 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 'type' e 'enabled'.
KpiTypeType	Tipo de KPI (Previsão, Orçamento).
MetricType	Métrica a ser usada ao exibir custos.
OperatorType	O operador a utilizar para comparação.
PivotProperties	Cada pivô deve conter um 'tipo' e 'nome'.
PivotTypeType	Tipo de dados a ser exibido 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 utilizar no relatório.
ReportConfigDataset	A definição dos 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 utilizar no relatório.
ReportConfigSortingType	Direção do tipo.
ReportConfigTimePeriod	As datas de início e término para extrair dados para o relatório.
ReportGranularityType	A granularidade das linhas no relatório.
ReportTimeframeType	O período de tempo para extrair dados para o relatório. Se for habitual, deve ser fornecido um período de tempo específico.
ReportType	O tipo de relatório. Usage representa o uso real, forecast representa 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 de Análise de Custos.

AccumulatedType

Mostrar 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. Necessá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 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 está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiçoIndisponível - O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Name	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

FunctionType

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

Name	Tipo	Description
Sum	string

KpiProperties

Cada KPI deve conter uma chave 'type' e 'enabled'.

Name	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).

Name	Tipo	Description
Budget	string
Forecast	string

MetricType

Métrica a ser usada ao exibir 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ô deve conter um 'tipo' e 'nome'.

Name	Tipo	Description
name	string	Campo de dados a ser exibido na exibição.
type	PivotTypeType	Tipo de dados a ser exibido na exibição.

PivotTypeType

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

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 custo.
TagKey	string	A tag associada aos dados de custo.

ReportConfigAggregation

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

Name	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 utilizar no relatório.

Name	Tipo	Description
name	string	O nome da coluna a ser usada na comparação.
operator	OperatorType	O operador a utilizar para comparação.
values	string[]	Matriz de valores a ser usada para comparação

ReportConfigDataset

A definição dos 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 para usar 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. Relatório pode ter até 2 grupos por cláusulas.
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.

Name	Tipo	Description
columns	string[]	Matriz de nomes de colunas 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 incluirá todas as colunas.

ReportConfigFilter

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

Name	Tipo	Description
and	ReportConfigFilter[]	A expressão lógica "E". 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 tag

ReportConfigGrouping

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

Name	Tipo	Description
name	string	O nome da coluna a ser agrupada. Esta versão suporta subscrição do menor grão possível.
type	QueryColumnType	Tem o tipo da coluna a ser agrupada.

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 ser classificada.

ReportConfigSortingType

Direção do tipo.

Name	Tipo	Description
Ascending	string
Descending	string

ReportConfigTimePeriod

As datas de início e término para extrair dados para o relatório.

Name	Tipo	Description
from	string	A data de início a partir da qual extrair dados.
to	string	A data final para a qual extrair dados.

ReportGranularityType

A granularidade das linhas no relatório.

Name	Tipo	Description
Daily	string
Monthly	string

ReportTimeframeType

O período de tempo para extrair dados para o relatório. Se for habitual, deve ser fornecido um período de tempo específico.

Name	Tipo	Description
Custom	string
MonthToDate	string
WeekToDate	string
YearToDate	string

ReportType

O tipo de relatório. Usage representa o uso real, forecast representa 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.

Name	Tipo	Description
Usage	string

View

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

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 do recurso.
name	string	Nome do recurso.
properties.accumulated	AccumulatedType	Mostrar custos acumulados ao longo do tempo.
properties.chart	ChartType	Tipo de gráfico da vista principal na Análise de Custos. Necessá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 usuário do modo de exibição. Necessário.
properties.kpis	KpiProperties[]	Lista de KPIs a serem exibidos na interface do usuário de análise de custos.
properties.metric	MetricType	Métrica a ser usada ao exibir custos.
properties.modifiedOn	string	Data em que o utilizador modificou esta vista pela última vez.
properties.pivots	PivotProperties[]	Configuração de 3 subvisualizações na interface do usuário de análise de custos.
properties.query.dataSet	ReportConfigDataset	Tem definição para dados nesta configuração de relatório.
properties.query.includeMonetaryCommitment	boolean	Se verdadeiro, o relatório inclui compromisso monetário.
properties.query.timePeriod	ReportConfigTimePeriod	Tem período de tempo para extrair dados para o relatório.
properties.query.timeframe	ReportTimeframeType	O período de tempo para extrair dados para o relatório. Se for habitual, deve ser fornecido um período de tempo específico.
properties.query.type	ReportType	O tipo de relatório. Usage representa o uso real, forecast representa 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 para salvar a exibição. Isso inclui 'subscriptions/{subscriptionId}' para o escopo da assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para o 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 o 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 o escopo ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para o escopo ExternalSubscription.
type	string	Tipo de recurso.

Partilhar via