Views - Create Or Update By Scope

ビューを作成または更新する操作。 更新操作では、要求で最新の eTag を設定する必要があります。 get 操作を実行することで、最新の eTag を取得できます。 作成操作には eTag は必要ありません。

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

URI パラメーター

Name In Required Type Description
scope
path True
  • string

ビュー操作に関連付けられているスコープ。 これには、サブスクリプション スコープの 'subscriptions/{subscriptionId}' が含まれます。 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccount スコープの enrollmentAccountId}'、BillingProfile スコープの 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope.

viewName
path True
  • string

ビューの名前

api-version
query True
  • string

クライアント要求で使用する API のバージョン。

要求本文

Name Required Type Description
properties.query.timeframe True

レポートのデータをプルする期間。 カスタムの場合は、特定の期間を指定する必要があります。

properties.query.type True

レポートの種類。 使用状況は実際の使用状況を表し、予測は予測データを表し、UsageAndForecast は使用状況と予測データの両方を表します。 実際の使用状況と予測データは、日付に基づいて区別できます。

eTag
  • string

リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。

properties.accumulated

時間の経過に伴う累積コストを表示します。

properties.chart

コスト分析のメイン ビューのグラフの種類。 必須。

properties.displayName
  • string

ビューのユーザー入力名。 必須。

properties.kpis

コスト分析 UI に表示する KPI の一覧。

properties.metric

コストを表示するときに使用するメトリック。

properties.pivots

Cost Analysis UI での 3 つのサブビューの構成。

properties.query.dataSet

このレポート構成にデータの定義があります。

properties.query.includeMonetaryCommitment
  • boolean

true の場合、レポートには年額コミットメントが含まれます。

properties.query.timePeriod

レポートのデータをプルするための期間があります。

properties.scope
  • string

ビューを保存するコスト管理スコープ。 これには、サブスクリプション スコープの 'subscriptions/{subscriptionId}' が含まれます。 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccount スコープの enrollmentAccountId}'、BillingProfile スコープの 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' は ExternalBillingAccount スコープ、ExternalSubscription スコープの場合は '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' です。

応答

Name Type Description
200 OK

OK です。 要求は成功しました。

201 Created

作成されました。

Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryします。

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

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"
      }
    ]
  }
}

定義

AccumulatedType

時間の経過に伴う累積コストを表示します。

ChartType

コスト分析のメイン ビューのグラフの種類。 必須。

ErrorDetails

エラーの詳細。

ErrorResponse

エラー応答は、サービスが受信要求を処理できないことを示します。 この理由は、エラー メッセージに記載されています。

いくつかのエラー応答:

  • 429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時間を待ってから再試行します。

  • 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。

FunctionType

使用する集計関数の名前。

KpiProperties

各 KPI には、'type' キーと 'enabled' キーが含まれている必要があります。

KpiTypeType

KPI の種類 (予測、予算)。

MetricType

コストを表示するときに使用するメトリック。

OperatorType

比較に使用する演算子。

PivotProperties

各ピボットには、'type' と 'name' が含まれている必要があります。

PivotTypeType

ビューに表示するデータ型。

ReportConfigAggregation

レポートで使用する集計式。

ReportConfigColumnType

レポート内の列の型。

ReportConfigComparisonExpression

レポートで使用する比較式。

ReportConfigDataset

レポートに存在するデータの定義。

ReportConfigDatasetConfiguration

レポート内のデータセットの構成。

ReportConfigFilter

レポートで使用するフィルター式。

ReportConfigGrouping

レポートで使用する式別のグループ。

ReportConfigSorting

レポートで使用する式別の順序。

ReportConfigSortingType

並べ替えの方向。

ReportConfigTimePeriod

レポートのデータをプルするための開始日と終了日。

ReportGranularityType

レポート内の行の粒度。

ReportTimeframeType

レポートのデータをプルするための時間枠。 カスタムの場合は、特定の期間を指定する必要があります。

ReportType

レポートの種類。 使用量は実際の使用状況を表し、予測は予測データを表し、UsageAndForecast は使用状況と予測データの両方を表します。 実際の使用状況と予測データは、日付に基づいて区別できます。

View

コスト分析の状態と構成。

AccumulatedType

時間の経過に伴う累積コストを表示します。

Name Type Description
false
  • string
true
  • string

ChartType

コスト分析のメイン ビューのグラフの種類。 必須。

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

ErrorDetails

エラーの詳細。

Name Type Description
code
  • string

エラー コード。

message
  • string

操作が失敗した理由を示すエラー メッセージ。

ErrorResponse

エラー応答は、サービスが受信要求を処理できないことを示します。 この理由は、エラー メッセージに記載されています。

いくつかのエラー応答:

  • 429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時間を待ってから再試行します。

  • 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。

Name Type Description
error

エラーの詳細。

FunctionType

使用する集計関数の名前。

Name Type Description
Sum
  • string

KpiProperties

各 KPI には、'type' キーと 'enabled' キーが含まれている必要があります。

Name Type Description
enabled
  • boolean

UI に KPI を表示しますか?

id
  • string

メトリック (予算) に関連するリソースの ID。

type

KPI の種類 (予測、予算)。

KpiTypeType

KPI の種類 (予測、予算)。

Name Type Description
Budget
  • string
Forecast
  • string

MetricType

コストを表示するときに使用するメトリック。

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

