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 パラメーター

名前	/	必須	型	説明
automationAccountName	path	True	string	Automation アカウントの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Azure リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
webhookName	path	True	string	Webhook 名。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	型	説明
name	string	Webhook の名前を取得または設定します。
properties.description	string	Webhook の説明を取得または設定します。
properties.isEnabled	boolean	webhook の有効なフラグの値を取得または設定します。
properties.parameters	object	ジョブのパラメーターを取得または設定します。
properties.runOn	string	Webhook ジョブが実行されるハイブリッド worker グループの名前を取得または設定します。

応答

名前	型	説明
200 OK	Webhook	[OK]
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するオートメーションエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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"
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorResponse	操作エラーのエラー応答
RunbookAssociationProperty	エンティティに関連付けられている Runbook プロパティ。
systemData	リソースの作成と最後の変更に関連するメタデータ。
Webhook	webhook 型の定義。
WebhookUpdateParameters	Webhook の更新操作に指定されたパラメーター。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

ErrorResponse

Object

操作エラーのエラー応答

名前	型	説明
code	string	エラーコード
message	string	操作が失敗した理由を示すエラーメッセージ。

RunbookAssociationProperty

Object

エンティティに関連付けられている Runbook プロパティ。

名前	型	説明
name	string	Runbook の名前を取得または設定します。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Webhook

Object

webhook 型の定義。

名前	型	規定値	説明
id	string (arm-id)		リソースの完全修飾リソース 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 ジョブが実行されるハイブリッド worker グループの名前を取得または設定します。
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 の更新操作に指定されたパラメーター。

名前	型	説明
name	string	Webhook の名前を取得または設定します。
properties.description	string	Webhook の説明を取得または設定します。
properties.isEnabled	boolean	webhook の有効なフラグの値を取得または設定します。
properties.parameters	object	ジョブのパラメーターを取得または設定します。
properties.runOn	string	Webhook ジョブが実行されるハイブリッド worker グループの名前を取得または設定します。

次の方法で共有

Webhook - Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Update webhook

要求のサンプル

応答のサンプル

定義

createdByType

ErrorResponse

RunbookAssociationProperty

systemData

Webhook

WebhookUpdateParameters