Webhook - Update

Služba:

Automation

Verze rozhraní API:

2024-10-23

Aktualizujte webhook identifikovaný názvem webhooku.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
automationAccountName	path	True	string	Název účtu Automation.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Název skupiny prostředků Azure
subscriptionId	path	True	string	Získá přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
webhookName	path	True	string	Název webhooku.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
name	string	Získá nebo nastaví název webhooku.
properties.description	string	Získá nebo nastaví popis webhooku.
properties.isEnabled	boolean	Získá nebo nastaví hodnotu povoleného příznaku webhooku.
properties.parameters	object	Získá nebo nastaví parametry úlohy.
properties.runOn	string	Získá nebo nastaví název skupiny Hybrid Worker, ve které bude úloha webhooku spuštěna.

Odpovědi

Name	Typ	Description
200 OK	Webhook	OK
Other Status Codes	ErrorResponse	Odpověď na chybu automatizace popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Update webhook

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook?api-version=2024-10-23

{
  "name": "TestWebhook",
  "properties": {
    "isEnabled": false,
    "description": "updated webhook"
  }
}

Ukázková odpověď

Stavový kód:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
  "name": "TestWebhook",
  "properties": {
    "isEnabled": false,
    "expiryTime": "2018-03-30T23:03:14.5752078+00:00",
    "runbook": {
      "name": "TestRunbook"
    },
    "lastInvokedTime": null,
    "runOn": null,
    "parameters": null,
    "uri": "",
    "creationTime": "2017-03-30T21:52:01.272378+00:00",
    "lastModifiedBy": "",
    "lastModifiedTime": "2017-03-30T23:03:14.9069441+00:00"
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorResponse	Chybová odpověď selhání operace
RunbookAssociationProperty	Vlastnost runbooku přidružená k entitě.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
Webhook	Definice typu webhooku
WebhookUpdateParameters	Parametry zadané operaci aktualizačního webhooku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Chybová odpověď selhání operace

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

RunbookAssociationProperty

Objekt

Vlastnost runbooku přidružená k entitě.

Name	Typ	Description
name	string	Získá nebo nastaví název runbooku.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Webhook

Objekt

Definice typu webhooku

Name	Typ	Default value	Description
id	string (arm-id)		Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Název prostředku
properties.creationTime	string (date-time)		Získá nebo nastaví čas vytvoření.
properties.description	string		Získá nebo nastaví popis.
properties.expiryTime	string (date-time)		Získá nebo nastaví dobu vypršení platnosti.
properties.isEnabled	boolean	False	Získá nebo nastaví hodnotu povoleného příznaku webhooku.
properties.lastInvokedTime	string (date-time)		Získá nebo nastaví čas poslední vyvolání.
properties.lastModifiedBy	string		Podrobnosti o uživateli, který webhook naposledy upravil
properties.lastModifiedTime	string (date-time)		Získá nebo nastaví čas poslední změny.
properties.parameters	object		Získá nebo nastaví parametry úlohy, která se vytvoří při volání webhooku runbook, ke kterému je přidružen.
properties.runOn	string		Získá nebo nastaví název skupiny Hybrid Worker, ve které bude úloha webhooku spuštěna.
properties.runbook	RunbookAssociationProperty		Získá nebo nastaví runbook, ke které je webhook přidružený.
properties.uri	string		Získá nebo nastaví identifikátor URI webhooku.
systemData	systemData		Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string		Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

WebhookUpdateParameters

Objekt

Parametry zadané operaci aktualizačního webhooku.

Name	Typ	Description
name	string	Získá nebo nastaví název webhooku.
properties.description	string	Získá nebo nastaví popis webhooku.
properties.isEnabled	boolean	Získá nebo nastaví hodnotu povoleného příznaku webhooku.
properties.parameters	object	Získá nebo nastaví parametry úlohy.
properties.runOn	string	Získá nebo nastaví název skupiny Hybrid Worker, ve které bude úloha webhooku spuštěna.