Compartilhar 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 a eTag mais recente para um determinado orçamento, execute uma operação get antes da operação de colocação.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
budgetName
 path True

string

Nome do Orçamento.

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

string

O escopo associado às operações de orçamento.

Escopos com suporte para CategoryType: de custo

Escopos do RBAC do Azure:

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

Escopos do EA (Contrato Enterprise):

  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo da Conta de Cobrança
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para o escopo do departamento
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' para o escopo EnrollmentAccount

Escopos do MCA (Contrato de Cliente Moderno):

  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo da Conta de Cobrança
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo billingProfile
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' para o escopo invoiceSection
  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' para escopo do cliente (somente CSP)

Escopos com suporte para CategoryType: de ReservationUtilization

Escopos do EA (Contrato Enterprise):

  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para Escopo da Conta de Cobrança

Escopos do MCA (Contrato de Cliente Moderno):

  • '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo billingProfile (não somente 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 da solicitação

Nome Obrigató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 reserva.
properties.timeGrain True

TimeGrainType

O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granulação de tempo.

Com suporte para CategoryType(s): Custo, ReservationUtilization.

TimeGrainTypes com suporte para CategoryType: de custo

  • Mensal

  • Trimestral

  • Anualmente

  • BillingMonth*

  • BillingQuarter*

  • BillingAnnual*

    *com suporte apenas para clientes do Web Direct.

TimeGrainTypes com suporte para CategoryType: ReservationUtilization

  • Last7Days
  • Last30Days

Necessário para CategoryType(s): Custo, ReservationUtilization.
properties.timePeriod True

BudgetTimePeriod

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Necessário para CategoryType(s): Custo, ReservationUtilization.
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 ser acompanhado com o orçamento.

Com suporte para CategoryType(s): Custo.

Necessário para CategoryType(s): Custo.
properties.filter

BudgetFilter

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

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

<string,  Notification>

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.

  • Restrições para CategoryType: de custo – o orçamento pode ter até 5 notificações com thresholdType: Notificações reais e 5 com thresholdType: Previsto.
  • Restrições para CategoryType: de ReservationUtilization – apenas uma notificação permitida. thresholdType não é aplicável.

Respostas

Nome Tipo Description
200 OK

Budget

OKEY. A solicitação foi bem-sucedida e a atualização do Orçamento foi concluída.
201 Created

Budget

Criado.
Other Status Codes

ErrorResponse

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

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

Solicitação de exemplo

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 de exemplo

Código de status:
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 status:
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

Solicitação de exemplo

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 de exemplo

Código de status:
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 status:
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

Solicitação de exemplo

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 de exemplo

Código de status:
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 status:
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

Solicitação de exemplo

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 de exemplo

Código de status:
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 status:
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

Solicitação de exemplo

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 de exemplo

Código de status:
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 status:
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

Solicitação de exemplo

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 de exemplo

Código de status:
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 status:
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

Solicitação de exemplo

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 de exemplo

Código de status:
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 status:
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

Solicitação de exemplo

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 de exemplo

Código de status:
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 status:
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

Solicitação de exemplo

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 de exemplo

Código de status:
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 status:
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

Solicitação de exemplo

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 de exemplo

Código de status:
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 status:
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

Nome Description
Budget

Um recurso de orçamento.
BudgetComparisonExpression

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

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.
BudgetFilterProperties

As Dimensões ou Marcas para filtrar um orçamento.

Com suporte para CategoryType(s): Custo, ReservationUtilization.
BudgetNotificationOperatorType

O operador de comparação.

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Operadores com suporte para CategoryType: de custo

  • GreaterThan
  • GreaterThanOrEqualTo

Operadores com suporte para CategoryType: ReservationUtilization

  • LessThan
BudgetOperatorType

O operador a ser usado para comparação.
BudgetTimePeriod

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Necessário para CategoryType(s): Custo, ReservationUtilization.
CategoryType

A categoria do orçamento.

  • 'Custo' define um Orçamento.
  • 'ReservationUtilization' define uma regra de alerta de utilização de reserva.
CultureCode

Idioma no qual o destinatário receberá a notificação,

Com suporte para CategoryType(s): Custo, ReservationUtilization.
CurrentSpend

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

Com suporte 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 é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – 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 acompanhado para um orçamento.

Com suporte para CategoryType(s): Custo.
Frequency

Frequência de uma notificação. Representa por quanto tempo a notificação ficará silenciosa depois de 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, Monthly when timeGrain: Last30Days).

Com suporte para CategoryType(s): ReservationUtilization.
Notification

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.
ThresholdType

O tipo de limite.

Com suporte para CategoryType(s): Custo.
TimeGrainType

O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granulação de tempo.

Com suporte para CategoryType(s): Custo, ReservationUtilization.

TimeGrainTypes com suporte para CategoryType: de custo

  • Mensal

  • Trimestral

  • Anualmente

  • BillingMonth*

  • BillingQuarter*

  • BillingAnnual*

    *com suporte apenas para clientes do Web Direct.

