Webhook - Create Or Update

Szolgáltatás:

Automation

API-verzió:

2024-10-23

Hozza létre a webhook nevével azonosított webhookot.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
automationAccountName	path	True	string	Az automation-fiók neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Egy Azure-erőforráscsoport neve.
subscriptionId	path	True	string	Lekéri az előfizetés hitelesítő adatait, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
webhookName	path	True	string	A webhook neve.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
name	True	string	Lekéri vagy beállítja a webhook nevét.
properties.expiryTime		string (date-time)	Lekéri vagy beállítja a lejárati időt.
properties.isEnabled		boolean	Lekéri vagy beállítja a webhook engedélyezett jelölőjének értékét.
properties.parameters		object	Lekéri vagy beállítja a feladat paramétereit.
properties.runOn		string	Lekéri vagy beállítja annak a hibrid feldolgozócsoportnak a nevét, amelyen a webhook-feladat futni fog.
properties.runbook		RunbookAssociationProperty	Lekéri vagy beállítja a runbookot.
properties.uri		string	Lekéri vagy beállítja az uri-t.

Válaszok

Name	Típus	Description
200 OK	Webhook	OKÉ
201 Created	Webhook	Létrehozott
Other Status Codes	ErrorResponse	Automatizálási hibaválasz, amely leírja, hogy miért hiúsult meg a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Create or update webhook

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Állapotkód:

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

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorResponse	Művelethiba hibaválasza
RunbookAssociationProperty	Az entitáshoz társított runbook tulajdonság.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Webhook	A webhook típusának meghatározása.
WebhookCreateOrUpdateParameters	A webhook létrehozása vagy frissítése művelethez megadott paraméterek.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Objektum

Művelethiba hibaválasza

Name	Típus	Description
code	string	Hibakód
message	string	A művelet sikertelen voltát jelző hibaüzenet.

RunbookAssociationProperty

Objektum

Az entitáshoz társított runbook tulajdonság.

Name	Típus	Description
name	string	Lekéri vagy beállítja a runbook nevét.

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Webhook

Objektum

A webhook típusának meghatározása.

Name	Típus	Alapértelmezett érték	Description
id	string (arm-id)		Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Az erőforrás neve
properties.creationTime	string (date-time)		Lekéri vagy beállítja a létrehozási időt.
properties.description	string		Lekéri vagy beállítja a leírást.
properties.expiryTime	string (date-time)		Lekéri vagy beállítja a lejárati időt.
properties.isEnabled	boolean	False	Lekéri vagy beállítja a webhook engedélyezett jelölőjének értékét.
properties.lastInvokedTime	string (date-time)		Lekéri vagy beállítja az utolsó meghívott időpontot.
properties.lastModifiedBy	string		A webhookot legutóbb módosító felhasználó adatai
properties.lastModifiedTime	string (date-time)		Lekéri vagy beállítja az utolsó módosítás időpontját.
properties.parameters	object		Lekéri vagy beállítja annak a feladatnak a paramétereit, amelyek akkor jönnek létre, amikor a webhook meghívja a társított runbookot.
properties.runOn	string		Lekéri vagy beállítja annak a hibrid feldolgozócsoportnak a nevét, amelyen a webhook-feladat futni fog.
properties.runbook	RunbookAssociationProperty		Lekéri vagy beállítja azt a runbookot, amelyhez a webhook társítva van.
properties.uri	string		Lekéri vagy beállítja a webhook uri-t.
systemData	systemData		A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string		Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

WebhookCreateOrUpdateParameters

Objektum

A webhook létrehozása vagy frissítése művelethez megadott paraméterek.

Name	Típus	Description
name	string	Lekéri vagy beállítja a webhook nevét.
properties.expiryTime	string (date-time)	Lekéri vagy beállítja a lejárati időt.
properties.isEnabled	boolean	Lekéri vagy beállítja a webhook engedélyezett jelölőjének értékét.
properties.parameters	object	Lekéri vagy beállítja a feladat paramétereit.
properties.runOn	string	Lekéri vagy beállítja annak a hibrid feldolgozócsoportnak a nevét, amelyen a webhook-feladat futni fog.
properties.runbook	RunbookAssociationProperty	Lekéri vagy beállítja a runbookot.
properties.uri	string	Lekéri vagy beállítja az uri-t.