次の方法で共有

Budgets - Create Or Update

  • リファレンス
サービス:
Cost Management
API バージョン:
2024-08-01

予算を作成または更新する操作。 必要に応じて、コンカレンシー制御の形式として eTag を指定できます。 特定の予算の最新の eTag を取得するには、put 操作の前に get 操作を実行します。

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

URI パラメーター

名前 / 必須 型 説明
budgetName
 path True

string

minLength: 1
maxLength: 63
pattern: ^[a-zA-Z0-9_-]+$

予算名。
scope
 path True

string

予算操作に関連付けられているスコープ。

CategoryType: Cost でサポートされているスコープ

Azure RBAC スコープ:

  • サブスクリプション スコープの '/subscriptions/{subscriptionId}/'
  • resourceGroup スコープの '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'
  • 管理グループ スコープの '/providers/Microsoft.Management/managementGroups/{managementGroupId}'

EA (Enterprise Agreement) のスコープ:

  • 課金アカウント スコープの '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}'
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope
  • EnrollmentAccount スコープの '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}'

MCA (Modern Customer Agreement) のスコープ:

  • 課金アカウント スコープの '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}'
  • billingProfile スコープの '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}'
  • invoiceSection スコープの '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}'
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' (CSP のみ)

CategoryType: ReservationUtilization でサポートされているスコープ

EA (Enterprise Agreement) のスコープ:

  • 課金アカウント スコープの '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}'

MCA (Modern Customer Agreement) のスコープ:

  • billingProfile スコープの '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' (CSP 以外のみ)
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' (CSP のみ)
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

要求本文

名前 必須 型 説明
properties.category True

CategoryType

予算のカテゴリ。

  • "コスト" は予算を定義します。
  • "ReservationUtilization" は、予約使用率アラート ルールを定義します。
properties.timeGrain True

TimeGrainType

予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType: Cost でサポートされている timeGrainTypes

  • マンスリー

  • 季刊

  • 毎年

  • BillingMonth*

  • BillingQuarter*

  • BillingAnnual*

    *Web Direct のお客様のみがサポートされます。

CategoryType でサポートされている timeGrainTypes: ReservationUtilization

  • Last7Days
  • Last30Days

CategoryType に必要: Cost、ReservationUtilization。
properties.timePeriod True

BudgetTimePeriod

予算のアクティブ期間を定義する期間。 予算は startDate 以降のデータを評価し、endDate で期限切れになります。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType に必要: Cost、ReservationUtilization。
eTag

string

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

number

予算で追跡するコストの合計量。

CategoryType でサポート: コスト。

CategoryType(s): Cost に必要です。
properties.filter

BudgetFilter

ユーザー指定のディメンションやタグで予算をフィルター処理するために使用できます。

CategoryType でサポート: Cost、ReservationUtilization。
properties.notifications

<string,  Notification>

予算に関連付けられている通知の辞書。

CategoryType でサポート: Cost、ReservationUtilization。

  • CategoryType: Cost - Budget の制約には、thresholdType で最大 5 つの通知を含めることができます。実際の通知と thresholdType: Forecasted の通知は 5 つまでです。
  • CategoryType: ReservationUtilization の制約 - 許可される通知は 1 つだけです。 thresholdType は適用されません。

応答

名前 型 説明
200 OK

Budget

わかりました。 要求が成功し、予算の更新が完了しました。
201 Created

Budget

作成。
Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

CreateOrUpdate-Cost-Subscription-Budget
CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule
CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter
CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter
CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservationIdFilter
CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservedResourceTypeFilter
CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule.json
CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservationIdFilter
CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservedResourceTypeFilter
CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule.json

CreateOrUpdate-Cost-Subscription-Budget

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2024-10-31T00:00:00Z"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget",
  "name": "TestBudget",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2024-10-31T00:00:00Z"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}
