Webhook - Create Or Update

Dienst:

Automation

API-Version:

2024-10-23

Erstellen Sie den webhook, der durch den Webhook-Namen identifiziert wurde.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
automationAccountName	path	True	string	Der Name des Automatisierungskontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Name einer Azure-Ressourcengruppe.
subscriptionId	path	True	string	Ruft Abonnementanmeldeinformationen ab, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
webhookName	path	True	string	Der Webhook-Name.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Dient zum Abrufen oder Festlegen des Namens des Webhooks.
properties.expiryTime		string (date-time)	Ruft die Ablaufzeit ab oder legt sie fest.
properties.isEnabled		boolean	Dient zum Abrufen oder Festlegen des Werts des aktivierten Flags von Webhook.
properties.parameters		object	Dient zum Abrufen oder Festlegen der Parameter des Auftrags.
properties.runOn		string	Ruft den Namen der Hybridarbeitsgruppe ab, auf der der Webhook-Auftrag ausgeführt wird, oder legt den Namen fest.
properties.runbook		RunbookAssociationProperty	Ruft das Runbook ab oder legt es fest.
properties.uri		string	Dient zum Abrufen oder Festlegen des URI.

Antworten

Name	Typ	Beschreibung
200 OK	Webhook	OKAY
201 Created	Webhook	Erstellt
Other Status Codes	ErrorResponse	Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Create or update webhook

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorResponse	Fehlerantwort eines Vorgangsfehlers
RunbookAssociationProperty	Die Runbook-Eigenschaft, die der Entität zugeordnet ist.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
Webhook	Definition des Webhook-Typs.
WebhookCreateOrUpdateParameters	Die Parameter, die für den Erstellungs- oder Aktualisierungswebhook-Vorgang bereitgestellt werden.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Fehlerantwort eines Vorgangsfehlers

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

RunbookAssociationProperty

Objekt

Die Runbook-Eigenschaft, die der Entität zugeordnet ist.

Name	Typ	Beschreibung
name	string	Ruft den Namen des Runbook ab oder legt den Namen fest.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Webhook

Objekt

Definition des Webhook-Typs.

Name	Typ	Standardwert	Beschreibung
id	string (arm-id)		Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Der Name der Ressource
properties.creationTime	string (date-time)		Ruft die Erstellungszeit ab oder legt sie fest.
properties.description	string		Ruft die Beschreibung ab oder legt sie fest.
properties.expiryTime	string (date-time)		Ruft die Ablaufzeit ab oder legt sie fest.
properties.isEnabled	boolean	False	Dient zum Abrufen oder Festlegen des Werts des aktivierten Flags des Webhooks.
properties.lastInvokedTime	string (date-time)		Ruft die letzte aufgerufene Uhrzeit ab oder legt sie fest.
properties.lastModifiedBy	string		Details des Benutzers, der den Webhook zuletzt geändert hat
properties.lastModifiedTime	string (date-time)		Ruft die Uhrzeit der letzten Änderung ab oder legt sie fest.
properties.parameters	object		Dient zum Abrufen oder Festlegen der Parameter des Auftrags, der erstellt wird, wenn der Webhook das Runbook aufruft, dem es zugeordnet ist.
properties.runOn	string		Ruft den Namen der Hybridarbeitsgruppe ab, auf der der Webhook-Auftrag ausgeführt wird, oder legt den Namen fest.
properties.runbook	RunbookAssociationProperty		Ruft das Runbook ab, dem der Webhook zugeordnet ist, oder legt es fest.
properties.uri	string		Dient zum Abrufen oder Festlegen des Webhook-URI.
systemData	systemData		Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

WebhookCreateOrUpdateParameters

Objekt

Die Parameter, die für den Erstellungs- oder Aktualisierungswebhook-Vorgang bereitgestellt werden.

Name	Typ	Beschreibung
name	string	Dient zum Abrufen oder Festlegen des Namens des Webhooks.
properties.expiryTime	string (date-time)	Ruft die Ablaufzeit ab oder legt sie fest.
properties.isEnabled	boolean	Dient zum Abrufen oder Festlegen des Werts des aktivierten Flags von Webhook.
properties.parameters	object	Dient zum Abrufen oder Festlegen der Parameter des Auftrags.
properties.runOn	string	Ruft den Namen der Hybridarbeitsgruppe ab, auf der der Webhook-Auftrag ausgeführt wird, oder legt den Namen fest.
properties.runbook	RunbookAssociationProperty	Ruft das Runbook ab oder legt es fest.
properties.uri	string	Dient zum Abrufen oder Festlegen des URI.