Budgets - Create Or Update

Служба:
Consumption
Версия API:
2024-08-01

Операция создания или обновления бюджета. При желании можно указать eTag в виде элемента управления параллелизмом. Чтобы получить последнюю версию eTag для заданного бюджета, выполните операцию получения перед выполнением операции.

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

Параметры URI

Имя В Обязательно Тип Описание
budgetName
 path True

string

Имя бюджета.
scope
 path True

string

Полный идентификатор Azure Resource Manager ресурса.
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.

Текст запроса

Имя Обязательно Тип Описание
properties.amount True

number (decimal)

Общая сумма затрат для отслеживания с бюджетом
properties.category True

CategoryType

Категория бюджета, отслеживает ли бюджет затраты или использование.
properties.timeGrain True

TimeGrainType

Время, покрываемое бюджетом. Отслеживание суммы будет сброшено на основе времени. BillingMonth, BillingQuarter и BillingAnnual поддерживаются только клиентами WD.
properties.timePeriod True

BudgetTimePeriod

Имеет дату начала и окончания бюджета. Дата начала должна быть первой из месяца и должна быть меньше даты окончания. Дата начала бюджета должна быть 1 июня 2017 г. или после него. Дата начала будущего не должна превышать двенадцать месяцев. Последнюю дату начала следует выбрать в течение периода времени. Нет ограничений на дату окончания.
eTag

string

eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию или нет.
properties.filter

BudgetFilter

Может использоваться для фильтрации бюджетов по заданным пользователем измерениям и (или) тегам.
properties.notifications

<string,  Notification>

Словарь уведомлений, связанных с бюджетом. Бюджет может содержать до пяти уведомлений.

Ответы

Имя Тип Описание
200 OK

Budget

Операция обновления ресурса "Бюджет" выполнена успешно
201 Created

Budget

Операция по созданию ресурса "Бюджет" выполнена успешно
Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

CreateOrUpdateBudget

Образец запроса

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

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "amount": 100.65,
    "category": "Cost",
    "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": {
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "enabled": true,
        "locale": "en-us",
        "operator": "GreaterThan",
        "threshold": 80,
        "thresholdType": "Actual"
      }
    },
    "timeGrain": "Monthly",
    "timePeriod": {
      "endDate": "2018-10-31T00:00:00Z",
      "startDate": "2017-10-01T00:00:00Z"
    }
  }
}

Пример ответа

Код состояния:
200 
{
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget",
  "properties": {
    "amount": 100.65,
    "category": "Cost",
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "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": {
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "enabled": true,
        "locale": "en-us",
        "operator": "GreaterThan",
        "threshold": 80,
        "thresholdType": "Actual"
      }
    },
    "timeGrain": "Monthly",
    "timePeriod": {
      "endDate": "2018-10-31T00:00:00Z",
      "startDate": "2017-10-01T00:00:00Z"
    }
  }
}
Код состояния:
201 
{
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget",
  "properties": {
    "amount": 100.65,
    "category": "Cost",
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "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": {
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "enabled": true,
        "locale": "en-us",
        "operator": "GreaterThan",
        "threshold": 80,
        "thresholdType": "Actual"
      }
    },
    "timeGrain": "Monthly",
    "timePeriod": {
      "endDate": "2018-10-31T00:00:00Z",
      "startDate": "2017-10-01T00:00:00Z"
    }
  }
}

Определения

Имя Описание
Budget

Бюджетный ресурс.
BudgetComparisonExpression

Выражение сравнения, используемое в бюджетах.
BudgetFilter

Может использоваться для фильтрации бюджетов по группам ресурсов, ресурсам или счетчику.
BudgetFilterProperties

Измерения или теги для фильтрации бюджета по.
BudgetOperatorType

Оператор, используемый для сравнения.
BudgetTimePeriod

Дата начала и окончания бюджета.
CategoryType

Категория бюджета, отслеживает ли бюджет затраты или использование.
createdByType

Тип удостоверения, создавшего ресурс.
CultureCode

Язык, в котором получатель получит уведомление
CurrentSpend

Текущая сумма затрат, отслеживаемая для бюджета.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Ответ на ошибку
ForecastSpend

Прогнозируемые затраты, отслеживаемые для бюджета.
Notification

Уведомление, связанное с бюджетом.
OperatorType

Оператор сравнения.
systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.
ThresholdType

Тип порогового значения
TimeGrainType

Время, покрываемое бюджетом. Отслеживание суммы будет сброшено на основе времени. BillingMonth, BillingQuarter и BillingAnnual поддерживаются только клиентами WD.

Budget

Object

Бюджетный ресурс.

Имя Тип Описание
eTag

string

eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию или нет.
id

string

Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.amount

number (decimal)

Общая сумма затрат для отслеживания с бюджетом
properties.category

CategoryType

Категория бюджета, отслеживает ли бюджет затраты или использование.
properties.currentSpend

CurrentSpend

Текущая сумма затрат, отслеживаемая для бюджета.
properties.filter

BudgetFilter

Может использоваться для фильтрации бюджетов по заданным пользователем измерениям и (или) тегам.
properties.forecastSpend

ForecastSpend

Прогнозируемые затраты, отслеживаемые для бюджета.
properties.notifications

<string,  Notification>

Словарь уведомлений, связанных с бюджетом. Бюджет может содержать до пяти уведомлений.
properties.timeGrain

TimeGrainType

Время, покрываемое бюджетом. Отслеживание суммы будет сброшено на основе времени. BillingMonth, BillingQuarter и BillingAnnual поддерживаются только клиентами WD.
properties.timePeriod

BudgetTimePeriod