状態コード:
200 
{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget",
  "name": "TestBudget",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2024-10-31T00:00:00Z"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule

要求のサンプル

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last7Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {},
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Weekly",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last7Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {},
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Weekly",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}
状態コード:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last7Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {},
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Weekly",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter

要求のサンプル

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last7Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservationId",
        "operator": "In",
        "values": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000001",
          "00000000-0000-0000-0000-000000000002"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Weekly",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last7Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservationId",
        "operator": "In",
        "values": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000001",
          "00000000-0000-0000-0000-000000000002"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Weekly",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}
状態コード:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last7Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservationId",
        "operator": "In",
        "values": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000001",
          "00000000-0000-0000-0000-000000000002"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Weekly",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter

要求のサンプル

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last7Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservedResourceType",
        "operator": "In",
        "values": [
          "VirtualMachines",
          "SqlDatabases",
          "CosmosDb"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Weekly",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last7Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservedResourceType",
        "operator": "In",
        "values": [
          "VirtualMachines",
          "SqlDatabases",
          "CosmosDb"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Weekly",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}
状態コード:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last7Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservedResourceType",
        "operator": "In",
        "values": [
          "VirtualMachines",
          "SqlDatabases",
          "CosmosDb"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Weekly",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservationIdFilter

要求のサンプル

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservationId",
        "operator": "In",
        "values": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000001",
          "00000000-0000-0000-0000-000000000002"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservationId",
        "operator": "In",
        "values": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000001",
          "00000000-0000-0000-0000-000000000002"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}
状態コード:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservationId",
        "operator": "In",
        "values": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000001",
          "00000000-0000-0000-0000-000000000002"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservedResourceTypeFilter

要求のサンプル

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservedResourceType",
        "operator": "In",
        "values": [
          "VirtualMachines",
          "SqlDatabases",
          "CosmosDb"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservedResourceType",
        "operator": "In",
        "values": [
          "VirtualMachines",
          "SqlDatabases",
          "CosmosDb"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}
状態コード:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservedResourceType",
        "operator": "In",
        "values": [
          "VirtualMachines",
          "SqlDatabases",
          "CosmosDb"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule.json

要求のサンプル

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {},
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {},
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}
状態コード:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {},
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservationIdFilter

要求のサンプル

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservationId",
        "operator": "In",
        "values": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000001",
          "00000000-0000-0000-0000-000000000002"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservationId",
        "operator": "In",
        "values": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000001",
          "00000000-0000-0000-0000-000000000002"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}
状態コード:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservationId",
        "operator": "In",
        "values": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000001",
          "00000000-0000-0000-0000-000000000002"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservedResourceTypeFilter

要求のサンプル

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservedResourceType",
        "operator": "In",
        "values": [
          "VirtualMachines",
          "SqlDatabases",
          "CosmosDb"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservedResourceType",
        "operator": "In",
        "values": [
          "VirtualMachines",
          "SqlDatabases",
          "CosmosDb"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}
状態コード:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {
      "dimensions": {
        "name": "ReservedResourceType",
        "operator": "In",
        "values": [
          "VirtualMachines",
          "SqlDatabases",
          "CosmosDb"
        ]
      }
    },
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule.json

要求のサンプル

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {},
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {},
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}
状態コード:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule",
  "name": "TestAlertRule",
  "type": "Microsoft.CostManagement/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "ReservationUtilization",
    "timeGrain": "Last30Days",
    "timePeriod": {
      "startDate": "2023-04-01T00:00:00Z",
      "endDate": "2025-04-01T00:00:00Z"
    },
    "filter": {},
    "notifications": {
      "Actual_LessThan_99_Percent": {
        "enabled": true,
        "operator": "LessThan",
        "threshold": 99,
        "frequency": "Daily",
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ]
      }
    }
  }
}

定義

名前 説明
Budget

予算リソース。
BudgetComparisonExpression

予算で使用する比較式。
BudgetFilter

ユーザー指定のディメンションやタグで予算をフィルター処理するために使用できます。

CategoryType でサポート: Cost、ReservationUtilization。
BudgetFilterProperties

予算をフィルター処理するディメンションまたはタグ。

CategoryType でサポート: Cost、ReservationUtilization。
BudgetNotificationOperatorType

比較演算子。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType: Cost でサポートされている演算子

  • GreaterThan
  • GreaterThanOrEqualTo

CategoryType: ReservationUtilization でサポートされている演算子

  • LessThan
BudgetOperatorType

比較に使用する演算子。
BudgetTimePeriod

予算のアクティブ期間を定義する期間。 予算は startDate 以降のデータを評価し、endDate で期限切れになります。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType に必要: Cost、ReservationUtilization。
CategoryType

予算のカテゴリ。

  • "コスト" は予算を定義します。
  • "ReservationUtilization" は、予約使用率アラート ルールを定義します。
CultureCode

受信者が通知を受け取る言語

CategoryType でサポート: Cost、ReservationUtilization。
CurrentSpend

予算に対して追跡されている現在のコストの量。

CategoryType でサポート: コスト。
ErrorDetails

