Freigeben über


Webhook - Create Or Update

Erstellen Sie den Webhook, der durch den Namen des Webhooks identifiziert wird.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
automationAccountName
path True

string

Der Name des Automation-Kontos.

resourceGroupName
path True

string

Name einer Azure-Ressourcengruppe.

RegEx-Muster: ^[-\w\._]+$

subscriptionId
path True

string

Ruft die 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 Webhookname.

api-version
query True

string

Client-API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
name True

string

Ruft den Namen des Webhooks ab oder legt den Namen fest.

properties.expiryTime

string

Ruft die Ablaufzeit ab oder legt sie fest.

properties.isEnabled

boolean

Ruft den Wert des aktivierten Flags des Webhooks ab oder legt den Wert fest.

properties.parameters

object

Ruft die Parameter des Auftrags ab oder legt sie fest.

properties.runOn

string

Ruft den Namen der Hybrid Workergruppe ab, auf der der Webhookauftrag ausgeführt wird, oder legt den Namen fest.

properties.runbook

RunbookAssociationProperty

Ruft das Runbook ab oder legt es fest.

properties.uri

string

Ruft den URI ab oder legt den URI fest.

Antworten

Name Typ Beschreibung
200 OK

Webhook

OK

201 Created

Webhook

Erstellt

Other Status Codes

ErrorResponse

Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorResponse

Fehlerantwort eines Vorgangsfehlers

RunbookAssociationProperty

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

Webhook

Definition des Webhooktyps.

WebhookCreateOrUpdateParameters

Die Parameter, die für den Webhookvorgang zum Erstellen oder Aktualisieren bereitgestellt werden.

ErrorResponse

Fehlerantwort eines Vorgangsfehlers

Name Typ Beschreibung
code

string

Fehlercode

message

string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

RunbookAssociationProperty

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

Name Typ Beschreibung
name

string

Ruft den Namen des Runbooks ab oder legt den Namen fest.

Webhook

Definition des Webhooktyps.

Name Typ Standardwert Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource

name

string

Der Name der Ressource

properties.creationTime

string

Ruft die Erstellungszeit ab oder legt diese fest.

properties.description

string

Ruft die Beschreibung ab oder legt sie fest.

properties.expiryTime

string

Ruft die Ablaufzeit ab oder legt sie fest.

properties.isEnabled

boolean

False

Ruft den Wert des aktivierten Flags des Webhooks ab oder legt den Wert fest.

properties.lastInvokedTime

string

Ruft den Zeitpunkt des letzten Aufrufs ab oder legt diesen fest.

properties.lastModifiedBy

string

Details des Benutzers, der den Webhook zuletzt geändert hat

properties.lastModifiedTime

string

Ruft den Zeitpunkt der letzten Änderung ab oder legt diese fest.

properties.parameters

object

Ruft die Parameter des Auftrags ab, der erstellt wird, wenn der Webhook das Runbook aufruft, dem er zugeordnet ist, oder legt diese fest.

properties.runOn

string

Ruft den Namen der Hybrid Workergruppe ab, auf der der Webhookauftrag 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

Ruft den Webhook-URI ab oder legt diese fest.

type

string

Der Typ der Ressource.

WebhookCreateOrUpdateParameters

Die Parameter, die für den Webhookvorgang zum Erstellen oder Aktualisieren bereitgestellt werden.

Name Typ Beschreibung
name

string

Ruft den Namen des Webhooks ab oder legt den Namen fest.

properties.expiryTime

string

Ruft die Ablaufzeit ab oder legt sie fest.

properties.isEnabled

boolean

Ruft den Wert des aktivierten Flags des Webhooks ab oder legt den Wert fest.

properties.parameters

object

Ruft die Parameter des Auftrags ab oder legt sie fest.

properties.runOn

string

Ruft den Namen der Hybrid Workergruppe ab, auf der der Webhookauftrag ausgeführt wird, oder legt den Namen fest.

properties.runbook

RunbookAssociationProperty

Ruft das Runbook ab oder legt es fest.

properties.uri

string

Ruft den URI ab oder legt den URI fest.