Webhook - Create Or Update

リファレンス

Service:: Automation

API Version:: 2015-10-31

webhook 名で識別される webhook を作成します。

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

URI パラメーター

Name	In	Required	Type	Description
automationAccountName	path	True	string	Automation アカウントの名前。
resourceGroupName	path	True	string	Azure リソースグループの名前。 Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
webhookName	path	True	string	Webhook 名。
api-version	query	True	string	クライアント API のバージョン。

要求本文

Name	Required	Type	Description
name	True	string	Webhook の名前を取得または設定します。
properties.expiryTime		string	有効期限を取得または設定します。
properties.isEnabled		boolean	Webhook の有効なフラグの値を取得または設定します。
properties.parameters		object	ジョブのパラメーターを取得または設定します。
properties.runOn		string	Webhook ジョブが実行されるハイブリッドワーカーグループの名前を取得または設定します。
properties.runbook		RunbookAssociationProperty	Runbook を取得または設定します。
properties.uri		string	URI を取得または設定します。

応答

Name	Type	Description
200 OK	Webhook	OK
201 Created	Webhook	作成済み
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するオートメーションエラー応答。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	ユーザーアカウントを偽装する

例

Create or update webhook

Sample Request

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

{
  "name": "TestWebhook",
  "properties": {
    "isEnabled": true,
    "uri": "<uri>",
    "expiryTime": "2018-03-29T22:18:13.7002872Z",
    "runbook": {
      "name": "TestRunbook"
    }
  }
}

import com.azure.resourcemanager.automation.models.RunbookAssociationProperty;
import java.time.OffsetDateTime;

/** Samples for Webhook CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateWebhook.json
     */
    /**
     * Sample code: Create or update webhook.
     *
     * @param manager Entry point to AutomationManager.
     */
    public static void createOrUpdateWebhook(com.azure.resourcemanager.automation.AutomationManager manager) {
        manager
            .webhooks()
            .define("TestWebhook")
            .withExistingAutomationAccount("rg", "myAutomationAccount33")
            .withName("TestWebhook")
            .withIsEnabled(true)
            .withUri("<uri>")
            .withExpiryTime(OffsetDateTime.parse("2018-03-29T22:18:13.7002872Z"))
            .withRunbook(new RunbookAssociationProperty().withName("TestRunbook"))
            .create();
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armautomation_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateWebhook.json
func ExampleWebhookClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armautomation.NewWebhookClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg",
		"myAutomationAccount33",
		"TestWebhook",
		armautomation.WebhookCreateOrUpdateParameters{
			Name: to.Ptr("TestWebhook"),
			Properties: &armautomation.WebhookCreateOrUpdateProperties{
				ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-29T22:18:13.7002872Z"); return t }()),
				IsEnabled:  to.Ptr(true),
				Runbook: &armautomation.RunbookAssociationProperty{
					Name: to.Ptr("TestRunbook"),
				},
				URI: to.Ptr("<uri>"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 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"
  }
}

Status code:: 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"
  }
}

定義

ErrorResponse	操作エラーのエラー応答
RunbookAssociationProperty	エンティティに関連付けられている Runbook プロパティ。
Webhook	Webhook 型の定義。
WebhookCreateOrUpdateParameters	Webhook の作成または更新操作に指定されたパラメーター。

ErrorResponse

操作エラーのエラー応答

Name	Type	Description
code	string	エラーコード
message	string	操作が失敗した理由を示すエラーメッセージ。

RunbookAssociationProperty

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

Name	Type	Description
name	string	Runbook の名前を取得または設定します。

Webhook

Webhook 型の定義。

Name	Type	Default Value	Description
id	string		リソースの完全修飾リソース ID
name	string		リソースの名前
properties.creationTime	string		作成時間を取得または設定します。
properties.description	string		説明を取得または設定します。
properties.expiryTime	string		有効期限を取得または設定します。
properties.isEnabled	boolean	False	Webhook の有効なフラグの値を取得または設定します。
properties.lastInvokedTime	string		最後に呼び出された時刻を取得または設定します。
properties.lastModifiedBy	string		Webhook を最後に変更したユーザーの詳細
properties.lastModifiedTime	string		最後に変更された時刻を取得または設定します。
properties.parameters	object		Webhook が関連付けられている Runbook を呼び出すときに作成されるジョブのパラメーターを取得または設定します。
properties.runOn	string		Webhook ジョブが実行されるハイブリッドワーカーグループの名前を取得または設定します。
properties.runbook	RunbookAssociationProperty		Webhook が関連付けられている Runbook を取得または設定します。
properties.uri	string		Webhook URI を取得または設定します。
type	string		リソースの型。

WebhookCreateOrUpdateParameters

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

Name	Type	Description
name	string	Webhook の名前を取得または設定します。
properties.expiryTime	string	有効期限を取得または設定します。
properties.isEnabled	boolean	Webhook の有効なフラグの値を取得または設定します。
properties.parameters	object	ジョブのパラメーターを取得または設定します。
properties.runOn	string	Webhook ジョブが実行されるハイブリッドワーカーグループの名前を取得または設定します。
properties.runbook	RunbookAssociationProperty	Runbook を取得または設定します。
properties.uri	string	URI を取得または設定します。