Condividi tramite

Webhook - Get

Servizio:
Automation
Versione API:
2024-10-23

Recuperare il webhook identificato dal nome del webhook.

GET 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

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId
 path True

string (uuid)

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
webhookName
 path True

string

Nome del webhook.
api-version
 query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

Webhook

L'operazione di Azure è stata completata correttamente.
Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

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

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Get webhook

Esempio di richiesta

GET https://management.azure.com/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook?api-version=2024-10-23

Risposta di esempio

Codice di stato:
200 
{
  "name": "TestWebhook",
  "id": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
  "properties": {
    "creationTime": "2017-03-29T22:18:14.6651862+00:00",
    "expiryTime": "2018-03-29T22:18:13.7002872+00:00",
    "isEnabled": true,
    "lastInvokedTime": null,
    "lastModifiedBy": "",
    "lastModifiedTime": "2017-03-29T22:18:14.6651862+00:00",
    "parameters": null,
    "runOn": null,
    "runbook": {
      "name": "TestRunbook"
    },
    "uri": ""
  }
}

Definizioni

Nome Descrizione
createdByType

Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
RunbookAssociationProperty

Proprietà del runbook associata all'entità.
systemData

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

Definizione del tipo di webhook.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

RunbookAssociationProperty

Oggetto

Proprietà del runbook associata all'entità.

Nome Tipo Descrizione
name

string

Ottiene o imposta il nome del runbook.

systemData

Oggetto

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

Oggetto

Definizione del tipo di webhook.

Nome Tipo 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

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"