Budgets - Get

Ссылка

Service:: Consumption

API Version:: 2023-05-01

Возвращает бюджет для область по названию бюджета.

GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}?api-version=2023-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
budgetName	path	True	string	Название бюджета.
scope	path	True	string	Область, связанные с бюджетными операциями. Сюда входят "/subscriptions/{subscriptionId}/" для область подписки, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для resourceGroup область, "/providers/Microsoft.Billing/billingAccounts/{billingAccountS/{billingAccountId}" для учетной записи выставления счетов область, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" для Отдела область, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" для EnrollmentAccount область, "/providers/Microsoft.Management/managementGroups/{managementGroupId}" для область группы управления, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" для billingProfile область, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" для область invoiceSection.
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия — 01.03.2023.

Ответы

Имя	Тип	Описание
200 OK	Budget	Все в порядке. Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

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

Примеры

Budget

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget?api-version=2023-05-01

Sample Response

Status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget",
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2017-10-01T00:00:00Z",
      "endDate": "2018-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,
        "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"
      }
    }
  }
}

Определения

Имя	Описание
Budget	Бюджетный ресурс.
BudgetComparisonExpression	Выражение сравнения, используемое в бюджетах.
BudgetFilter	Может использоваться для фильтрации бюджетов по группе ресурсов, ресурсу или единице измерения.
BudgetFilterProperties	Измерения или теги для фильтрации бюджета.
BudgetOperatorType	Оператор, используемый для сравнения.
BudgetTimePeriod	Дата начала и окончания бюджета.
CategoryType	Категория бюджета независимо от того, отслеживает ли бюджет затраты или использование.
CultureCode	Язык, на котором получатель будет получать уведомление
CurrentSpend	Текущая сумма затрат, которая отслеживается для бюджета.
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ об ошибке указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. Некоторые ответы об ошибках: 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable — служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.
ForecastSpend	Прогнозируемые затраты, которые отслеживаются для бюджета.
Notification	Уведомление, связанное с бюджетом.
OperatorType	Оператор сравнения.
ThresholdType	Тип порогового значения
TimeGrainType	Время, покрываемое бюджетом. Отслеживание суммы будет сброшено на основе интервала времени. BillingMonth, BillingQuarter и BillingAnnual поддерживаются только клиентами WD

Budget

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

Имя	Тип	Описание
eTag	string	eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию.
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.amount	number	Общая сумма затрат для отслеживания с бюджетом
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 года или позже. Будущая дата начала не должна превышать двенадцать месяцев. Дата начала должна быть выбрана в пределах периода времени. Нет ограничений на дату окончания.
type	string	Тип ресурса.

BudgetComparisonExpression

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

Имя	Тип	Описание
name	string	Имя столбца для сравнения.
operator	BudgetOperatorType	Оператор, используемый для сравнения.
values	string[]	Массив значений для сравнения

BudgetFilter

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

Имя	Тип	Описание
and	BudgetFilterProperties[]	Логическое выражение "AND". Должно быть не менее 2 элементов.
dimensions	BudgetComparisonExpression	Имеет выражение сравнения для измерения
tags	BudgetComparisonExpression	Имеет выражение сравнения для тега

BudgetFilterProperties

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

Имя	Тип	Описание
dimensions	BudgetComparisonExpression	Имеет выражение сравнения для измерения
tags	BudgetComparisonExpression	Имеет выражение сравнения для тега

BudgetOperatorType

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

Имя	Тип	Описание
In	string

BudgetTimePeriod

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

Имя	Тип	Описание
endDate	string	Дата окончания бюджета. Если этот параметр не указан, по умолчанию используется значение 10 лет с даты начала.
startDate	string	Дата начала бюджета.

CategoryType

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

Имя	Тип	Описание
Cost	string

CultureCode

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

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

CurrentSpend

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

Имя	Тип	Описание
amount	number	Общая сумма затрат, отслеживаемая бюджетом.
unit	string	Единица измерения для суммы бюджета.

ErrorDetails

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

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

ErrorResponse

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

Некоторые ответы об ошибках:

429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable — служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке.

ForecastSpend

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

Имя	Тип	Описание
amount	number	Прогнозируемые затраты на общий период времени, который отслеживается бюджетом. Это значение предоставляется только в том случае, если бюджет содержит тип оповещения прогноза.
unit	string	Единица измерения для суммы бюджета.

Notification

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

Имя	Тип	Значение по умолчанию	Описание
contactEmails	string[]		Email адреса для отправки уведомления о бюджете при превышении порогового значения. В области подписки или группы ресурсов должен быть указан хотя бы один адрес электронной почты контакта или группа контактов. Во всех остальных областях должен быть указан по крайней мере один адрес электронной почты контакта.
contactGroups	string[]		Группы действий для отправки уведомления о бюджете при превышении порогового значения. Должен быть указан в виде полного идентификатора ресурса Azure. Поддерживается только в области подписки или группы ресурсов.
contactRoles	string[]		Обратитесь к ролям, чтобы отправить уведомление о бюджете при превышении порогового значения.
enabled	boolean		Уведомление включено или нет.
locale	CultureCode		Язык, на котором получатель будет получать уведомление
operator	OperatorType		Оператор сравнения.
threshold	number		Пороговое значение, связанное с уведомлением. Уведомление отправляется, когда стоимость превышает пороговое значение. Это всегда процент и должен быть в диапазоне от 0 до 1000.
thresholdType	ThresholdType	Actual	Тип порогового значения

OperatorType

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

Имя	Тип	Описание
EqualTo	string	Оповещение будет активировано, если вычисленная стоимость совпадает с пороговым значением. Примечание. Не рекомендуется использовать этот OperatorType, так как существует низкая вероятность того, что стоимость будет точно такой же, как пороговое значение, что приведет к отсутствовать оповещение. В будущем этот operatorType будет считаться устаревшим.
GreaterThan	string	Оповещение будет активировано, если вычисленная стоимость превышает пороговое значение. Примечание. Это рекомендуемый operatorType при настройке оповещения о бюджете.
GreaterThanOrEqualTo	string	Оповещение будет активировано, если вычисленная стоимость превышает пороговое значение или равно ей.

ThresholdType

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

Имя	Тип	Описание
Actual	string	Оповещения о фактических затратах бюджета уведомляют о том, что фактические накопленные затраты превышают выделенный бюджет.
Forecasted	string	Оповещения о прогнозируемом бюджете затрат предоставляют расширенное уведомление о том, что тенденции расходов, скорее всего, превысят выделенный бюджет, так как они основаны на прогнозируемых затратах.

TimeGrainType

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

Имя	Тип	Описание
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
Quarterly	string

Budgets - Get

Параметры URI

Ответы

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

azure_auth

Scopes

Примеры

Budget

Sample Request

Sample Response

Определения

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Дополнительные ресурсы