Webhook - Update

서비스:

Automation

API 버전:

2015-10-31

웹후크 이름으로 식별된 웹후크를 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
automationAccountName	path	True	string	자동화 계정의 이름입니다.
resourceGroupName	path	True	string	Azure 리소스 그룹의 이름입니다. regex 패턴: ^[-\w\._]+$
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명을 가져옵니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
webhookName	path	True	string	웹후크 이름입니다.
api-version	query	True	string	클라이언트 API 버전.

요청 본문

Name	형식	Description
name	string	웹후크의 이름을 가져오거나 설정합니다.
properties.description	string	웹후크에 대한 설명을 가져오거나 설정합니다.
properties.isEnabled	boolean	웹후크의 사용 플래그 값을 가져오거나 설정합니다.
properties.parameters	object	작업의 매개 변수를 가져오거나 설정합니다.
properties.runOn	string	웹후크 작업이 실행될 하이브리드 작업자 그룹의 이름을 가져오거나 설정합니다.

응답

Name	형식	Description
200 OK	Webhook	정상
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 자동화 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Update webhook

샘플 요청

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.automation.models.Webhook;

/** Samples for Webhook Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateWebhook.json
     */
    /**
     * Sample code: Update webhook.
     *
     * @param manager Entry point to AutomationManager.
     */
    public static void updateWebhook(com.azure.resourcemanager.automation.AutomationManager manager) {
        Webhook resource =
            manager.webhooks().getWithResponse("rg", "myAutomationAccount33", "TestWebhook", Context.NONE).getValue();
        resource.update().withName("TestWebhook").withIsEnabled(false).withDescription("updated webhook").apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.automation import AutomationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-automation
# USAGE
    python update_webhook.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AutomationClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.webhook.update(
        resource_group_name="rg",
        automation_account_name="myAutomationAccount33",
        webhook_name="TestWebhook",
        parameters={"name": "TestWebhook", "properties": {"description": "updated webhook", "isEnabled": False}},
    )
    print(response)


# x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateWebhook.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armautomation_test

import (
	"context"
	"log"

	"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/blob/432872fac1d0f8edcae98a0e8504afc0ee302710/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateWebhook.json
func ExampleWebhookClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armautomation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebhookClient().Update(ctx, "rg", "myAutomationAccount33", "TestWebhook", armautomation.WebhookUpdateParameters{
		Name: to.Ptr("TestWebhook"),
		Properties: &armautomation.WebhookUpdateProperties{
			Description: to.Ptr("updated webhook"),
			IsEnabled:   to.Ptr(false),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Webhook = armautomation.Webhook{
	// 	Name: to.Ptr("TestWebhook"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook"),
	// 	Properties: &armautomation.WebhookProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-30T21:52:01.272Z"); return t}()),
	// 		ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-30T23:03:14.575Z"); return t}()),
	// 		IsEnabled: to.Ptr(false),
	// 		LastModifiedBy: to.Ptr(""),
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-30T23:03:14.906Z"); return t}()),
	// 		Runbook: &armautomation.RunbookAssociationProperty{
	// 			Name: to.Ptr("TestRunbook"),
	// 		},
	// 		URI: to.Ptr(""),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Update the webhook identified by webhook name.
 *
 * @summary Update the webhook identified by webhook name.
 * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateWebhook.json
 */
async function updateWebhook() {
  const subscriptionId = process.env["AUTOMATION_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["AUTOMATION_RESOURCE_GROUP"] || "rg";
  const automationAccountName = "myAutomationAccount33";
  const webhookName = "TestWebhook";
  const parameters = {
    name: "TestWebhook",
    description: "updated webhook",
    isEnabled: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new AutomationClient(credential, subscriptionId);
  const result = await client.webhookOperations.update(
    resourceGroupName,
    automationAccountName,
    webhookName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Automation;
using Azure.ResourceManager.Automation.Models;

// Generated from example definition: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateWebhook.json
// this example is just showing the usage of "Webhook_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AutomationWebhookResource created on azure
// for more information of creating AutomationWebhookResource, please refer to the document of AutomationWebhookResource
string subscriptionId = "subid";
string resourceGroupName = "rg";
string automationAccountName = "myAutomationAccount33";
string webhookName = "TestWebhook";
ResourceIdentifier automationWebhookResourceId = AutomationWebhookResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, automationAccountName, webhookName);
AutomationWebhookResource automationWebhook = client.GetAutomationWebhookResource(automationWebhookResourceId);

// invoke the operation
AutomationWebhookPatch patch = new AutomationWebhookPatch()
{
    Name = "TestWebhook",
    IsEnabled = false,
    Description = "updated webhook",
};
AutomationWebhookResource result = await automationWebhook.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AutomationWebhookData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

샘플 응답

상태 코드:

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

정의

Name	Description
ErrorResponse	작업 실패에 대한 오류 응답
RunbookAssociationProperty	엔터티와 연결된 Runbook 속성입니다.
Webhook	웹후크 형식의 정의입니다.
WebhookUpdateParameters	업데이트 웹후크 작업에 제공된 매개 변수입니다.

ErrorResponse

작업 실패에 대한 오류 응답

Name	형식	Description
code	string	오류 코드
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

RunbookAssociationProperty

엔터티와 연결된 Runbook 속성입니다.

Name	형식	Description
name	string	Runbook의 이름을 가져오거나 설정합니다.

Webhook

웹후크 형식의 정의입니다.

Name	형식	Default value	Description
id	string		리소스에 대한 정규화된 리소스 ID
name	string		리소스의 이름입니다.
properties.creationTime	string		생성 시간을 가져오거나 설정합니다.
properties.description	string		설명을 가져오거나 설정합니다.
properties.expiryTime	string		만료 시간을 가져오거나 설정합니다.
properties.isEnabled	boolean	False	웹후크의 사용 플래그 값을 가져오거나 설정합니다.
properties.lastInvokedTime	string		마지막으로 호출된 시간을 가져오거나 설정합니다.
properties.lastModifiedBy	string		Webhook를 마지막으로 수정한 사용자의 세부 정보
properties.lastModifiedTime	string		마지막으로 수정한 시간을 가져오거나 설정합니다.
properties.parameters	object		웹후크가 연결된 Runbook을 호출할 때 생성되는 작업의 매개 변수를 가져오거나 설정합니다.
properties.runOn	string		웹후크 작업이 실행될 하이브리드 작업자 그룹의 이름을 가져오거나 설정합니다.
properties.runbook	RunbookAssociationProperty		웹후크가 연결된 Runbook을 가져오거나 설정합니다.
properties.uri	string		웹후크 URI를 가져오거나 설정합니다.
type	string		리소스 형식입니다.

WebhookUpdateParameters

업데이트 웹후크 작업에 제공된 매개 변수입니다.

Name	형식	Description
name	string	웹후크의 이름을 가져오거나 설정합니다.
properties.description	string	웹후크에 대한 설명을 가져오거나 설정합니다.
properties.isEnabled	boolean	웹후크의 사용 플래그 값을 가져오거나 설정합니다.
properties.parameters	object	작업의 매개 변수를 가져오거나 설정합니다.
properties.runOn	string	웹후크 작업이 실행될 하이브리드 작업자 그룹의 이름을 가져오거나 설정합니다.