Forecast - External Cloud Provider Usage

リファレンス

サービス:: Cost Management

API バージョン:: 2023-11-01

定義されている外部クラウドプロバイダーの種類の予測料金をListsします。

POST https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast?api-version=2023-11-01

省略可能なパラメーターを含む:

POST https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast?$filter={$filter}&api-version=2023-11-01

URI パラメーター

名前	/	必須	型	説明
externalCloudProviderId	path	True	string	これは、リンクされたアカウントの場合は '{externalSubscriptionId}'、ディメンション/クエリ操作で使用される統合アカウントの場合は '{externalBillingAccountId}' にすることができます。
externalCloudProviderType	path	True	externalCloudProviderType	ディメンション/クエリ操作に関連付けられている外部クラウドプロバイダーの種類。これには、リンクされたアカウントの 'externalSubscriptions' と統合アカウントの 'externalBillingAccounts' が含まれます。
api-version	query	True	string	この操作に使用する API バージョン。
$filter	query		string	プロパティ/usageDate (Utc 時刻)、properties/chargeType、または properties/grain で予測をフィルター処理するために使用できます。フィルターは、'eq'、'lt'、'gt'、'le'、'ge'、および 'and' をサポートしています。現在、'ne'、'or'、または 'not' はサポートされていません。

要求本文

名前	必須	型	説明
dataset	True	ForecastDataset	この予測のデータの定義があります。
timeframe	True	ForecastTimeframe	予測のデータをプルするための時間枠。カスタムの場合は、特定の期間を指定する必要があります。
type	True	ForecastType	予測の種類。
includeActualCost		boolean	actualCost が含まれるかどうかを判断するブール値。
includeFreshPartialCost		boolean	FreshPartialCost が含まれるかどうかを判断するブール値。
timePeriod		ForecastTimePeriod	予測のデータをプルするための期間があります。

応答

名前	型	説明
200 OK	ForecastResult	OK です。要求は成功しました。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ExternalBillingAccountForecast

ExternalSubscriptionForecast

ExternalBillingAccountForecast

要求のサンプル

HTTP

POST https://management.azure.com/providers/Microsoft.CostManagement/externalBillingAccounts/100/forecast?api-version=2023-11-01

