Webhook - Create Or Update

Service:: Automation

Version d'API:: 2024-10-23

Créez le webhook identifié par le nom du webhook.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
automationAccountName	path	True	string	Nom du compte Automation.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nom d’un groupe de ressources Azure.
subscriptionId	path	True	string	Obtient les informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
webhookName	path	True	string	Nom du webhook.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Obligatoire	Type	Description
name	True	string	Obtient ou définit le nom du webhook.
properties.expiryTime		string (date-time)	Obtient ou définit l’heure d’expiration.
properties.isEnabled		boolean	Obtient ou définit la valeur de l’indicateur activé du webhook.
properties.parameters		object	Obtient ou définit les paramètres du travail.
properties.runOn		string	Obtient ou définit le nom du groupe worker hybride sur lequel le travail webhook s’exécute.
properties.runbook		RunbookAssociationProperty	Obtient ou définit le runbook.
properties.uri		string	Obtient ou définit l’URI.

Réponses

Nom	Type	Description
200 OK	Webhook	Ok
201 Created	Webhook	Date de création
Other Status Codes	ErrorResponse	Réponse d’erreur Automation décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Create or update webhook

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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"
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorResponse	Réponse d’erreur d’un échec d’opération
RunbookAssociationProperty	Propriété runbook associée à l’entité.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
Webhook	Définition du type de webhook.
WebhookCreateOrUpdateParameters	Paramètres fournis à l’opération de création ou de mise à jour du webhook.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Réponse d’erreur d’un échec d’opération

Nom	Type	Description
code	string	Code d’erreur
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

RunbookAssociationProperty

Object

Propriété runbook associée à l’entité.

Nom	Type	Description
name	string	Obtient ou définit le nom du runbook.

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Webhook

Object

Définition du type de webhook.

Nom	Type	Valeur par défaut	Description
id	string (arm-id)		ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string		Nom de la ressource
properties.creationTime	string (date-time)		Obtient ou définit l’heure de création.
properties.description	string		Obtient ou définit la description.
properties.expiryTime	string (date-time)		Obtient ou définit l’heure d’expiration.
properties.isEnabled	boolean	False	Obtient ou définit la valeur de l’indicateur activé du webhook.
properties.lastInvokedTime	string (date-time)		Obtient ou définit la dernière heure appelée.
properties.lastModifiedBy	string		Détails de l’utilisateur qui a modifié le Webhook pour la dernière fois
properties.lastModifiedTime	string (date-time)		Obtient ou définit l’heure de dernière modification.
properties.parameters	object		Obtient ou définit les paramètres du travail créé lorsque le webhook appelle le runbook auquel il est associé.
properties.runOn	string		Obtient ou définit le nom du groupe worker hybride sur lequel le travail webhook s’exécute.
properties.runbook	RunbookAssociationProperty		Obtient ou définit le runbook avec lequel le webhook est associé.
properties.uri	string		Obtient ou définit l’URI du webhook.
systemData	systemData		Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

WebhookCreateOrUpdateParameters

Object

Paramètres fournis à l’opération de création ou de mise à jour du webhook.

Nom	Type	Description
name	string	Obtient ou définit le nom du webhook.
properties.expiryTime	string (date-time)	Obtient ou définit l’heure d’expiration.
properties.isEnabled	boolean	Obtient ou définit la valeur de l’indicateur activé du webhook.
properties.parameters	object	Obtient ou définit les paramètres du travail.
properties.runOn	string	Obtient ou définit le nom du groupe worker hybride sur lequel le travail webhook s’exécute.
properties.runbook	RunbookAssociationProperty	Obtient ou définit le runbook.
properties.uri	string	Obtient ou définit l’URI.

Partager via

Webhook - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Create or update webhook

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorResponse

RunbookAssociationProperty

systemData

Webhook

WebhookCreateOrUpdateParameters