Budgets - Create Or Update

Referencia

Servicio:: Consumption

Versión de la API:: 2024-08-01

Operación para crear o actualizar un presupuesto. Opcionalmente, puede proporcionar una eTag si lo desea como forma de control de simultaneidad. Para obtener la eTag más reciente de un presupuesto determinado, realice una operación get antes de la operación put.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
budgetName	path	True	string	Nombre del presupuesto.
scope	path	True	string	Ámbito asociado a las operaciones presupuestarias. Esto incluye '/subscriptions/{subscriptionId}/' para el ámbito de la suscripción, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para el ámbito resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para el ámbito de la cuenta de facturación, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para el ámbito del departamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para el ámbito EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' para el ámbito del grupo de administración, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para el ámbito billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para el ámbito de invoiceSection.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2023-03-01.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.amount	True	number (decimal)	Importe total del costo para realizar el seguimiento con el presupuesto.
properties.category	True	CategoryType	Categoría del presupuesto, tanto si el presupuesto realiza un seguimiento del costo como del uso.
properties.timeGrain	True	TimeGrainType	Tiempo cubierto por un presupuesto. El seguimiento de la cantidad se restablecerá en función del intervalo de tiempo. Los clientes de WD solo admiten BillingMonth, BillingQuarter y Billing Annual.
properties.timePeriod	True	BudgetTimePeriod	Tiene la fecha de inicio y finalización del presupuesto. La fecha de inicio debe ser la primera del mes y debe ser menor que la fecha de finalización. La fecha de inicio del presupuesto debe ser el 1 o después del 1 de junio de 2017. La fecha de inicio futura no debe ser superior a doce meses. La fecha de inicio anterior debe seleccionarse dentro del período de tiempo. No hay restricciones en la fecha de finalización.
eTag		string	eTag del recurso. Para controlar el escenario de actualización simultánea, este campo se usará para determinar si el usuario está actualizando la versión más reciente o no.
properties.filter		BudgetFilter	Se puede usar para filtrar presupuestos por dimensiones o etiquetas especificadas por el usuario.
properties.notifications		<string, Notification>	Diccionario de notificaciones asociadas al presupuesto. El presupuesto puede tener hasta cinco notificaciones.

Respuestas

Nombre	Tipo	Description
200 OK	Budget	De acuerdo. La solicitud se ha realizado correctamente.
201 Created	Budget	Creado.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

CreateOrUpdateBudget

Solicitud de ejemplo

HTTP

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

{
  "eTag": "\"1d34d016a593709\"",
  "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"
            ]
          }
        }
      ]
    },
    "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"
      }
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "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,
        "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"
      }
    }
  }
}

status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/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,
        "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"
      }
    }
  }
}

Definiciones

Nombre	Description
Budget	Un recurso presupuestado.
BudgetComparisonExpression	Expresión de comparación que se va a usar en los presupuestos.
BudgetFilter	Puede usarse para filtrar los presupuestos por grupo de recursos, recurso o medidor.
BudgetFilterProperties	Dimensiones o etiquetas por las que se va a filtrar un presupuesto.
BudgetOperatorType	Operador que se va a usar para la comparación.
BudgetTimePeriod	Fecha de inicio y finalización de un presupuesto.
CategoryType	Categoría del presupuesto, tanto si el presupuesto realiza un seguimiento del costo como del uso.
CultureCode	Idioma en el que el destinatario recibirá la notificación
CurrentSpend	La cantidad actual de costo que se está realizando el seguimiento de un presupuesto.
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. Algunas respuestas de error: 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After". Tiempo de espera de puerta de enlace 504: se agota el tiempo de espera del servicio mientras se procesa la solicitud. Reduzca el intervalo de fechas de la solicitud, si es posible.
ForecastSpend	Costo previsto que se está realizando un seguimiento de un presupuesto.
Notification	Notificación asociada a un presupuesto.
OperatorType	Operador de comparación.
ThresholdType	El tipo de umbral
TimeGrainType	Tiempo cubierto por un presupuesto. El seguimiento de la cantidad se restablecerá en función del intervalo de tiempo. Los clientes de WD solo admiten BillingMonth, BillingQuarter y Billing Annual.

Budget

Object

Un recurso presupuestado.

Nombre	Tipo	Description
eTag	string	eTag del recurso. Para controlar el escenario de actualización simultánea, este campo se usará para determinar si el usuario está actualizando la versión más reciente o no.
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.amount	number (decimal)	Importe total del costo para realizar el seguimiento con el presupuesto.
properties.category	CategoryType	Categoría del presupuesto, tanto si el presupuesto realiza un seguimiento del costo como del uso.
properties.currentSpend	CurrentSpend	La cantidad actual de costo que se está realizando el seguimiento de un presupuesto.
properties.filter	BudgetFilter	Se puede usar para filtrar presupuestos por dimensiones o etiquetas especificadas por el usuario.
properties.forecastSpend	ForecastSpend	Costo previsto que se está realizando un seguimiento de un presupuesto.
properties.notifications	<string, Notification>	Diccionario de notificaciones asociadas al presupuesto. El presupuesto puede tener hasta cinco notificaciones.
properties.timeGrain	TimeGrainType	Tiempo cubierto por un presupuesto. El seguimiento de la cantidad se restablecerá en función del intervalo de tiempo. Los clientes de WD solo admiten BillingMonth, BillingQuarter y Billing Annual.
properties.timePeriod	BudgetTimePeriod	Tiene la fecha de inicio y finalización del presupuesto. La fecha de inicio debe ser la primera del mes y debe ser menor que la fecha de finalización. La fecha de inicio del presupuesto debe ser el 1 o después del 1 de junio de 2017. La fecha de inicio futura no debe ser superior a doce meses. La fecha de inicio anterior debe seleccionarse dentro del período de tiempo. No hay restricciones en la fecha de finalización.
type	string	Tipo de recurso.

