Webhook - Create Or Update

Servizio:

Automation

Versione API:

2024-10-23

Creare il webhook identificato dal nome del webhook.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
automationAccountName	path	True	string	Nome dell'account di automazione.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nome di un gruppo di risorse di Azure.
subscriptionId	path	True	string	Ottiene le credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
webhookName	path	True	string	Nome del webhook.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
name	True	string	Ottiene o imposta il nome del webhook.
properties.expiryTime		string (date-time)	Ottiene o imposta l'ora di scadenza.
properties.isEnabled		boolean	Ottiene o imposta il valore del flag abilitato del webhook.
properties.parameters		object	Ottiene o imposta i parametri del processo.
properties.runOn		string	Ottiene o imposta il nome del gruppo di lavoro ibrido in cui verrà eseguito il processo webhook.
properties.runbook		RunbookAssociationProperty	Ottiene o imposta il runbook.
properties.uri		string	Ottiene o imposta l'URI.

Risposte

Nome	Tipo	Descrizione
200 OK	Webhook	Va bene
201 Created	Webhook	Creato
Other Status Codes	ErrorResponse	Risposta di errore di automazione che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create or update webhook

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorResponse	Risposta di errore di un errore dell'operazione
RunbookAssociationProperty	Proprietà del runbook associata all'entità.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
Webhook	Definizione del tipo di webhook.
WebhookCreateOrUpdateParameters	Parametri forniti all'operazione di creazione o aggiornamento del webhook.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Risposta di errore di un errore dell'operazione

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

RunbookAssociationProperty

Object

Proprietà del runbook associata all'entità.

Nome	Tipo	Descrizione
name	string	Ottiene o imposta il nome del runbook.

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Webhook

Object

Definizione del tipo di webhook.

Nome	Tipo	Valore predefinito	Descrizione
id	string (arm-id)		ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Nome della risorsa
properties.creationTime	string (date-time)		Ottiene o imposta l'ora di creazione.
properties.description	string		Ottiene o imposta la descrizione.
properties.expiryTime	string (date-time)		Ottiene o imposta l'ora di scadenza.
properties.isEnabled	boolean	False	Ottiene o imposta il valore del flag abilitato del webhook.
properties.lastInvokedTime	string (date-time)		Ottiene o imposta l'ora dell'ultima chiamata.
properties.lastModifiedBy	string		Dettagli dell'utente che ha modificato l'ultimo webhook
properties.lastModifiedTime	string (date-time)		Ottiene o imposta l'ora dell'ultima modifica.
properties.parameters	object		Ottiene o imposta i parametri del processo creato quando il webhook chiama il runbook a cui è associato.
properties.runOn	string		Ottiene o imposta il nome del gruppo di lavoro ibrido in cui verrà eseguito il processo webhook.
properties.runbook	RunbookAssociationProperty		Ottiene o imposta il runbook a cui è associato il webhook.
properties.uri	string		Ottiene o imposta l'URI del webhook.
systemData	systemData		Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string		Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WebhookCreateOrUpdateParameters

Object

Parametri forniti all'operazione di creazione o aggiornamento del webhook.

Nome	Tipo	Descrizione
name	string	Ottiene o imposta il nome del webhook.
properties.expiryTime	string (date-time)	Ottiene o imposta l'ora di scadenza.
properties.isEnabled	boolean	Ottiene o imposta il valore del flag abilitato del webhook.
properties.parameters	object	Ottiene o imposta i parametri del processo.
properties.runOn	string	Ottiene o imposta il nome del gruppo di lavoro ibrido in cui verrà eseguito il processo webhook.
properties.runbook	RunbookAssociationProperty	Ottiene o imposta il runbook.
properties.uri	string	Ottiene o imposta l'URI.