エラーの詳細。
ErrorResponse

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

いくつかのエラー応答:

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

  • 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻を待機した後に再試行します。
ForecastSpend

予算の追跡対象となる予測コスト。

CategoryType でサポート: コスト。
Frequency

通知の頻度。 しきい値違反のアラートをトリガーした後に通知がサイレントになる期間を表します。 指定しない場合、頻度は timeGrain (週単位で timeGrain: Last7Days、Monthly when timeGrain: Last30Days) に基づいて既定で設定されます。

CategoryType でサポート: ReservationUtilization。
Notification

予算に関連付けられている通知。

CategoryType でサポート: Cost、ReservationUtilization。
ThresholdType

しきい値の種類。

CategoryType でサポート: コスト。
TimeGrainType

予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType: Cost でサポートされている timeGrainTypes

  • マンスリー

  • 季刊

  • 毎年

  • BillingMonth*

  • BillingQuarter*

  • BillingAnnual*

    *Web Direct のお客様のみがサポートされます。

CategoryType でサポートされている timeGrainTypes: ReservationUtilization

  • Last7Days
  • Last30Days

CategoryType に必要: Cost、ReservationUtilization。

Budget

Object

予算リソース。

名前 型 説明
eTag

string

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

string

リソース ID。
name

string

リソース名。
properties.amount

number

予算で追跡するコストの合計量。

CategoryType でサポート: コスト。

CategoryType(s): Cost に必要です。
properties.category

CategoryType

予算のカテゴリ。

  • "コスト" は予算を定義します。
  • "ReservationUtilization" は、予約使用率アラート ルールを定義します。
properties.currentSpend

CurrentSpend

予算に対して追跡されている現在のコストの量。

CategoryType でサポート: コスト。
properties.filter

BudgetFilter

ユーザー指定のディメンションやタグで予算をフィルター処理するために使用できます。

CategoryType でサポート: Cost、ReservationUtilization。
properties.forecastSpend

ForecastSpend

予算の追跡対象となる予測コスト。

CategoryType でサポート: コスト。
properties.notifications

<string,  Notification>

予算に関連付けられている通知の辞書。

CategoryType でサポート: Cost、ReservationUtilization。

  • CategoryType: Cost - Budget の制約には、thresholdType で最大 5 つの通知を含めることができます。実際の通知と thresholdType: Forecasted の通知は 5 つまでです。
  • CategoryType: ReservationUtilization の制約 - 許可される通知は 1 つだけです。 thresholdType は適用されません。
properties.timeGrain

TimeGrainType

予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType: Cost でサポートされている timeGrainTypes

  • マンスリー

  • 季刊

  • 毎年

  • BillingMonth*

  • BillingQuarter*

  • BillingAnnual*

    *Web Direct のお客様のみがサポートされます。

CategoryType でサポートされている timeGrainTypes: ReservationUtilization

  • Last7Days
  • Last30Days

CategoryType に必要: Cost、ReservationUtilization。
properties.timePeriod

BudgetTimePeriod

予算のアクティブ期間を定義する期間。 予算は startDate 以降のデータを評価し、endDate で期限切れになります。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType に必要: Cost、ReservationUtilization。
type

string

リソースの種類。

BudgetComparisonExpression

Object

予算で使用する比較式。

名前 型 説明
name

string

比較に使用する列の名前。
operator

BudgetOperatorType

比較に使用する演算子。
values

string[]

比較に使用する値の配列

BudgetFilter

Object

ユーザー指定のディメンションやタグで予算をフィルター処理するために使用できます。

CategoryType でサポート: Cost、ReservationUtilization。

名前 型 説明
and

BudgetFilterProperties[]

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

CategoryType でサポート: コスト。
dimensions

BudgetComparisonExpression

ディメンションの比較式があります。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType: ReservationUtilization でサポートされているディメンション名

  • ReservationId
  • ReservedResourceType
tags

BudgetComparisonExpression

タグの比較式を持つ。

CategoryType でサポート: コスト。

BudgetFilterProperties

Object

予算をフィルター処理するディメンションまたはタグ。

CategoryType でサポート: Cost、ReservationUtilization。

名前 型 説明
dimensions

BudgetComparisonExpression

ディメンションの比較式があります。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType: ReservationUtilization でサポートされているディメンション名

  • ReservationId
  • ReservedResourceType
tags

BudgetComparisonExpression

タグの比較式を持つ。

CategoryType でサポート: コスト。

