Partilhar via

New-AzureRMAutomationWebhook

  • Referência
Módulo:
AzureRM.Automation

Cria um webhook para um runbook de automação.

Aviso

O módulo AzureRM do PowerShell foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo Az PowerShell para garantir suporte e atualizações contínuos.

Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso continuado a critério e risco do usuário. Consulte nossos recursos de migração para obter orientação sobre a transição para o módulo Az.

Sintaxe

New-AzureRMAutomationWebhook
   [-Name] <String>
   [-RunbookName] <String>
   [-IsEnabled] <Boolean>
   [-ExpiryTime] <DateTimeOffset>
   [-Parameters <IDictionary>]
   [-Force]
   [-RunOn <String>]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

O cmdlet New-AzureRmAutomationWebhook cria um webhook para um runbook de Automação do Azure. Certifique-se de salvar a URL do webhook que esse cmdlet retorna, pois ela não pode ser recuperada novamente.

Exemplos

Exemplo 1: Criar um webhook

PS C:\>$Webhook = New-AzureRmAutomationWebhook -Name "Webhook06" -IsEnabled $True -ExpiryTime "10/2/2016" -RunbookName "ContosoRunbook" -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Force

Este comando cria um webhook chamado Webhook06 para o runbook chamado ContosoRunbook na conta de automação chamada AutomationAccount01. O comando armazena o webhook na variável $Webhook. O webhook está ativado. O webhook expira no momento especificado. Este comando não fornece valores para parâmetros de webhook. Este comando especifica o parâmetro Force . Portanto, ele não solicita a confirmação.

Exemplo 2: Criar um webhook com parâmetros

PS C:\>$Params = @{"StringParam"="Hello World";"IntegerParam"=32}
PS C:\> $Webhook = New-AzureRmAutomationWebhook -Name "Webhook11" -Parameters $Params -IsEnabled $True -ExpiryTime "10/2/2016" -RunbookName "ContosoRunbook" -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Force

O primeiro comando cria um dicionário de parâmetros e os armazena na variável $Params. O segundo comando cria um webhook chamado Webhook11 para o runbook chamado ContosoRunbook na conta de automação chamada AutomationAccount01. O comando atribui os parâmetros em $Params ao webhook.

Parâmetros

-AutomationAccountName

Especifica o nome de uma conta de automação na qual esse cmdlet cria um webhook.

Tipo:String
Position:1
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DefaultProfile

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

Tipo:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ExpiryTime

Especifica o tempo de expiração para o webhook como um objeto DateTimeOffset . Você pode especificar uma cadeia de caracteres ou um DateTime que pode ser convertido em um DateTimeOffset válido.

Tipo:DateTimeOffset
Position:5
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Force

ps_force

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-IsEnabled

Especifica se o webhook está habilitado.

Tipo:Boolean
Position:4
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Name

Especifica um nome para o webhook.

Tipo:String
Position:2
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Parameters

Especifica um dicionário de pares chave/valor. As chaves são os nomes dos parâmetros runbook. Os valores são os valores dos parâmetros runbook. Quando o runbook é iniciado em resposta a um webhook, esses parâmetros são passados para o runbook.

Tipo:IDictionary
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ResourceGroupName

Especifica o nome do grupo de recursos para o qual esse cmdlet cria um webhook.

Tipo:String
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-RunbookName

Especifica o nome do runbook a ser associado ao webhook.

Tipo:String
Position:3
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-RunOn

Nome opcional do grupo de trabalhadores híbridos que deve executar o runbook

Tipo:String
Aliases:HybridWorker
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

String

Boolean

DateTimeOffset

Saídas

Webhook