Partilhar via

Budgets - Create Or Update

  • Referência
Serviço:
Cost Management
Versão da API:
2024-08-01

A operação para criar ou atualizar um orçamento. Opcionalmente, você pode fornecer uma eTag, se desejar, como uma forma de controle de simultaneidade. Para obter o eTag mais recente para um determinado orçamento, execute uma operação get antes da operação put.

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

Parâmetros do URI

Name Em Necessário Tipo Description
budgetName
 path True

string

Nome do orçamento.

Padrão Regex: ^[a-zA-Z0-9_-]+$
scope
 path True

string

O âmbito associado às operações orçamentais.

Escopos suportados para CategoryType: Custo

Escopos do RBAC do Azure:

  • '/subscriptions/{subscriptionId}/' para o âmbito da subscrição
  • '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para o escopo resourceGroup
  • '/providers/Microsoft.Management/managementGroups/{managementGroupId}' para o escopo do Grupo de Gerenciamento

Âmbitos do EA (Enterprise Agreement):

  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o âmbito da Conta de Faturação
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para o escopo do Departamento
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' para o escopo EnrollmentAccount

Âmbitos MCA (Modern Customer Agreement):

  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o âmbito da Conta de Faturação
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo do perfil de faturamento
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' para o escopo da seção invoice
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' para escopo do cliente (somente CSP)

Escopos suportados para CategoryType: ReservationUtilization

Âmbitos do EA (Enterprise Agreement):

  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo da conta de faturamento

Âmbitos MCA (Modern Customer Agreement):

  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo do perfil de faturamento (somente não CSP)
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' para escopo do cliente (somente CSP)
api-version
 query True

string

A versão da API a ser usada para esta operação.

Corpo do Pedido

Name Necessário Tipo Description
properties.category True

CategoryType

A categoria do orçamento.

  • 'Custo' define um Orçamento.
  • 'ReservationUtilization' define uma Regra de Alerta de Utilização de Reservas.
properties.timeGrain True

TimeGrainType

O tempo coberto por um orçamento. O rastreamento do valor será redefinido com base no grão de tempo.

Suportado para CategoryType(s): Custo, ReservationUtilization.

TimeGrainTypes suportados para CategoryType: Custo

  • Mensal

  • Trimestral

  • Anualmente

  • Mês de Faturamento*

  • BillingQuarter*

  • FaturaçãoAnual*

    *suportado apenas para clientes Web Direct.

TimeGrainTypes suportado para CategoryType: ReservationUtilization

  • Últimos 7Dias
  • Último30Dias

Obrigatório para Categoria(s): Custo, ReservaUtilização.
properties.timePeriod True

BudgetTimePeriod

O período de tempo que define o período ativo do orçamento. O orçamento avaliará os dados no ou após o startDate e expirará no endDate.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Obrigatório para Categoria(s): Custo, ReservaUtilização.
eTag

string

eTag do recurso. Para lidar com o cenário de atualização simultânea, esse campo será usado para determinar se o usuário está atualizando a versão mais recente ou não.
properties.amount

number

O valor total do custo a acompanhar com o orçamento.

Suportado para CategoryType(s): Custo.

Obrigatório para CategoryType(s): Custo.
properties.filter

BudgetFilter

Pode ser usado para filtrar orçamentos por dimensões e/ou tags especificadas pelo usuário.

Suportado para CategoryType(s): Custo, ReservationUtilization.
properties.notifications

<string,  Notification>

Dicionário de notificações associadas ao orçamento.

Suportado para CategoryType(s): Custo, ReservationUtilization.

  • Restrições para CategoryType: Cost - Budget pode ter até 5 notificações com thresholdType: Atual e 5 notificações com thresholdType: Forecasted.
  • Restrições para CategoryType: ReservationUtilization - Apenas uma notificação permitida. thresholdType não é aplicável.

Respostas

Name Tipo Description
200 OK

Budget

OK. O pedido foi bem-sucedido e a atualização do orçamento está concluída.
201 Created

Budget

Criado.
Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

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

Pedido de amostra

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

Resposta da amostra

Código de estado:
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"
      }
    }
  }
}
Código de estado:
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

Pedido de amostra

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"
        ]
      }
    }
  }
}

Resposta da amostra

Código de estado:
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"
        ]
      }
    }
  }
}
Código de estado:
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

Pedido de amostra

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"
        ]
      }
    }
  }
}

Resposta da amostra

