Views - Create Or Update By Scope

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

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

Parâmetros de URI

Name In Required Type 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}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '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}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '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

Versão da API a ser usada com a solicitação do cliente.

Corpo da solicitação

Name Required Type Description
properties.query.timeframe True

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 True

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.

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 ou não a versão mais recente.

properties.accumulated

Mostrar os custos acumulados ao longo do tempo.

properties.chart

Tipo de gráfico da exibição principal na Análise de Custo. Obrigatórios.

properties.displayName
  • string

Nome de entrada do usuário do modo de exibição. Obrigatórios.

properties.kpis

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

properties.metric

Métrica a ser usada ao exibir custos.

properties.pivots

Configuração de três sub-exibições na interface do usuário da Análise de Custo.

properties.query.dataSet

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

Tem um 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 escopo de assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '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 escopo InvoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' para escopo do Grupo de Gerenciamento, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' para escopo ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para escopo ExternalSubscription.

Respostas

Name Type Description
200 OK

OK. A solicitação foi bem-sucedida.

201 Created

Criado.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

ResourceGroupCreateOrUpdateView

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample?api-version=2021-10-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"
      }
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ffa5a9c2430c\"",
  "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"
      }
    ]
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ffa5a9c2430c\"",
  "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

AccumulatedType

Mostrar os custos acumulados ao longo do tempo.

ChartType

Tipo de gráfico da exibição principal na Análise de Custos. Obrigatórios.

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

ReportConfigAggregation

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

ReportConfigColumnType

O tipo da coluna 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 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 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.

Name Type Description
false
  • string
true
  • string

ChartType

Tipo de gráfico da exibição principal na Análise de Custos. Obrigatórios.

Name Type Description
Area
  • string
GroupedColumn
  • string
Line
  • string
StackedColumn
  • string
Table
  • string

ErrorDetails

Os detalhes do erro.

Name Type Description
code
  • string

Código do 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. Repita depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Name Type Description
error

Os detalhes do erro.

FunctionType

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

Name Type Description
Sum
  • string

KpiProperties

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

Name Type Description
enabled
  • boolean

mostrar o KPI na interface do usuário?

id
  • string

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

type

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

KpiTypeType

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

Name Type Description
Budget
  • string
Forecast
  • string

MetricType

Métrica a ser usada ao exibir custos.

Name Type Description
AHUB
  • string
ActualCost
  • string
AmortizedCost
  • string

OperatorType

O operador a ser usado para comparação.

Name Type Description
Contains
  • string
In
  • string

PivotProperties

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

Name Type Description
name
  • string

Campo de dados a ser exibido.

type

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

PivotTypeType

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

Name Type Description
Dimension
  • string
TagKey
  • string

ReportConfigAggregation

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

Name Type Description
function

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

name
  • string

O nome da coluna a ser agregada.

ReportConfigColumnType

O tipo da coluna no relatório.

Name Type Description
Dimension
  • string
Tag
  • string

ReportConfigComparisonExpression

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

Name Type Description
name
  • string

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

operator

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.

Name Type Description
aggregation

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

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

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

granularity

A granularidade das linhas no relatório.

grouping

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

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

ReportConfigDatasetConfiguration

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

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

Name Type Description
and

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

dimensions

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

or

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

tags

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

ReportConfigGrouping

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

Name Type Description
name
  • string

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

type

Tem o tipo da coluna para agrupar.

ReportConfigSorting

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

Name Type Description
direction

Direção de classificação.

name
  • string

O nome da coluna a ser classificada.

ReportConfigSortingType

Direção de classificação.

Name Type Description
Ascending
  • string
Descending
  • string

ReportConfigTimePeriod

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

Name Type Description
from
  • string

A data de início da qual extrair dados.

to
  • string

A data de término para a qual extrair dados.

ReportGranularityType

A granularidade das linhas no relatório.

Name Type Description
Daily
  • string
Monthly
  • string

ReportTimeframeType

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

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

Name Type Description
Usage
  • string

View

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

Name Type 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 ou não a versão mais recente.

id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.accumulated

Mostrar os custos acumulados ao longo do tempo.

properties.chart

Tipo de gráfico da exibição principal na Análise de Custos. Obrigatórios.

properties.createdOn
  • string

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

properties.currency
  • string

Conversor de Moedas 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 do modo de exibição. Obrigatórios.

properties.kpis

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

properties.metric

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

Configuração de três sub-exibições na interface do usuário da Análise de Custos.

properties.query.dataSet

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

Tem um período de tempo para extrair dados para o relatório.

properties.query.timeframe

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

properties.query.type

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 para salvar a exibição. Isso inclui 'subscriptions/{subscriptionId}' para escopo de assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '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}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' para o escopo ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para escopo ExternalSubscription.

type
  • string

Tipo de recurso.