BudgetComparisonExpression

Object

Expresión de comparación que se va a usar en los presupuestos.

Nombre	Tipo	Description
name	string	Nombre de la columna que se va a usar en comparación.
operator	BudgetOperatorType	Operador que se va a usar para la comparación.
values	string[]	Matriz de valores que se van a usar para la comparación

BudgetFilter

Object

Puede usarse para filtrar los presupuestos por grupo de recursos, recurso o medidor.

Nombre	Tipo	Description
and	BudgetFilterProperties[]	Expresión "AND" lógica. Debe tener al menos 2 elementos.
dimensions	BudgetComparisonExpression	Tiene una expresión de comparación para una dimensión
tags	BudgetComparisonExpression	Tiene expresión de comparación para una etiqueta

BudgetFilterProperties

Object

Dimensiones o etiquetas por las que se va a filtrar un presupuesto.

Nombre	Tipo	Description
dimensions	BudgetComparisonExpression	Tiene una expresión de comparación para una dimensión
tags	BudgetComparisonExpression	Tiene expresión de comparación para una etiqueta

BudgetOperatorType

Enumeración

Operador que se va a usar para la comparación.

Valor	Description
In

BudgetTimePeriod

Object

Fecha de inicio y finalización de un presupuesto.

Nombre	Tipo	Description
endDate	string (date-time)	Fecha de finalización del presupuesto. Si no se proporciona, el valor predeterminado es de 10 años a partir de la fecha de inicio.
startDate	string (date-time)	Fecha de inicio del presupuesto.

CategoryType

Enumeración

Categoría del presupuesto, tanto si el presupuesto realiza un seguimiento del costo como del uso.

Valor	Description
Cost

CultureCode

Enumeración

Idioma en el que el destinatario recibirá la notificación

Valor	Description
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

La cantidad actual de costo que se está realizando el seguimiento de un presupuesto.

Nombre	Tipo	Description
amount	number (decimal)	Importe total del costo que realiza el seguimiento del presupuesto.
unit	string	Unidad de medida para el importe presupuestado.

ErrorDetails

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponse

Object

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Algunas respuestas de error:

429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After".
Tiempo de espera de puerta de enlace 504: se agota el tiempo de espera del servicio mientras se procesa la solicitud. Reduzca el intervalo de fechas de la solicitud, si es posible.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

ForecastSpend

Object

Costo previsto que se está realizando un seguimiento de un presupuesto.

Nombre	Tipo	Description
amount	number (decimal)	Costo previsto para el período total de tiempo que realiza el seguimiento del presupuesto. Este valor solo se proporciona si el presupuesto contiene un tipo de alerta de previsión.
unit	string	Unidad de medida para el importe presupuestado.

Notification

Object

Notificación asociada a un presupuesto.

Nombre	Tipo	Valor predeterminado	Description
contactEmails	string[]		Direcciones de correo electrónico para enviar la notificación presupuestaria a cuando se supera el umbral. Debe tener al menos un correo electrónico de contacto o un grupo de contactos especificado en los ámbitos de suscripción o grupo de recursos. Todos los demás ámbitos deben tener al menos un correo electrónico de contacto especificado.
contactGroups	string[]		Grupos de acciones a los que se enviará la notificación de presupuesto cuando se supere el umbral. Debe proporcionarse como identificador de recurso completo de Azure. Solo se admite en ámbitos de suscripción o grupo de recursos.
contactRoles	string[]		Póngase en contacto con los roles para enviar la notificación presupuestaria a cuando se supere el umbral.
enabled	boolean		La notificación está habilitada o no.
locale	CultureCode		Idioma en el que el destinatario recibirá la notificación
operator	OperatorType		Operador de comparación.
threshold	number (decimal)		Valor de umbral asociado a una notificación. La notificación se envía cuando el costo supera el umbral. Siempre es porcentaje y tiene que estar entre 0 y 1000.
thresholdType	ThresholdType	Actual	El tipo de umbral

OperatorType

Enumeración

Operador de comparación.

Valor	Description
EqualTo	La alerta se desencadenará si el costo evaluado es el mismo que el valor de umbral. Nota: No se recomienda usar este OperatorType, ya que hay poca probabilidad de que el costo sea exactamente el mismo que el valor de umbral, lo que provoca que falte la alerta. Este OperatorType quedará en desuso en el futuro.
GreaterThan	La alerta se desencadenará si el costo evaluado es mayor que el valor de umbral. Nota: Este es el operatorType recomendado al configurar la alerta de presupuesto.
GreaterThanOrEqualTo	La alerta se desencadenará si el costo evaluado es mayor o igual que el valor de umbral.

ThresholdType

Enumeración

El tipo de umbral

Valor	Description
Actual	Las alertas de presupuesto de costos reales notifican cuando el costo acumulado real supera el presupuesto asignado.
Forecasted	Las alertas de presupuesto de costos previstos proporcionan una notificación avanzada de que es probable que las tendencias de gasto superen el presupuesto asignado, ya que se basa en predicciones de costos previstos.

TimeGrainType

Enumeración

Tiempo cubierto por un presupuesto. El seguimiento de la cantidad se restablecerá en función del intervalo de tiempo. Los clientes de WD solo admiten BillingMonth, BillingQuarter y Billing Annual.

Valor	Description
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
Quarterly

Compartir a través de

Budgets - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

CreateOrUpdateBudget

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Recursos adicionales