Webhook - Update

服務:: Automation

API 版本:: 2024-10-23

更新 Webhook 名稱所識別的 Webhook。

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

URI 參數

名稱	位於	必要	類型	Description
automationAccountName	path	True	string	自動化帳戶的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Azure 資源群組的名稱。
subscriptionId	path	True	string	取得可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
webhookName	path	True	string	Webhook 名稱。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	類型	Description
name	string	取得或設定 Webhook 的名稱。
properties.description	string	取得或設定 Webhook 的描述。
properties.isEnabled	boolean	取得或設定 Webhook 已啟用旗標的值。
properties.parameters	object	取得或設定作業的參數。
properties.runOn	string	取得或設定 Webhook 作業將執行之混合式背景工作群組的名稱。

回應

名稱	類型	Description
200 OK	Webhook	還行
Other Status Codes	ErrorResponse	描述作業失敗原因的自動化錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Update webhook

範例要求

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

範例回覆

狀態碼:: 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"
  }
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorResponse	作業失敗的錯誤回應
RunbookAssociationProperty	與實體相關聯的 Runbook 屬性。
systemData	與建立和上次修改資源相關的元數據。
Webhook	Webhook 類型的定義。
WebhookUpdateParameters	提供給更新 Webhook 作業的參數。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

作業失敗的錯誤回應

名稱	類型	Description
code	string	錯誤碼
message	string	錯誤訊息，指出作業失敗的原因。

RunbookAssociationProperty

Object

與實體相關聯的 Runbook 屬性。

名稱	類型	Description
name	string	取得或設定 Runbook 的名稱。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

Webhook

Object

Webhook 類型的定義。

名稱	類型	預設值	Description
id	string (arm-id)		資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string		資源的名稱
properties.creationTime	string (date-time)		取得或設定建立時間。
properties.description	string		取得或設定描述。
properties.expiryTime	string (date-time)		取得或設定到期時間。
properties.isEnabled	boolean	False	取得或設定 Webhook 已啟用旗標的值。
properties.lastInvokedTime	string (date-time)		取得或設定上次叫用的時間。
properties.lastModifiedBy	string		上次修改 Webhook 的使用者詳細數據
properties.lastModifiedTime	string (date-time)		取得或設定上次修改的時間。
properties.parameters	object		取得或設定 Webhook 呼叫與它相關聯之 Runbook 時所建立之作業的參數。
properties.runOn	string		取得或設定 Webhook 作業將執行之混合式背景工作群組的名稱。
properties.runbook	RunbookAssociationProperty		取得或設定 Webhook 相關聯的 Runbook。
properties.uri	string		取得或設定 Webhook URI。
systemData	systemData		包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string		資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

WebhookUpdateParameters

Object

提供給更新 Webhook 作業的參數。

名稱	類型	Description
name	string	取得或設定 Webhook 的名稱。
properties.description	string	取得或設定 Webhook 的描述。
properties.isEnabled	boolean	取得或設定 Webhook 已啟用旗標的值。
properties.parameters	object	取得或設定作業的參數。
properties.runOn	string	取得或設定 Webhook 作業將執行之混合式背景工作群組的名稱。

共用方式為

Webhook - Update

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

Update webhook

範例要求

範例回覆

定義

createdByType

ErrorResponse

RunbookAssociationProperty

systemData

Webhook

WebhookUpdateParameters