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

リソース グループの名前。 名前の大文字と小文字は区別されません。
subscriptionId
 path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
webhookName
 path True

string

Webhook 名。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

要求本文

名前 型 説明
name

string

Webhook の名前を取得または設定します。
properties.description

string

Webhook の説明を取得または設定します。
properties.isEnabled

boolean

webhook の有効なフラグの値を取得または設定します。
properties.parameters

object

ジョブのパラメーターを取得または設定します。
properties.runOn

string

Webhook ジョブが実行されるハイブリッド worker グループの名前を取得または設定します。

応答

名前 型 説明
200 OK

Webhook

Azureの運用は無事に完了しました。
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

要求のサンプル

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

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

応答のサンプル

状態コード:
200 
{
  "name": "TestWebhook",
  "id": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
  "properties": {
    "creationTime": "2017-03-30T21:52:01.272378+00:00",
    "expiryTime": "2018-03-30T23:03:14.5752078+00:00",
    "isEnabled": false,
    "lastInvokedTime": null,
    "lastModifiedBy": "",
    "lastModifiedTime": "2017-03-30T23:03:14.9069441+00:00",
    "parameters": null,
    "runOn": null,
    "runbook": {
      "name": "TestRunbook"
    },
    "uri": ""
  }
}

定義

名前 説明
createdByType

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

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
RunbookAssociationProperty

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

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

webhook 型の定義。
WebhookUpdateParameters

Webhook の更新操作に指定されたパラメーター。

createdByType

列挙

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

値 説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

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

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 グループの名前を取得または設定します。