Webhook - Update

Szolgáltatás:

Automation

API-verzió:

2015-10-31

Frissítse a webhook neve által azonosított webhookot.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
automationAccountName	path	True	string	Az Automation-fiók neve.
resourceGroupName	path	True	string	Egy Azure-erőforráscsoport neve. Reguláris kifejezési minta: ^[-\w\._]+$
subscriptionId	path	True	string	Lekéri az előfizetés hitelesítő adatait, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
webhookName	path	True	string	A webhook neve.
api-version	query	True	string	Client API-verzió.

Kérelem törzse

Name	Típus	Description
name	string	Lekéri vagy beállítja a webhook nevét.
properties.description	string	Lekéri vagy beállítja a webhook leírását.
properties.isEnabled	boolean	Lekéri vagy beállítja a webhook engedélyezett jelzőjének értékét.
properties.parameters	object	Lekéri vagy beállítja a feladat paramétereit.
properties.runOn	string	Lekéri vagy beállítja annak a hibrid feldolgozócsoportnak a nevét, amelyen a webhook-feladat futni fog.

Válaszok

Name	Típus	Description
200 OK	Webhook	OK
Other Status Codes	ErrorResponse	Automatizálási hibaválasz, amely leírja, hogy miért hiúsult meg a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Update webhook

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
ErrorResponse	Művelethiba hibaválasza
RunbookAssociationProperty	Az entitáshoz társított runbook-tulajdonság.
Webhook	A webhook típusának meghatározása.
WebhookUpdateParameters	A frissítési webhook művelethez megadott paraméterek.

ErrorResponse

Művelethiba hibaválasza

Name	Típus	Description
code	string	Hibakód
message	string	Hibaüzenet, amely jelzi, hogy a művelet miért hiúsult meg.

RunbookAssociationProperty

Az entitáshoz társított runbook-tulajdonság.

Name	Típus	Description
name	string	Lekéri vagy beállítja a runbook nevét.

Webhook

A webhook típusának meghatározása.

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás teljes erőforrás-azonosítója
name	string		Az erőforrás neve
properties.creationTime	string		Lekéri vagy beállítja a létrehozási időt.
properties.description	string		Lekéri vagy beállítja a leírást.
properties.expiryTime	string		Lekéri vagy beállítja a lejárati időt.
properties.isEnabled	boolean	False	Lekéri vagy beállítja a webhook engedélyezett jelzőjének értékét.
properties.lastInvokedTime	string		Lekéri vagy beállítja az utolsó meghívott időpontot.
properties.lastModifiedBy	string		A webhookot utoljára módosító felhasználó adatai
properties.lastModifiedTime	string		Lekéri vagy beállítja az utolsó módosítás időpontját.
properties.parameters	object		Lekéri vagy beállítja annak a feladatnak a paramétereit, amelyek akkor jönnek létre, amikor a webhook meghívja azt a runbookot, amelyhez társítva van.
properties.runOn	string		Lekéri vagy beállítja annak a hibrid feldolgozócsoportnak a nevét, amelyen a webhook-feladat futni fog.
properties.runbook	RunbookAssociationProperty		Lekéri vagy beállítja azt a runbookot, amelyhez a webhook társítva van.
properties.uri	string		Lekéri vagy beállítja a webhook URI-ját.
type	string		Az erőforrás típusa.

WebhookUpdateParameters

A frissítési webhook művelethez megadott paraméterek.

Name	Típus	Description
name	string	Lekéri vagy beállítja a webhook nevét.
properties.description	string	Lekéri vagy beállítja a webhook leírását.
properties.isEnabled	boolean	Lekéri vagy beállítja a webhook engedélyezett jelzőjének értékét.
properties.parameters	object	Lekéri vagy beállítja a feladat paramétereit.
properties.runOn	string	Lekéri vagy beállítja annak a hibrid feldolgozócsoportnak a nevét, amelyen a webhook-feladat futni fog.