Имеет дату начала и окончания бюджета. Дата начала должна быть первой из месяца и должна быть меньше даты окончания. Дата начала бюджета должна быть 1 июня 2017 г. или после него. Дата начала будущего не должна превышать двенадцать месяцев. Последнюю дату начала следует выбрать в течение периода времени. Нет ограничений на дату окончания.
systemData

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

BudgetComparisonExpression

Object

Выражение сравнения, используемое в бюджетах.

Имя Тип Описание
name

string

Имя столбца, используемого в сравнении.
operator

BudgetOperatorType

Оператор, используемый для сравнения.
values

string[]

Массив значений, используемых для сравнения

BudgetFilter

Object

Может использоваться для фильтрации бюджетов по группам ресурсов, ресурсам или счетчику.

Имя Тип Описание
and

BudgetFilterProperties[]

Логическое выражение "AND". Должно быть не менее 2 элементов.
dimensions

BudgetComparisonExpression

Имеет выражение сравнения для измерения
tags

BudgetComparisonExpression

Имеет выражение сравнения для тега

BudgetFilterProperties

Object

Измерения или теги для фильтрации бюджета по.

Имя Тип Описание
dimensions

BudgetComparisonExpression

Имеет выражение сравнения для измерения
tags

BudgetComparisonExpression

Имеет выражение сравнения для тега

BudgetOperatorType

Перечисление

Оператор, используемый для сравнения.

Значение Описание
In

BudgetTimePeriod

Object

Дата начала и окончания бюджета.

Имя Тип Описание
endDate

string (date-time)

Дата окончания бюджета. Если это не указано, по умолчанию это значение 10 лет с даты начала.
startDate

string (date-time)

Дата начала бюджета.

CategoryType

Перечисление

Категория бюджета, отслеживает ли бюджет затраты или использование.

Значение Описание
Cost

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение Описание
User
Application
ManagedIdentity
Key

CultureCode

Перечисление

Язык, в котором получатель получит уведомление

Значение Описание
en-us
ja-jp
zh-cn
de-de
es-es
fr-fr
it-it
ko-kr
pt-br
ru-ru
zh-tw
cs-cz
pl-pl
tr-tr
da-dk
en-gb
hu-hu
nb-no
nl-nl
pt-pt
sv-se

CurrentSpend

Object

Текущая сумма затрат, отслеживаемая для бюджета.

Имя Тип Описание
amount

number (decimal)

Общая сумма затрат, отслеживаемая бюджетом.
unit

string

Единица измерения для суммы бюджета.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

ForecastSpend

Object

Прогнозируемые затраты, отслеживаемые для бюджета.

Имя Тип Описание
amount

number (decimal)

Прогнозируемые затраты на общий период времени, отслеживаемый бюджетом. Это значение предоставляется только в том случае, если бюджет содержит тип оповещения прогноза.
unit

string

Единица измерения для суммы бюджета.

Notification

Object

Уведомление, связанное с бюджетом.

Имя Тип Default value Описание
contactEmails

string[]

Адреса электронной почты для отправки уведомления о бюджете в момент превышения порогового значения. Должен иметь по крайней мере одну электронную почту контакта или группу контактов, указанную в области подписки или группы ресурсов. Все остальные области должны иметь по крайней мере один адрес электронной почты контакта.
contactGroups

string[]

Группы действий для отправки уведомления о бюджете в момент превышения порогового значения. Необходимо предоставить в качестве полного идентификатора ресурса Azure. Поддерживается только в области подписки или группы ресурсов.
contactRoles

string[]

Чтобы отправить уведомление о бюджете, обратитесь к ролям, чтобы отправить уведомление о превышении порогового значения.
enabled

boolean

Уведомление включено или нет.
locale

CultureCode

Язык, в котором получатель получит уведомление
operator

OperatorType

Оператор сравнения.
threshold

number (decimal)

Пороговое значение, связанное с уведомлением. Уведомление отправляется, когда стоимость превысила пороговое значение. Это всегда процент и должно быть от 0 до 1000.
thresholdType

ThresholdType

Actual

Тип порогового значения

OperatorType

Перечисление

Оператор сравнения.

Значение Описание
EqualTo

Оповещение будет активировано, если вычисляемая стоимость совпадает с пороговым значением. Примечание. Не рекомендуется использовать этот ОператорType, так как есть низкая вероятность того, что затраты совпадают с пороговым значением, что приводит к нехватке оповещений. Этот операторType будет нерекомендуем в будущем.
GreaterThan

Оповещение будет активировано, если вычисляемая стоимость превышает пороговое значение. Примечание. Это рекомендуемый операторType при настройке оповещения о бюджете.
GreaterThanOrEqualTo

Оповещение будет активировано, если вычисляемая стоимость превышает пороговое значение или равно ей.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

Тип удостоверения, создавшего ресурс.
lastModifiedAt

string (date-time)

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.
lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.

ThresholdType

Перечисление

Тип порогового значения

Значение Описание
Actual

Фактические оповещения бюджета затрат уведомляют, когда фактические накопленные затраты превышают выделенный бюджет.
Forecasted

Прогнозируемые оповещения о бюджете затрат обеспечивают расширенное уведомление о том, что тенденции расходов, скорее всего, превышают выделенный бюджет, так как он зависит от прогнозируемых прогнозов затрат.

TimeGrainType

Перечисление

Время, покрываемое бюджетом. Отслеживание суммы будет сброшено на основе времени. BillingMonth, BillingQuarter и BillingAnnual поддерживаются только клиентами WD.

Значение Описание
Monthly
Quarterly
Annually
BillingMonth
BillingQuarter
BillingAnnual