BudgetNotificationOperatorType

列挙

比較演算子。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType: Cost でサポートされている演算子

  • GreaterThan
  • GreaterThanOrEqualTo

CategoryType: ReservationUtilization でサポートされている演算子

  • LessThan
値 説明
EqualTo

評価されたコストがしきい値と同じ場合、通知がトリガーされます。 注: コストがしきい値とまったく同じになる可能性が低く、アラートが欠落する可能性が低いので、この OperatorType を使用することはお勧めしません。 この OperatorType は、今後非推奨となる予定です。

CategoryType でサポート: コスト。
GreaterThan

評価されたコストがしきい値より大きい場合、通知がトリガーされます。 注: これは、予算アラートの構成時に推奨される OperatorType です。

CategoryType でサポート: コスト。
GreaterThanOrEqualTo

評価されたコストがしきい値以上の場合、通知がトリガーされます。

CategoryType でサポート: コスト。
LessThan

予約使用率アラート ルールのスコープ内の予約の使用率がしきい値の割合より小さい場合、通知がトリガーされます。

CategoryType でサポート: ReservationUtilization。

BudgetOperatorType

列挙

比較に使用する演算子。

値 説明
In

BudgetTimePeriod

Object

予算のアクティブ期間を定義する期間。 予算は startDate 以降のデータを評価し、endDate で期限切れになります。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType に必要: Cost、ReservationUtilization。

名前 型 説明
endDate

string (date-time)

予算の終了日。

  • CategoryType の制約: コスト - 制約なし。 指定しない場合、既定値は開始日から 10 年です。

  • CategoryType: ReservationUtilization - 終了日の制約は、開始日から 3 年以上経過することはできません。
startDate

string (date-time)

予算の開始日。

  • CategoryType: Cost の制約 - 月の最初の日付にする必要があり、終了日より小さくする必要があります。 予算開始日は、2017 年 6 月 1 日以降である必要があります。 将来の開始日は 12 か月を超えてはなりません。 過去の開始日は、タイムグレイン期間内に選択する必要があります。

  • CategoryType の制約: ReservationUtilization - 現在の日付以降で、終了日より小さい必要があります。

CategoryType

列挙

予算のカテゴリ。

  • "コスト" は予算を定義します。
  • "ReservationUtilization" は、予約使用率アラート ルールを定義します。
値 説明
Cost

Azure リソースの金額を金額に対して評価し、構成された通知しきい値に基づいてアラートを評価する予算。
ReservationUtilization

Azure の予約の使用率と、構成された通知しきい値に基づいてアラートを評価するアラート ルール。

CultureCode

列挙

受信者が通知を受け取る言語

CategoryType でサポート: Cost、ReservationUtilization。

値 説明
cs-cz
da-dk
de-de
en-gb
en-us
es-es
fr-fr
hu-hu
it-it
ja-jp
ko-kr
nb-no
nl-nl
pl-pl
pt-br
pt-pt
ru-ru
sv-se
tr-tr
zh-cn
zh-tw

CurrentSpend

Object

予算に対して追跡されている現在のコストの量。

CategoryType でサポート: コスト。

名前 型 説明
amount

number

予算によって追跡されているコストの合計金額。
unit

string

予算金額の数量単位。

ErrorDetails

Object

エラーの詳細。

名前 型 説明
code

string

エラー コード。
message

string

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

ErrorResponse

Object

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

いくつかのエラー応答:

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

  • 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻を待機した後に再試行します。

名前 型 説明
error

ErrorDetails

エラーの詳細。

ForecastSpend

Object

予算の追跡対象となる予測コスト。

CategoryType でサポート: コスト。

名前 型 説明
amount

number

予算によって追跡されている合計期間の予測コスト。 この値は、予算に予測アラートの種類が含まれている場合にのみ提供されます。
unit

string

予算金額の数量単位。

Frequency

列挙

通知の頻度。 しきい値違反のアラートをトリガーした後に通知がサイレントになる期間を表します。 指定しない場合、頻度は timeGrain (週単位で timeGrain: Last7Days、Monthly when timeGrain: Last30Days) に基づいて既定で設定されます。

CategoryType でサポート: ReservationUtilization。

値 説明
Daily

しきい値違反が発生し、アラートが発生した後は、次のカレンダー日までそれ以上のアラートは送信されません。
Monthly

しきい値違反が発生し、アラートが発生した後、30 日間、それ以上のアラートは送信されません。
Weekly