Código de estado:
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"
        ]
      }
    }
  }
}
Código de estado:
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

Pedido de amostra

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"
        ]
      }
    }
  }
}

Resposta da amostra

Código de estado:
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"
        ]
      }
    }
  }
}
Código de estado:
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

Pedido de amostra

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"
        ]
      }
    }
  }
}

Resposta da amostra

Código de estado:
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"
        ]
      }
    }
  }
}
Código de estado:
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

Pedido de amostra

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"
        ]
      }
    }
  }
}

Resposta da amostra

Código de estado:
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"
        ]
      }
    }
  }
}
Código de estado:
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

Pedido de amostra

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"
        ]
      }
    }
  }
}

Resposta da amostra

Código de estado:
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"
        ]
      }
    }
  }
}
Código de estado:
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

Pedido de amostra

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"
        ]
      }
    }
  }
}

Resposta da amostra

Código de estado:
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"
        ]
      }
    }
  }
}
Código de estado:
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

Pedido de amostra

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"
        ]
      }
    }
  }
}

Resposta da amostra

Código de estado:
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"
        ]
      }
    }
  }
}
Código de estado:
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

Pedido de amostra

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"
        ]
      }
    }
  }
}

Resposta da amostra

Código de estado:
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"
        ]
      }
    }
  }
}
Código de estado:
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"
        ]
      }
    }
  }
}

Definições

Name Description
Budget

Um recurso orçamental.
BudgetComparisonExpression

A expressão de comparação a utilizar nos orçamentos.
BudgetFilter

Pode ser usado para filtrar orçamentos por dimensões e/ou tags especificadas pelo usuário.

Suportado para CategoryType(s): Custo, ReservationUtilization.
BudgetFilterProperties

As Dimensões ou Tags pelas quais filtrar um orçamento.

Suportado para CategoryType(s): Custo, ReservationUtilization.
BudgetNotificationOperatorType

O operador de comparação.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Operadores suportados para CategoriaTipo: Custo

  • MaiorQue
  • MaiorThanOrEqualTo

Operadores suportados para CategoryType: ReservationUtilization

  • MenosQue
BudgetOperatorType

O operador a utilizar para comparação.
BudgetTimePeriod

O período de tempo que define o período ativo do orçamento. O orçamento avaliará os dados no ou após o startDate e expirará no endDate.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Obrigatório para Categoria(s): Custo, ReservaUtilização.
CategoryType

A categoria do orçamento.

  • 'Custo' define um Orçamento.
  • 'ReservationUtilization' define uma Regra de Alerta de Utilização de Reservas.
CultureCode

Língua em que o destinatário receberá a notificação,

Suportado para CategoryType(s): Custo, ReservationUtilization.
CurrentSpend

O valor atual do custo que está sendo rastreado para um orçamento.

Suportado para CategoryType(s): Custo.
ErrorDetails

Os detalhes do erro.
ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests - A solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiçoIndisponível - O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".
ForecastSpend

O custo previsto que está sendo rastreado para um orçamento.

Suportado para CategoryType(s): Custo.
Frequency

Frequência de uma notificação. Representa por quanto tempo a notificação ficará silenciosa após disparar um alerta para uma violação de limite. Se não for especificado, a frequência será definida por padrão com base no timeGrain (Semanal quando timeGrain: Last7Days, Mensal quando timeGrain: Last30Days).

Suportado para CategoryType(s): ReservationUtilization.
Notification

A notificação associada a um orçamento.

Suportado para CategoryType(s): Custo, ReservationUtilization.
ThresholdType

O tipo de limiar.

Suportado para CategoryType(s): Custo.
TimeGrainType

O tempo coberto por um orçamento. O rastreamento do valor será redefinido com base no grão de tempo.

Suportado para CategoryType(s): Custo, ReservationUtilization.

TimeGrainTypes suportados para CategoryType: Custo

  • Mensal

  • Trimestral

  • Anualmente

  • Mês de Faturamento*

  • BillingQuarter*

  • FaturaçãoAnual*

    *suportado apenas para clientes Web Direct.

TimeGrainTypes suportado para CategoryType: ReservationUtilization

  • Últimos 7Dias
  • Último30Dias

Obrigatório para Categoria(s): Custo, ReservaUtilização.

Budget

Um recurso orçamental.

Name Tipo Description
eTag

string

eTag do recurso. Para lidar com o cenário de atualização simultânea, esse campo será usado para determinar se o usuário está atualizando a versão mais recente ou não.
id

