Webhook - Create Or Update

Servicio:

Automation

Versión de la API:

2024-10-23

Cree el webhook identificado por el nombre del webhook.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
automationAccountName	path	True	string	Nombre de la cuenta de Automation.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nombre de un grupo de recursos de Azure.
subscriptionId	path	True	string	Obtiene las credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
webhookName	path	True	string	Nombre del webhook.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Obtiene o establece el nombre del webhook.
properties.expiryTime		string (date-time)	Obtiene o establece la hora de expiración.
properties.isEnabled		boolean	Obtiene o establece el valor de la marca habilitada de webhook.
properties.parameters		object	Obtiene o establece los parámetros del trabajo.
properties.runOn		string	Obtiene o establece el nombre del grupo de Hybrid Worker en el que se ejecutará el trabajo de webhook.
properties.runbook		RunbookAssociationProperty	Obtiene o establece el runbook.
properties.uri		string	Obtiene o establece el URI.

Respuestas

Nombre	Tipo	Description
200 OK	Webhook	De acuerdo
201 Created	Webhook	Creado
Other Status Codes	ErrorResponse	Respuesta de error de Automation que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create or update webhook

Solicitud de ejemplo

HTTP

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

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

Respuesta de muestra

status code:

201

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

status code:

200

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

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorResponse	Respuesta de error de un error de operación
RunbookAssociationProperty	La propiedad runbook asociada a la entidad.
systemData	Metadatos relativos a la creación y última modificación del recurso.
Webhook	Definición del tipo de webhook.
WebhookCreateOrUpdateParameters	Los parámetros proporcionados a la operación de creación o actualización del webhook.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Respuesta de error de un error de operación

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

RunbookAssociationProperty

Object

La propiedad runbook asociada a la entidad.

Nombre	Tipo	Description
name	string	Obtiene o establece el nombre del runbook.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Webhook

Object

Definición del tipo de webhook.

Nombre	Tipo	Valor predeterminado	Description
id	string (arm-id)		Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Nombre del recurso
properties.creationTime	string (date-time)		Obtiene o establece la hora de creación.
properties.description	string		Obtiene o establece la descripción.
properties.expiryTime	string (date-time)		Obtiene o establece la hora de expiración.
properties.isEnabled	boolean	False	Obtiene o establece el valor de la marca habilitada del webhook.
properties.lastInvokedTime	string (date-time)		Obtiene o establece la última hora invocada.
properties.lastModifiedBy	string		Detalles del usuario que modificó por última vez el webhook
properties.lastModifiedTime	string (date-time)		Obtiene o establece la hora de la última modificación.
properties.parameters	object		Obtiene o establece los parámetros del trabajo que se crea cuando el webhook llama al runbook al que está asociado.
properties.runOn	string		Obtiene o establece el nombre del grupo de Hybrid Worker en el que se ejecutará el trabajo de webhook.
properties.runbook	RunbookAssociationProperty		Obtiene o establece el runbook al que está asociado el webhook.
properties.uri	string		Obtiene o establece el URI del webhook.
systemData	systemData		Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string		Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WebhookCreateOrUpdateParameters

Object

Los parámetros proporcionados a la operación de creación o actualización del webhook.

Nombre	Tipo	Description
name	string	Obtiene o establece el nombre del webhook.
properties.expiryTime	string (date-time)	Obtiene o establece la hora de expiración.
properties.isEnabled	boolean	Obtiene o establece el valor de la marca habilitada de webhook.
properties.parameters	object	Obtiene o establece los parámetros del trabajo.
properties.runOn	string	Obtiene o establece el nombre del grupo de Hybrid Worker en el que se ejecutará el trabajo de webhook.
properties.runbook	RunbookAssociationProperty	Obtiene o establece el runbook.
properties.uri	string	Obtiene o establece el URI.