しきい値違反が発生し、アラートが発生した後、7 日間、それ以上のアラートは送信されません。

Notification

Object

予算に関連付けられている通知。

CategoryType でサポート: Cost、ReservationUtilization。

名前 型 規定値 説明
contactEmails

string[]

しきい値に達したときに通知を送信する電子メール アドレス。 サブスクリプションまたはリソース グループのスコープで少なくとも 1 つの連絡先メールまたは連絡先グループを指定する必要があります。 その他のすべてのスコープには、少なくとも 1 つの連絡先メールが指定されている必要があります。

CategoryType でサポート: Cost、ReservationUtilization。
contactGroups

string[]

サブスクリプションまたはリソース グループのスコープのみ。 しきい値を超えたときに通知を送信するアクション グループ。 完全修飾 Azure リソース ID として指定する必要があります。

CategoryType でサポート: コスト。
contactRoles

string[]

サブスクリプションまたはリソース グループのスコープのみ。 しきい値に達したときに通知を送信する連絡先ロール。

CategoryType でサポート: コスト。
enabled

boolean

通知が有効かどうか。

CategoryType でサポート: Cost、ReservationUtilization。
frequency

Frequency

通知の頻度。 しきい値違反のアラートをトリガーした後に通知がサイレントになる期間を表します。 指定しない場合、頻度は timeGrain (週単位で timeGrain: Last7Days、Monthly when timeGrain: Last30Days) に基づいて既定で設定されます。

CategoryType でサポート: ReservationUtilization。
locale

CultureCode

受信者が通知を受け取る言語

CategoryType でサポート: Cost、ReservationUtilization。
operator

BudgetNotificationOperatorType

比較演算子。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType: Cost でサポートされている演算子

  • GreaterThan
  • GreaterThanOrEqualTo

CategoryType: ReservationUtilization でサポートされている演算子

  • LessThan
threshold

number

通知に関連付けられているしきい値。 常に小数点以下 2 桁のパーセントです。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType: Cost - 0 ~ 1000 の間である必要があります。 コストがしきい値を超えたときに通知が送信されます。

CategoryType: ReservationUtilization - 0 ~ 100 の間である必要があります。 予約の使用率がしきい値を下回ると、通知が送信されます。
thresholdType

ThresholdType

Actual

しきい値の種類。

CategoryType でサポート: コスト。

ThresholdType

列挙

しきい値の種類。

CategoryType でサポート: コスト。

値 説明
Actual

実績コスト予算アラートは、実際の未収コストが割り当てられた予算を超えたときに通知します。
Forecasted

予測コスト予算アラートは、支出の傾向が予測コストの予測に依存するため、割り当てられた予算を超える可能性が高いという高度な通知を提供します。

TimeGrainType

列挙

予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。

CategoryType でサポート: Cost、ReservationUtilization。

CategoryType: Cost でサポートされている timeGrainTypes

  • マンスリー

  • 季刊

  • 毎年

  • BillingMonth*

  • BillingQuarter*

  • BillingAnnual*

    *Web Direct のお客様のみがサポートされます。

CategoryType でサポートされている timeGrainTypes: ReservationUtilization

  • Last7Days
  • Last30Days

CategoryType に必要: Cost、ReservationUtilization。

値 説明
Annually

予算は、現在の暦年のコストを金額に対して追跡します。

CategoryType: Cost でのみサポートされています。
BillingAnnual

予算は、現在の請求年度のコストを金額に対して追跡します。

CategoryType: Cost および Web Direct のお客様でのみサポートされます。
BillingMonth

予算は、現在の請求月のコストを金額に対して追跡します。

CategoryType: Cost および Web Direct のお客様でのみサポートされます。
BillingQuarter

予算は、現在の請求四半期のコストを金額に対して追跡します。

CategoryType: Cost および Web Direct のお客様でのみサポートされます。
Last30Days

予約使用率アラート ルールは、30 日間の使用率に基づいて予約を評価します。

CategoryType: ReservationUtilization でのみサポートされます。
Last7Days

予約使用率アラート ルールは、7 日間の使用率に基づいて予約を評価します。

CategoryType: ReservationUtilization でのみサポートされます。
Monthly

予算は、現在のカレンダー月のコストを金額に対して追跡します。

CategoryType: Cost でのみサポートされています。
Quarterly

予算は、現在のカレンダー 四半期のコストを金額に対して追跡します。

CategoryType: Cost でのみサポートされています。