string

Id do recurso.
name

string

Nome do recurso.
properties.amount

number

O valor total do custo a acompanhar com o orçamento.

Suportado para CategoryType(s): Custo.

Obrigatório para CategoryType(s): Custo.
properties.category

CategoryType

A categoria do orçamento.

  • 'Custo' define um Orçamento.
  • 'ReservationUtilization' define uma Regra de Alerta de Utilização de Reservas.
properties.currentSpend

CurrentSpend

O valor atual do custo que está sendo rastreado para um orçamento.

Suportado para CategoryType(s): Custo.
properties.filter

BudgetFilter

Pode ser usado para filtrar orçamentos por dimensões e/ou tags especificadas pelo usuário.

Suportado para CategoryType(s): Custo, ReservationUtilization.
properties.forecastSpend

ForecastSpend

O custo previsto que está sendo rastreado para um orçamento.

Suportado para CategoryType(s): Custo.
properties.notifications

<string,  Notification>

Dicionário de notificações associadas ao orçamento.

Suportado para CategoryType(s): Custo, ReservationUtilization.

  • Restrições para CategoryType: Cost - Budget pode ter até 5 notificações com thresholdType: Atual e 5 notificações com thresholdType: Forecasted.
  • Restrições para CategoryType: ReservationUtilization - Apenas uma notificação permitida. thresholdType não é aplicável.
properties.timeGrain

TimeGrainType

O tempo coberto por um orçamento. O rastreamento do valor será redefinido com base no grão de tempo.

Suportado para CategoryType(s): Custo, ReservationUtilization.

TimeGrainTypes suportados para CategoryType: Custo

  • Mensal

  • Trimestral

  • Anualmente

  • Mês de Faturamento*

  • BillingQuarter*

  • FaturaçãoAnual*

    *suportado apenas para clientes Web Direct.

TimeGrainTypes suportado para CategoryType: ReservationUtilization

  • Últimos 7Dias
  • Último30Dias

Obrigatório para Categoria(s): Custo, ReservaUtilização.
properties.timePeriod

BudgetTimePeriod

O período de tempo que define o período ativo do orçamento. O orçamento avaliará os dados no ou após o startDate e expirará no endDate.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Obrigatório para Categoria(s): Custo, ReservaUtilização.
type

string

Tipo de recurso.

BudgetComparisonExpression

A expressão de comparação a utilizar nos orçamentos.

Name Tipo Description
name

string

O nome da coluna a ser usada na comparação.
operator

BudgetOperatorType

O operador a utilizar para comparação.
values

string[]

Matriz de valores a ser usada para comparação

BudgetFilter

Pode ser usado para filtrar orçamentos por dimensões e/ou tags especificadas pelo usuário.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Name Tipo Description
and

BudgetFilterProperties[]

A expressão lógica "E". Deve ter pelo menos 2 itens.

Suportado para CategoryType(s): Custo.
dimensions

BudgetComparisonExpression

Tem expressão de comparação para uma dimensão.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Nomes de dimensão suportados para CategoryType: ReservationUtilization

  • ReservationId
  • ReservedResourceType
tags

BudgetComparisonExpression

Tem expressão de comparação para uma tag.

Suportado para CategoryType(s): Custo.

BudgetFilterProperties

As Dimensões ou Tags pelas quais filtrar um orçamento.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Name Tipo Description
dimensions

BudgetComparisonExpression

Tem expressão de comparação para uma dimensão.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Nomes de dimensão suportados para CategoryType: ReservationUtilization

  • ReservationId
  • ReservedResourceType
tags

BudgetComparisonExpression

Tem expressão de comparação para uma tag.

Suportado para CategoryType(s): Custo.

BudgetNotificationOperatorType

O operador de comparação.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Operadores suportados para CategoriaTipo: Custo

  • MaiorQue
  • MaiorThanOrEqualTo

Operadores suportados para CategoryType: ReservationUtilization

  • MenosQue
Name Tipo Description
EqualTo

string

A notificação será acionada se o custo avaliado for igual ao valor limite. Nota: Não é recomendado usar este OperatorType, pois há baixa chance de o custo ser exatamente o mesmo que o valor limite, levando à falta do seu alerta. Este OperatorType será preterido no futuro.

Suportado para CategoryType(s): Custo.
GreaterThan

string