TimeGrainTypes com suporte para CategoryType: ReservationUtilization

  • Last7Days
  • Last30Days

Necessário para CategoryType(s): Custo, ReservationUtilization.

Budget

Um recurso de orçamento.

Nome 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 ser acompanhado com o orçamento.

Com suporte para CategoryType(s): Custo.

Necessá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 reserva.
properties.currentSpend

CurrentSpend

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

Com suporte para CategoryType(s): Custo.
properties.filter

BudgetFilter

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

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

ForecastSpend

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

Com suporte para CategoryType(s): Custo.
properties.notifications

<string,  Notification>

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.

  • Restrições para CategoryType: de custo – o orçamento pode ter até 5 notificações com thresholdType: Notificações reais e 5 com thresholdType: Previsto.
  • Restrições para CategoryType: de ReservationUtilization – apenas uma notificação permitida. thresholdType não é aplicável.
properties.timeGrain

TimeGrainType

O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granulação de tempo.

Com suporte para CategoryType(s): Custo, ReservationUtilization.

TimeGrainTypes com suporte para CategoryType: de custo

  • Mensal

  • Trimestral

  • Anualmente

  • BillingMonth*

  • BillingQuarter*

  • BillingAnnual*

    *com suporte apenas para clientes do Web Direct.

TimeGrainTypes com suporte para CategoryType: ReservationUtilization

  • Last7Days
  • Last30Days

Necessário para CategoryType(s): Custo, ReservationUtilization.
properties.timePeriod

BudgetTimePeriod

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Necessário para CategoryType(s): Custo, ReservationUtilization.
type

string

Tipo de recurso.

BudgetComparisonExpression

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

Nome Tipo Description
name

string

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

BudgetOperatorType

O operador a ser usado para comparação.
values

string[]

Matriz de valores a serem usados para comparação

BudgetFilter

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Nome Tipo Description
and

BudgetFilterProperties[]

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

Com suporte para CategoryType(s): Custo.
dimensions

BudgetComparisonExpression

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Nomes de dimensão com suporte para CategoryType: de ReservationUtilization

  • ReservationId
  • ReservedResourceType
tags

BudgetComparisonExpression

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

Com suporte para CategoryType(s): Custo.

BudgetFilterProperties

As Dimensões ou Marcas para filtrar um orçamento.

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Nome Tipo Description
dimensions

BudgetComparisonExpression

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Nomes de dimensão com suporte para CategoryType: de ReservationUtilization

  • ReservationId
  • ReservedResourceType
tags

BudgetComparisonExpression

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

Com suporte para CategoryType(s): Custo.

BudgetNotificationOperatorType

O operador de comparação.

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Operadores com suporte para CategoryType: de custo

  • GreaterThan
  • GreaterThanOrEqualTo

Operadores com suporte para CategoryType: ReservationUtilization

  • LessThan
Nome Tipo Description
EqualTo

string

A notificação será disparada se o custo avaliado for o mesmo que o valor limite. Observação: não é recomendável usar esse OperatorType, pois há pouca chance de o custo ser exatamente o mesmo que o valor limite, levando à falta do alerta. Este OperatorType será preterido no futuro.

Com suporte para CategoryType(s): Custo.
GreaterThan

string

A notificação será disparada se o custo avaliado for maior que o valor limite. Observação: este é o OperatorType recomendado ao configurar o Alerta de Orçamento.

Com suporte para CategoryType(s): Custo.
GreaterThanOrEqualTo

string

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

Com suporte para CategoryType(s): Custo.
LessThan

string

A notificação será disparada se qualquer reserva no escopo da Regra de Alerta de Utilização de Reserva tiver uma utilização menor que a porcentagem de limite.

Com suporte para CategoryType(s): ReservationUtilization.

BudgetOperatorType

O operador a ser usado para comparação.

Nome 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 em ou após o startDate e expirará no endDate.

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Necessário para CategoryType(s): Custo, ReservationUtilization.

Nome Tipo Description
endDate

string

A data de término do orçamento.

  • Restrições para CategoryType: de 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: de 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 CategoryType: de custo – deve ser o primeiro do mês e deve ser menor que a data de término. 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 temporais.

  • Restrições para CategoryType: de ReservationUtilization – deve estar ativada ou após a data atual e menor que a data de término.

CategoryType

A categoria do orçamento.

  • 'Custo' define um Orçamento.
  • 'ReservationUtilization' define uma regra de alerta de utilização de reserva.
Nome 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 o percentual de utilização das Reservas do Azure e alertas com base em um limite de notificação configurado.

CultureCode

Idioma no qual o destinatário receberá a notificação,

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Nome 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 acompanhado para um orçamento.

Com suporte para CategoryType(s): Custo.

Nome Tipo Description
amount

number

O valor total do custo que está sendo acompanhado pelo orçamento.
unit

string

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

ErrorDetails