OperatorType

比較に使用する演算子。

Name Type Description
Contains
  • string
In
  • string

PivotProperties

各ピボットには、'type' と 'name' が含まれている必要があります。

Name Type Description
name
  • string

ビューに表示するデータ フィールド。

type

ビューに表示するデータ型。

PivotTypeType

ビューに表示するデータ型。

Name Type Description
Dimension
  • string
TagKey
  • string

ReportConfigAggregation

レポートで使用する集計式。

Name Type Description
function

使用する集計関数の名前。

name
  • string

集計する列の名前。

ReportConfigColumnType

レポート内の列の型。

Name Type Description
Dimension
  • string
Tag
  • string

ReportConfigComparisonExpression

レポートで使用する比較式。

Name Type Description
name
  • string

比較で使用する列の名前。

operator

比較に使用する演算子。

values
  • string[]

比較に使用する値の配列

ReportConfigDataset

レポートに存在するデータの定義。

Name Type Description
aggregation

レポートで使用する集計式のディクショナリ。 ディクショナリ内の各項目のキーは、集計列の別名です。 レポートには、最大 2 つの集計句を含めることができます。

configuration

レポート内のデータの構成情報が含まれます。 集計とグループ化が指定されている場合、構成は無視されます。

filter

レポートで使用するフィルター式があります。

granularity

レポート内の行の粒度。

grouping

レポートで使用する式別のグループの配列。 レポートには、句ごとに最大 2 つのグループを含めることができます。

sorting

レポートで使用する式別の順序の配列。

ReportConfigDatasetConfiguration

レポート内のデータセットの構成。

Name Type Description
columns
  • string[]

レポートに含める列名の配列。 任意の有効なレポート列名を使用できます。 指定されていない場合は、レポートにすべての列が含まれます。

ReportConfigFilter

レポートで使用するフィルター式。

Name Type Description
and

論理 "AND" 式。 少なくとも 2 つの項目が必要です。

dimensions

ディメンションの比較式を持つ

or

論理 "OR" 式。 少なくとも 2 つの項目が必要です。

tags

タグの比較式を持つ

ReportConfigGrouping

レポートで使用する式別のグループ。

Name Type Description
name
  • string

グループ化する列の名前。 このバージョンでは、可能な限り低いグレインのサブスクリプションがサポートされています。

type

グループ化する列の型を持つ。

ReportConfigSorting

レポートで使用する式別の順序。

Name Type Description
direction

並べ替えの方向。

name
  • string

並べ替える列の名前。

ReportConfigSortingType

並べ替えの方向。

Name Type Description
Ascending
  • string
Descending
  • string

ReportConfigTimePeriod

レポートのデータをプルするための開始日と終了日。

Name Type Description
from
  • string

データをプルする開始日。

to
  • string

データをプルする終了日。

ReportGranularityType

レポート内の行の粒度。

Name Type Description
Daily
  • string
Monthly
  • string

ReportTimeframeType

レポートのデータをプルするための時間枠。 カスタムの場合は、特定の期間を指定する必要があります。

Name Type Description
Custom
  • string
MonthToDate
  • string
WeekToDate
  • string
YearToDate
  • string

ReportType

レポートの種類。 使用量は実際の使用状況を表し、予測は予測データを表し、UsageAndForecast は使用状況と予測データの両方を表します。 実際の使用状況と予測データは、日付に基づいて区別できます。

Name Type Description
Usage
  • string

View

コスト分析の状態と構成。

Name Type Description
eTag
  • string

リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。

id
  • string

リソース ID。

name
  • string

リソース名。

properties.accumulated

時間の経過に伴う累積コストを表示します。

properties.chart

コスト分析のメイン ビューのグラフの種類。 必須。

properties.createdOn
  • string

ユーザーがこのビューを作成した日付。

properties.currency
  • string

現在のビューの通貨。

properties.dateRange
  • string

現在のビューの日付範囲。

properties.displayName
  • string

ビューのユーザー入力名。 必須。

properties.kpis

コスト分析 UI に表示する KPI の一覧。

properties.metric

コストを表示するときに使用するメトリック。

properties.modifiedOn
  • string

ユーザーがこのビューを最後に変更した日付。

properties.pivots

コスト分析 UI での 3 つのサブビューの構成。

properties.query.dataSet

このレポート構成にデータの定義があります。

properties.query.includeMonetaryCommitment
  • boolean

true の場合、レポートには年額コミットメントが含まれます。

properties.query.timePeriod

レポートのデータをプルするための期間があります。

properties.query.timeframe

レポートのデータをプルするための時間枠。 カスタムの場合は、特定の期間を指定する必要があります。

properties.query.type

レポートの種類。 使用量は実際の使用状況を表し、予測は予測データを表し、UsageAndForecast は使用状況と予測データの両方を表します。 実際の使用状況と予測データは、日付に基づいて区別できます。

properties.scope
  • string

ビューを保存する Cost Management スコープ。 これには、サブスクリプション スコープの 'subscriptions/{subscriptionId}' が含まれます。 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccount スコープの enrollmentAccountId}'、BillingProfile スコープの 'providers/Microsoft.Billing/billingAccountId}/billingProfiles/{billingProfileId}' 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccount スコープの externalBillingAccountName}'、ExternalSubscription スコープの場合は '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' です。

type
  • string

リソースの種類。