A notificação será acionada se o custo avaliado for maior do que o valor limite. Nota: Este é o OperatorType recomendado durante a configuração do Budget Alert.

Suportado para CategoryType(s): Custo.
GreaterThanOrEqualTo

string

A notificação será acionada se o custo avaliado for maior ou igual ao valor limite.

Suportado para CategoryType(s): Custo.
LessThan

string

A notificação será acionada se quaisquer Reservas no âmbito da Regra de Alerta de Utilização de Reservas tiverem uma utilização inferior à percentagem limite.

Suportado para CategoryType(s): ReservationUtilization.

BudgetOperatorType

O operador a utilizar para comparação.

Name Tipo Description
In

string

BudgetTimePeriod

O período de tempo que define o período ativo do orçamento. O orçamento avaliará os dados no ou após o startDate e expirará no endDate.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Obrigatório para Categoria(s): Custo, ReservaUtilização.

Name Tipo Description
endDate

string

A data final do orçamento.

  • Restrições para CategoryType: Custo - Sem restrições. Se não for fornecido, o padrão será de 10 anos a partir da data de início.

  • Restrições para CategoryType: ReservationUtilization - A data de término não pode ser superior a 3 anos após a data de início.
startDate

string

A data de início do orçamento.

  • Restrições para CategoriaTipo: Custo - Deve ser o primeiro do mês e deve ser menor do que a data final. A data de início do orçamento deve ser em ou após 1º de junho de 2017. A data de início futura não deve ser superior a doze meses. A data de início anterior deve ser selecionada dentro do período de tempo.

  • Restrições para CategoryType: ReservationUtilization - Deve estar na ou após a data atual e menor que a data final.

CategoryType

A categoria do orçamento.

  • 'Custo' define um Orçamento.
  • 'ReservationUtilization' define uma Regra de Alerta de Utilização de Reservas.
Name Tipo Description
Cost

string

Um Orçamento que avalia o custo monetário dos recursos do Azure em relação a um valor e alertas com base em um limite de notificação configurado.
ReservationUtilization

string

Uma Regra de Alerta que avalia a percentagem de utilização das Reservas do Azure e alertas com base num limiar de notificação configurado.

CultureCode

Língua em que o destinatário receberá a notificação,

Suportado para CategoryType(s): Custo, ReservationUtilization.

Name Tipo Description
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

O valor atual do custo que está sendo rastreado para um orçamento.

Suportado para CategoryType(s): Custo.

Name Tipo Description
amount

number

O montante total do custo que está a ser controlado pelo orçamento.
unit

string

A unidade de medida para o montante do orçamento.

ErrorDetails

Os detalhes do erro.

Name Tipo Description
code

string

Código de erro.
message

string

Mensagem de erro indicando por que a operação falhou.

ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests - A solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiçoIndisponível - O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Name Tipo Description
error

ErrorDetails

Os detalhes do erro.

ForecastSpend

O custo previsto que está sendo rastreado para um orçamento.

Suportado para CategoryType(s): Custo.

Name Tipo Description
amount

number

O custo previsto para o período de tempo total que está a ser acompanhado pelo orçamento. Esse valor só é fornecido se o orçamento contiver um tipo de alerta de previsão.
unit

string

A unidade de medida para o montante do orçamento.

Frequency

Frequência de uma notificação. Representa por quanto tempo a notificação ficará silenciosa após disparar um alerta para uma violação de limite. Se não for especificado, a frequência será definida por padrão com base no timeGrain (Semanal quando timeGrain: Last7Days, Mensal quando timeGrain: Last30Days).

Suportado para CategoryType(s): ReservationUtilization.

Name Tipo Description
Daily

string

Depois que o limite for violado e um Alerta for disparado, nenhum outro alerta será enviado até o dia seguinte do calendário.
Monthly

string

Depois que o limite for violado e um Alerta for disparado, nenhum outro alerta será enviado por 30 dias corridos.
Weekly

string

Depois que o limite for violado e um Alerta for disparado, nenhum outro alerta será enviado por 7 dias corridos.

Notification

A notificação associada a um orçamento.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Name Tipo Default value Description
contactEmails

string[]

Endereços de e-mail para os quais enviar a notificação quando o limite for violado. Deve ter pelo menos um email de contato ou grupo de contatos especificado nos escopos Assinatura ou Grupo de Recursos. Todos os outros escopos devem ter pelo menos um e-mail de contato especificado.

Suportado para CategoryType(s): Custo, ReservationUtilization.
contactGroups

