Compartilhar via


Webhook - Create Or Update

Crie o webhook identificado pelo nome do webhook.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}?api-version=2015-10-31

Parâmetros de URI

Nome Em Obrigatório Tipo Description
automationAccountName
path True

string

O nome da conta de automação.

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._]+$

Nome de um grupo de recursos do Azure.

subscriptionId
path True

string

Obtém credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

webhookName
path True

string

O nome do webhook.

api-version
query True

string

Versão da API do cliente.

Corpo da solicitação

Nome Obrigatório Tipo Description
name True

string

Obtém ou define o nome do webhook.

properties.expiryTime

string (date-time)

Obtém ou define o tempo de expiração.

properties.isEnabled

boolean

Obtém ou define o valor do sinalizador habilitado do webhook.

properties.parameters

object

Obtém ou define os parâmetros do trabalho.

properties.runOn

string

Obtém ou define o nome do grupo de trabalho híbrido em que o trabalho de webhook será executado.

properties.runbook

RunbookAssociationProperty

Obtém ou define o runbook.

properties.uri

string

Obtém ou define o uri.

Respostas

Nome Tipo Description
200 OK

Webhook

OKEY

201 Created

Webhook

Criado

Other Status Codes

ErrorResponse

Resposta de erro de automação descrevendo 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

Create or update webhook

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook?api-version=2015-10-31

{
  "name": "TestWebhook",
  "properties": {
    "isEnabled": true,
    "uri": "<uri>",
    "expiryTime": "2018-03-29T22:18:13.7002872Z",
    "runbook": {
      "name": "TestRunbook"
    }
  }
}

Resposta de exemplo

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
  "name": "TestWebhook",
  "type": "Microsoft.Automation/AutomationAccounts/Webhooks",
  "properties": {
    "isEnabled": true,
    "expiryTime": "2018-03-29T22:18:13.7002872+00:00",
    "runbook": {
      "name": "TestRunbook"
    },
    "lastInvokedTime": null,
    "runOn": null,
    "parameters": null,
    "uri": "",
    "creationTime": "2017-03-29T22:18:14.6651862+00:00",
    "lastModifiedBy": "",
    "lastModifiedTime": "2017-03-29T22:18:14.6651862+00:00"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
  "name": "TestWebhook",
  "type": "Microsoft.Automation/AutomationAccounts/Webhooks",
  "properties": {
    "isEnabled": true,
    "expiryTime": "2018-03-29T22:18:13.7002872+00:00",
    "runbook": {
      "name": "TestRunbook"
    },
    "lastInvokedTime": null,
    "runOn": null,
    "parameters": null,
    "uri": "",
    "creationTime": "2017-03-29T22:18:14.6651862+00:00",
    "lastModifiedBy": "",
    "lastModifiedTime": "2017-03-29T22:18:14.6651862+00:00"
  }
}

Definições

Nome Description
ErrorResponse

Resposta de erro de uma falha de operação

RunbookAssociationProperty

A propriedade runbook associada à entidade.

Webhook

Definição do tipo de webhook.

WebhookCreateOrUpdateParameters

Os parâmetros fornecidos para a operação de criação ou atualização de webhook.

ErrorResponse

Resposta de erro de uma falha de operação

Nome Tipo Description
code

string

Código de erro

message

string

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

RunbookAssociationProperty

A propriedade runbook associada à entidade.

Nome Tipo Description
name

string

Obtém ou define o nome do runbook.

Webhook

Definição do tipo de webhook.

Nome Tipo Valor padrão Description
id

string

ID de recurso totalmente qualificada para o recurso

name

string

O nome do recurso

properties.creationTime

string (date-time)

Obtém ou define o tempo de criação.

properties.description

string

Obtém ou define a descrição.

properties.expiryTime

string (date-time)

Obtém ou define o tempo de expiração.

properties.isEnabled

boolean

False

Obtém ou define o valor do sinalizador habilitado do webhook.

properties.lastInvokedTime

string (date-time)

Obtém ou define a hora da última invocação.

properties.lastModifiedBy

string

Detalhes do usuário que modificou o Webhook pela última vez

properties.lastModifiedTime

string (date-time)

Obtém ou define a hora da última modificação.

properties.parameters

object

Obtém ou define os parâmetros do trabalho que é criado quando o webhook chama o runbook ao qual está associado.

properties.runOn

string

Obtém ou define o nome do grupo de trabalho híbrido em que o trabalho de webhook será executado.

properties.runbook

RunbookAssociationProperty

Obtém ou define o runbook ao qual o webhook está associado.

properties.uri

string

Obtém ou define o uri do webhook.

type

string

O tipo do recurso.

WebhookCreateOrUpdateParameters

Os parâmetros fornecidos para a operação de criação ou atualização de webhook.

Nome Tipo Description
name

string

Obtém ou define o nome do webhook.

properties.expiryTime

string (date-time)

Obtém ou define o tempo de expiração.

properties.isEnabled

boolean

Obtém ou define o valor do sinalizador habilitado do webhook.

properties.parameters

object

Obtém ou define os parâmetros do trabalho.

properties.runOn

string

Obtém ou define o nome do grupo de trabalho híbrido em que o trabalho de webhook será executado.

properties.runbook

RunbookAssociationProperty

Obtém ou define o runbook.

properties.uri

string

Obtém ou define o uri.