{
  "type": "Usage",
  "timeframe": "Custom",
  "timePeriod": {
    "from": "2022-08-01T00:00:00+00:00",
    "to": "2022-08-31T23:59:59+00:00"
  },
  "dataset": {
    "granularity": "Daily",
    "aggregation": {
      "totalCost": {
        "name": "Cost",
        "function": "Sum"
      }
    },
    "filter": {
      "and": [
        {
          "or": [
            {
              "dimensions": {
                "name": "ResourceLocation",
                "operator": "In",
                "values": [
                  "East US",
                  "West Europe"
                ]
              }
            },
            {
              "tags": {
                "name": "Environment",
                "operator": "In",
                "values": [
                  "UAT",
                  "Prod"
                ]
              }
            }
          ]
        },
        {
          "dimensions": {
            "name": "ResourceGroup",
            "operator": "In",
            "values": [
              "API"
            ]
          }
        }
      ]
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d",
  "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d",
  "type": "Microsoft.CostManagement/query",
  "properties": {
    "nextLink": null,
    "columns": [
      {
        "name": "PreTaxCost",
        "type": "Number"
      },
      {
        "name": "CostStatus",
        "type": "String"
      },
      {
        "name": "Currency",
        "type": "String"
      }
    ],
    "rows": [
      [
        0,
        "Forecast",
        "USD"
      ],
      [
        30.2572751438,
        "Forecast",
        "USD"
      ],
      [
        0.07675760200000002,
        "Forecast",
        "USD"
      ],
      [
        50.43096419040001,
        "Forecast",
        "USD"
      ]
    ]
  }
}

ExternalSubscriptionForecast

要求のサンプル

HTTP

POST https://management.azure.com/providers/Microsoft.CostManagement/externalSubscriptions/100/forecast?api-version=2023-11-01

{
  "type": "Usage",
  "timeframe": "Custom",
  "timePeriod": {
    "from": "2022-08-01T00:00:00+00:00",
    "to": "2022-08-31T23:59:59+00:00"
  },
  "dataset": {
    "granularity": "Daily",
    "aggregation": {
      "totalCost": {
        "name": "Cost",
        "function": "Sum"
      }
    },
    "filter": {
      "and": [
        {
          "or": [
            {
              "dimensions": {
                "name": "ResourceLocation",
                "operator": "In",
                "values": [
                  "East US",
                  "West Europe"
                ]
              }
            },
            {
              "tags": {
                "name": "Environment",
                "operator": "In",
                "values": [
                  "UAT",
                  "Prod"
                ]
              }
            }
          ]
        },
        {
          "dimensions": {
            "name": "ResourceGroup",
            "operator": "In",
            "values": [
              "API"
            ]
          }
        }
      ]
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d",
  "name": "d99477af-7510-40ee-aca2-e59bdca0d10d",
  "type": "Microsoft.CostManagement/query",
  "properties": {
    "nextLink": null,
    "columns": [
      {
        "name": "PreTaxCost",
        "type": "Number"
      },
      {
        "name": "UsageDate",
        "type": "Number"
      },
      {
        "name": "CostStatus",
        "type": "String"
      },
      {
        "name": "Currency",
        "type": "String"
      }
    ],
    "rows": []
  }
}

定義

名前	説明
ErrorDetails	エラーの詳細。
ErrorResponse	エラー応答は、サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに示されています。いくつかのエラー応答: 429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時間を待ってから再試行します。 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。
externalCloudProviderType	ディメンション/クエリ操作に関連付けられている外部クラウドプロバイダーの種類。これには、リンクされたアカウントの 'externalSubscriptions' と統合アカウントの 'externalBillingAccounts' が含まれます。
ForecastAggregation	予測で使用する集計式。
ForecastColumn	予測列のプロパティ
ForecastComparisonExpression	予測で使用する比較式。
ForecastDataset	予測に存在するデータの定義。
ForecastDatasetConfiguration	予測内のデータセットの構成。
ForecastDefinition	予測の定義。
ForecastFilter	エクスポートで使用するフィルター式。
ForecastOperatorType	比較に使用する演算子。
ForecastResult	予測の結果。グループ化と集計の下に一覧表示されるすべての列が含まれます。
ForecastTimeframe	予測のデータをプルするための時間枠。
ForecastTimePeriod	予測のデータをプルするための期間があります。
ForecastType	予測の種類。
FunctionName	集計する列の名前。
FunctionType	使用する集計関数の名前。
GranularityType	予測内の行の粒度。

ErrorDetails

エラーの詳細。

名前	型	説明
code	string	エラーコード。
message	string	操作が失敗した理由を示すエラーメッセージ。

ErrorResponse

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

いくつかのエラー応答:

429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時間を待ってから再試行します。
503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。

名前	型	説明
error	ErrorDetails	エラーの詳細。

externalCloudProviderType

ディメンション/クエリ操作に関連付けられている外部クラウドプロバイダーの種類。これには、リンクされたアカウントの 'externalSubscriptions' と統合アカウントの 'externalBillingAccounts' が含まれます。

名前	型	説明
externalBillingAccounts	string
externalSubscriptions	string

ForecastAggregation

予測で使用する集計式。

名前	型	説明
function	FunctionType	使用する集計関数の名前。
name	FunctionName	集計する列の名前。

ForecastColumn

予測列のプロパティ

名前	型	説明
name	string	列の名前。
type	string	列の型。

ForecastComparisonExpression

予測で使用する比較式。

名前	型	説明
name	string	比較に使用する列の名前。
operator	ForecastOperatorType	比較に使用する演算子。
values	string[]	比較に使用する値の配列

ForecastDataset

予測に存在するデータの定義。

名前	型	説明
aggregation	<string, ForecastAggregation>	予測で使用する集計式のディクショナリ。ディクショナリ内の各項目のキーは、集計列の別名です。 forecast には、最大 2 つの集計句を含めることができます。
configuration	ForecastDatasetConfiguration	エクスポート内のデータの構成情報があります。集計とグループ化が指定されている場合、構成は無視されます。
filter	ForecastFilter	予測で使用するフィルター式があります。
granularity	GranularityType	予測内の行の粒度。

ForecastDatasetConfiguration

予測内のデータセットの構成。

名前	型	説明
columns	string[]	予測に含める列名の配列。有効な予測列名は許可されます。指定しない場合、予測にはすべての列が含まれます。

ForecastDefinition

予測の定義。

名前	型	説明
dataset	ForecastDataset	この予測のデータの定義があります。
includeActualCost	boolean	actualCost が含まれるかどうかを判断するブール値。
includeFreshPartialCost	boolean	FreshPartialCost が含まれるかどうかを判断するブール値。
timePeriod	ForecastTimePeriod	予測のデータをプルするための期間があります。
timeframe	ForecastTimeframe	予測のデータをプルするための時間枠。カスタムの場合は、特定の期間を指定する必要があります。
type	ForecastType	予測の種類。

ForecastFilter

エクスポートで使用するフィルター式。

名前	型	説明
and	ForecastFilter[]	論理 "AND" 式。少なくとも 2 つの項目が必要です。
dimensions	ForecastComparisonExpression	ディメンションの比較式がある
or	ForecastFilter[]	論理 "OR" 式。少なくとも 2 つの項目が必要です。
tags	ForecastComparisonExpression	タグの比較式がある

ForecastOperatorType

比較に使用する演算子。

名前	型	説明
In	string

ForecastResult

予測の結果。グループ化と集計の下に一覧表示されるすべての列が含まれます。

名前	型	説明
eTag	string	リソースの ETag。
id	string	リソース ID。
location	string	リソースの場所。
name	string	リソース名。
properties.columns	ForecastColumn[]	列の配列
properties.nextLink	string	結果の次のページへのリンク (URL)。
properties.rows	Rows[]	行の配列
sku	string	リソースの SKU。
tags	object	リソースタグ。
type	string	リソースの種類。

ForecastTimeframe

予測のデータをプルするための時間枠。

名前	型	説明
Custom	string

ForecastTimePeriod

予測のデータをプルするための期間があります。

名前	型	説明
from	string	データをプルする開始日。
to	string	データをプルする終了日。

ForecastType

予測の種類。

名前	型	説明
ActualCost	string
AmortizedCost	string
Usage	string

FunctionName

集計する列の名前。

名前	型	説明
Cost	string
CostUSD	string
PreTaxCost	string
PreTaxCostUSD	string

FunctionType

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

名前	型	説明
Sum	string

GranularityType

予測内の行の粒度。

名前	型	説明
Daily	string

次の方法で共有

Forecast - External Cloud Provider Usage

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

ExternalBillingAccountForecast

要求のサンプル

応答のサンプル

ExternalSubscriptionForecast

要求のサンプル

応答のサンプル

定義

ErrorDetails

ErrorResponse

externalCloudProviderType

ForecastAggregation

ForecastColumn

ForecastComparisonExpression

ForecastDataset

ForecastDatasetConfiguration

ForecastDefinition

ForecastFilter

ForecastOperatorType

ForecastResult

ForecastTimeframe

ForecastTimePeriod

ForecastType

FunctionName

FunctionType

GranularityType

その他のリソース