string[]

Somente escopos de Assinatura ou Grupo de Recursos. Grupos de ação para enviar a notificação quando o limite for excedido. Deve ser fornecido como uma ID de recurso do Azure totalmente qualificada.

Suportado para CategoryType(s): Custo.
contactRoles

string[]

Somente escopos de Assinatura ou Grupo de Recursos. Funções de contato para enviar a notificação quando o limite for violado.

Suportado para CategoryType(s): Custo.
enabled

boolean

A notificação está habilitada ou não.

Suportado para CategoryType(s): Custo, ReservationUtilization.
frequency

Frequency

Frequência de uma notificação. Representa por quanto tempo a notificação ficará silenciosa após disparar um alerta para uma violação de limite. Se não for especificado, a frequência será definida por padrão com base no timeGrain (Semanal quando timeGrain: Last7Days, Mensal quando timeGrain: Last30Days).

Suportado para CategoryType(s): ReservationUtilization.
locale

CultureCode

Língua em que o destinatário receberá a notificação,

Suportado para CategoryType(s): Custo, ReservationUtilization.
operator

BudgetNotificationOperatorType

O operador de comparação.

Suportado para CategoryType(s): Custo, ReservationUtilization.

Operadores suportados para CategoriaTipo: Custo

  • MaiorQue
  • MaiorThanOrEqualTo

Operadores suportados para CategoryType: ReservationUtilization

  • MenosQue
threshold

number

Valor limite associado a uma notificação. É sempre uma percentagem com um máximo de 2 casas decimais.

Suportado para CategoryType(s): Custo, ReservationUtilization.

CategoryType: Custo - Deve estar entre 0 e 1000. A notificação é enviada quando o custo excede o limite.

CategoryType: ReservationUtilization - Deve estar entre 0 e 100. A notificação é enviada quando uma reserva tem uma porcentagem de utilização abaixo do limite.
thresholdType

ThresholdType

Actual

O tipo de limiar.

Suportado para CategoryType(s): Custo.

ThresholdType

O tipo de limiar.

Suportado para CategoryType(s): Custo.

Name Tipo Description
Actual

string

Os alertas de orçamento de custos reais notificam quando o custo real acumulado excede o orçamento alocado.
Forecasted

string

Os alertas de orçamento de custos previstos fornecem uma notificação avançada de que suas tendências de gastos provavelmente excederão o orçamento alocado, pois dependem de previsões de custos previstos.

TimeGrainType

O tempo coberto por um orçamento. O rastreamento do valor será redefinido com base no grão de tempo.

Suportado para CategoryType(s): Custo, ReservationUtilization.

TimeGrainTypes suportados para CategoryType: Custo

  • Mensal

  • Trimestral

  • Anualmente

  • Mês de Faturamento*

  • BillingQuarter*

  • FaturaçãoAnual*

    *suportado apenas para clientes Web Direct.

TimeGrainTypes suportado para CategoryType: ReservationUtilization

  • Últimos 7Dias
  • Último30Dias

Obrigatório para Categoria(s): Custo, ReservaUtilização.

Name Tipo Description
Annually

string

O orçamento registará os custos no ano civil em curso em relação ao montante.

Suportado para CategoryType: Apenas custo.
BillingAnnual

string

O orçamento controlará os custos no ano de faturamento atual em relação ao valor.

Suportado apenas para clientes CategoryType: Cost e Web Direct.
BillingMonth

string

O orçamento controlará os custos no mês de faturamento atual em relação ao valor.

Suportado apenas para clientes CategoryType: Cost e Web Direct.
BillingQuarter

string

O orçamento controlará os custos no trimestre de faturamento atual em relação ao valor.

Suportado apenas para clientes CategoryType: Cost e Web Direct.
Last30Days

string

A Regra de Alerta de Utilização de Reservas avaliará as reservas com base na sua percentagem de utilização de 30 dias.

Suportado apenas para CategoryType: ReservationUtilization .
Last7Days

string

A Regra de Alerta de Utilização de Reservas avaliará as reservas com base na percentagem de utilização de 7 dias.

Suportado apenas para CategoryType: ReservationUtilization .
Monthly

string

O orçamento controlará os custos no mês civil atual em relação ao montante.

Suportado para CategoryType: Apenas custo.
Quarterly

string

O orçamento controlará os custos no trimestre civil atual em relação ao montante.

Suportado para CategoryType: Apenas custo.