Os detalhes do erro.

Nome 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 é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

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

Nome Tipo Description
error

ErrorDetails

Os detalhes do erro.

ForecastSpend

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

Com suporte para CategoryType(s): Custo.

Nome Tipo Description
amount

number

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

string

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

Frequency

Frequência de uma notificação. Representa por quanto tempo a notificação ficará silenciosa depois de 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, Monthly when timeGrain: Last30Days).

Com suporte para CategoryType(s): ReservationUtilization.

Nome Tipo Description
Daily

string

Depois que o limite for violado e um Alerta for acionado, nenhum alerta adicional será enviado até o próximo dia do calendário.
Monthly

string

Depois que as violações de limite e um alerta forem disparados, nenhum alerta adicional será enviado por 30 dias.
Weekly

string

Depois que as violações de limite e um alerta forem disparados, nenhum alerta adicional será enviado por sete dias.

Notification

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Nome Tipo Valor padrão Description
contactEmails

string[]

Endereços de email 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 de Assinatura ou Grupo de Recursos. Todos os outros escopos devem ter pelo menos um email de contato especificado.

Com suporte para CategoryType(s): Custo, ReservationUtilization.
contactGroups

string[]

Somente escopos de assinatura ou grupo de recursos. Grupos de ações para o qual enviar a notificação quando o limite for excedido. Deve ser fornecido como uma ID de recurso do Azure totalmente qualificada.

Com suporte para CategoryType(s): Custo.
contactRoles

string[]

Somente escopos de assinatura ou grupo de recursos. Contate as funções para enviar a notificação quando o limite for violado.

Com suporte para CategoryType(s): Custo.
enabled

boolean

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.
frequency

Frequency

Frequência de uma notificação. Representa por quanto tempo a notificação ficará silenciosa depois de 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, Monthly when timeGrain: Last30Days).

Com suporte para CategoryType(s): ReservationUtilization.
locale

CultureCode

Idioma no qual o destinatário receberá a notificação,

Com suporte para CategoryType(s): Custo, ReservationUtilization.
operator

BudgetNotificationOperatorType

O operador de comparação.

Com suporte para CategoryType(s): Custo, ReservationUtilization.

Operadores com suporte para CategoryType: de custo

  • GreaterThan
  • GreaterThanOrEqualTo

Operadores com suporte para CategoryType: ReservationUtilization

  • LessThan
threshold

number

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

Com suporte para CategoryType(s): Custo, ReservationUtilization.

CategoryType: de custo – deve estar entre 0 e 1000. A notificação é enviada quando o custo excede o limite.

CategoryType: de ReservationUtilization – deve estar entre 0 e 100. A notificação é enviada quando uma reserva tem um percentual de utilização abaixo do limite.
thresholdType

ThresholdType

Actual

O tipo de limite.

Com suporte para CategoryType(s): Custo.

ThresholdType

O tipo de limite.

Com suporte para CategoryType(s): Custo.

Nome Tipo Description
Actual

string

Os alertas de orçamento de custos reais são notificados 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 seu orçamento alocado, pois depende de previsões de custos previstas.

TimeGrainType

O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granulação de tempo.

Com suporte para CategoryType(s): Custo, ReservationUtilization.

TimeGrainTypes com suporte para CategoryType: de custo

  • Mensal

  • Trimestral

  • Anualmente

  • BillingMonth*

  • BillingQuarter*

  • BillingAnnual*

    *com suporte apenas para clientes do Web Direct.

TimeGrainTypes com suporte para CategoryType: ReservationUtilization

  • Last7Days
  • Last30Days

Necessário para CategoryType(s): Custo, ReservationUtilization.

Nome Tipo Description
Annually

string

O orçamento acompanhará os custos no ano civil atual em relação ao valor.

Com suporte para CategoryType: somente custo.
BillingAnnual

string

O orçamento acompanhará os custos no ano de cobrança atual em relação ao valor.

Com suporte para CategoryType: somente clientes de Custo e Web Direct.
BillingMonth

string

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

Com suporte para CategoryType: somente clientes de Custo e Web Direct.
BillingQuarter

string

O orçamento acompanhará os custos no trimestre de cobrança atual em relação ao valor.

Com suporte para CategoryType: somente clientes de Custo e Web Direct.
Last30Days

string

A Regra de Alerta de Utilização de Reserva avaliará as reservas com base no percentual de utilização de 30 dias.

Com suporte para CategoryType: Somente ReservationUtilization.
Last7Days

string

A Regra de Alerta de Utilização de Reserva avaliará as reservas com base no percentual de utilização de 7 dias.

Com suporte para CategoryType: Somente ReservationUtilization.
Monthly

string

O orçamento acompanhará os custos no mês do calendário atual em relação ao valor.

Com suporte para CategoryType: somente custo.
Quarterly

string

O orçamento acompanhará os custos no trimestre calendário atual em relação ao valor.

Com suporte para CategoryType: somente custo.