Compartilhar via

Set-AzConsumptionBudget

  • Referência
Módulo:
Az.Billing

Atualize um orçamento em uma assinatura ou em um grupo de recursos.

Sintaxe

Set-AzConsumptionBudget
   [-DefaultProfile <IAzureContextContainer>]
   -Name <String>
   [-Amount <Decimal>]
   [-Category <String>]
   [-TimeGrain <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-ResourceGroupName <String>]
   [-MeterFilter <String[]>]
   [-ResourceFilter <String[]>]
   [-ResourceGroupFilter <String[]>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzConsumptionBudget
   [-DefaultProfile <IAzureContextContainer>]
   -Name <String>
   [-Amount <Decimal>]
   [-Category <String>]
   [-TimeGrain <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-ResourceGroupName <String>]
   [-MeterFilter <String[]>]
   [-ResourceFilter <String[]>]
   [-ResourceGroupFilter <String[]>]
   -NotificationKey <String>
   [-NotificationEnabled]
   [-NotificationThreshold <Decimal>]
   [-ContactEmail <String[]>]
   [-ContactGroup <String[]>]
   [-ContactRole <String[]>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzConsumptionBudget
   [-DefaultProfile <IAzureContextContainer>]
   -InputObject <PSBudget>
   [-Amount <Decimal>]
   [-Category <String>]
   [-TimeGrain <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-MeterFilter <String[]>]
   [-ResourceFilter <String[]>]
   [-ResourceGroupFilter <String[]>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzConsumptionBudget
   [-DefaultProfile <IAzureContextContainer>]
   -InputObject <PSBudget>
   [-Amount <Decimal>]
   [-Category <String>]
   [-TimeGrain <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-MeterFilter <String[]>]
   [-ResourceFilter <String[]>]
   [-ResourceGroupFilter <String[]>]
   -NotificationKey <String>
   [-NotificationEnabled]
   [-NotificationThreshold <Decimal>]
   [-ContactEmail <String[]>]
   [-ContactGroup <String[]>]
   [-ContactRole <String[]>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

O cmdlet Set-AzConsumptionBudget atualiza um orçamento em uma assinatura ou em um grupo de recursos.

Exemplos

Exemplo 1: atualizar um orçamento por um novo valor com um nome de orçamento no nível da assinatura

Set-AzConsumptionBudget -Name PSBudget -Amount 75

Amount:  75		
Category:  Cost
CurrentSpend:  null
Id:  subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget
Name:  PSBudget
TimeGrain:  Monthly
TimePeriod:  EndDate:  11/1/2018 12:00:00 AM
             StartDate:  6/1/2018 12:00:00 AM
Type:  Microsoft.Consumption/budgets

Exemplo 2: atualizar um orçamento com uma notificação quando o custo ou o uso atingir um limite de 90% do valor no nível da assinatura

Set-AzConsumptionBudget -Name PSBudget -NotificationKey notificationKey-ps1234 -NotificationEnabled -NotificationThreshold 90 -ContactEmail @('johndoe@contoso.com','janesmith@contoso.com') -ContactRole Owner,Reader,Contributor

Amount:  75		
Category:  Cost
CurrentSpend:  null
Id:  subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/providers/Microsoft.Consumption/budgets/PSBudget
Name:  PSBudget
Notification:  NotificationKey:  notificationKey-ps1234
               Threshold:  90
               Enabled:  true
               ContactEmail:  johndoe@contoso.com,janesmith@contoso.com
               ContactRole:  Owner,Reader,Contributor
TimeGrain:  Monthly
TimePeriod:  EndDate:  11/1/2018 12:00:00 AM
             StartDate:  6/1/2018 12:00:00 AM
Type:  Microsoft.Consumption/budgets

Exemplo 3: atualizar um orçamento por um novo valor com um nome de orçamento no nível do grupo de recursos

Set-AzConsumptionBudget -ResourceGroupName RGBudgets -Name PSBudgetRG -Amount 75

Amount:  75		
Category:  Cost
CurrentSpend:  null
Id:  subscriptions/1caaa5a3-2b66-438e-8ab4-bce37d518c5d/resourceGroups/RGBudgets/providers/Microsoft.Consumption/budgets/PSBudgetRG
Name:  PSBudgetRG
TimeGrain:  Monthly
TimePeriod:  EndDate:  11/1/2018 12:00:00 AM
             StartDate:  6/1/2018 12:00:00 AM
Type:  Microsoft.Consumption/budgets

Parâmetros

-Amount

Valor de um orçamento.

Tipo:Nullable<T>[Decimal]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Category

A categoria do orçamento pode ser custo ou uso.

Tipo:String
Valores aceitos:Cost, Usage
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Confirm

Solicita a confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ContactEmail

Endereços de email para o qual enviar a notificação de orçamento quando o limite for excedido.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ContactGroup

Grupos de ações para enviar a notificação de orçamento para quando o limite for excedido.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ContactRole

Contate as funções para enviar a notificação de orçamento para quando o limite for excedido.

Tipo:String[]
Valores aceitos:Owner, Reader, Contributor
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EndDate

Data de término (YYYY-MM-DD em UTC) do período de tempo de um orçamento.

Tipo:Nullable<T>[DateTime]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-InputObject

Objeto budget.

Tipo:PSBudget
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-MeterFilter

Lista separada por vírgulas de medidores para filtrar. Obrigatório se a categoria for uso.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Name

Nome de um orçamento.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-NotificationEnabled

A notificação está habilitada. Se não for especificado, a notificação será desabilitada por padrão.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-NotificationKey

Chave de uma notificação associada a um orçamento, necessária para criar uma notificação com comutador habilitado para notificação, limite de notificação, emails de contato, grupos de contatos ou funções de contato.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-NotificationThreshold

Valor de limite associado a uma notificação. A notificação é enviada quando o custo ou o uso excede o limite. É sempre por cento e tem que estar entre 0 e 1000.

Tipo:Nullable<T>[Decimal]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceFilter

Lista separada por vírgulas de instâncias de recurso para filtrar.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceGroupFilter

Lista separada por vírgulas de grupos de recursos para filtrar.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceGroupName

Grupo de recursos de um orçamento.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-StartDate

Data de início (YYYY-MM-DD em UTC) do período de tempo de um orçamento. Não antes do mês atual para o grão de tempo mensal. Não antes de três meses para grãos de tempo trimestrais. Não antes de doze meses para o grão temporal anual. Data de início futura não mais do que três meses.

Tipo:Nullable<T>[DateTime]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-TimeGrain

A granulação temporal do orçamento pode ser mensal, trimestral ou anual.

Tipo:String
Valores aceitos:Monthly, Quarterly, Annually
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

PSBudget

Saídas

PSBudget

Observações

  • Atualmente, o SDK do PowerShell para Consumo só está disponível para clientes do Contrato Enterprise.
  • O SDK do PowerShell para Consumo está usando uma versão mais antiga da API de Orçamentos e alguns itens não compatíveis com versões anteriores, como listar orçamentos com filtros, não funcionarão conforme o esperado.