Webhook - Create Or Update

Reference

Služba:: Automation

Verze rozhraní API:: 2015-10-31

Vytvořte webhook označený názvem webhooku.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
automationAccountName	path	True	string	Název účtu Automation.
resourceGroupName	path	True	string	Název skupiny prostředků Azure Vzor regulárního výrazu: `^[-\w\._]+$`
subscriptionId	path	True	string	Získá přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
webhookName	path	True	string	Název webhooku.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Vyžadováno	Typ	Description
name	True	string	Získá nebo nastaví název webhooku.
properties.expiryTime		string	Získá nebo nastaví čas vypršení platnosti.
properties.isEnabled		boolean	Získá nebo nastaví hodnotu povoleného příznaku webhooku.
properties.parameters		object	Získá nebo nastaví parametry úlohy.
properties.runOn		string	Získá nebo nastaví název skupiny hybrid worker, ve které bude úloha webhooku spuštěna.
properties.runbook		RunbookAssociationProperty	Získá nebo nastaví runbook.
properties.uri		string	Získá nebo nastaví identifikátor URI.

Odpovědi

Name	Typ	Description
200 OK	Webhook	OK
201 Created	Webhook	Vytvořeno
Other Status Codes	ErrorResponse	Odpověď na chybu automatizace popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Create or update webhook

Ukázkový požadavek

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();
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.automation import AutomationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-automation
# USAGE
    python create_or_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.create_or_update(
        resource_group_name="rg",
        automation_account_name="myAutomationAccount33",
        webhook_name="TestWebhook",
        parameters={
            "name": "TestWebhook",
            "properties": {
                "expiryTime": "2018-03-29T22:18:13.7002872Z",
                "isEnabled": True,
                "runbook": {"name": "TestRunbook"},
                "uri": "<uri>",
            },
        },
    )
    print(response)


# x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateWebhook.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

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/blob/432872fac1d0f8edcae98a0e8504afc0ee302710/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()
	clientFactory, err := armautomation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebhookClient().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.700Z"); 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)
	}
	// 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"),
	// 	Type: to.Ptr("Microsoft.Automation/AutomationAccounts/Webhooks"),
	// 	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-29T22:18:14.665Z"); return t}()),
	// 		ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-29T22:18:13.700Z"); return t}()),
	// 		IsEnabled: to.Ptr(true),
	// 		LastModifiedBy: to.Ptr(""),
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-29T22:18:14.665Z"); 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

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

/**
 * This sample demonstrates how to Create the webhook identified by webhook name.
 *
 * @summary Create the webhook identified by webhook name.
 * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateWebhook.json
 */
async function createOrUpdateWebhook() {
  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",
    expiryTime: new Date("2018-03-29T22:18:13.7002872Z"),
    isEnabled: true,
    runbook: { name: "TestRunbook" },
    uri: "<uri>",
  };
  const credential = new DefaultAzureCredential();
  const client = new AutomationClient(credential, subscriptionId);
  const result = await client.webhookOperations.createOrUpdate(
    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

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/createOrUpdateWebhook.json
// this example is just showing the usage of "Webhook_CreateOrUpdate" 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 AutomationAccountResource created on azure
// for more information of creating AutomationAccountResource, please refer to the document of AutomationAccountResource
string subscriptionId = "subid";
string resourceGroupName = "rg";
string automationAccountName = "myAutomationAccount33";
ResourceIdentifier automationAccountResourceId = AutomationAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, automationAccountName);
AutomationAccountResource automationAccount = client.GetAutomationAccountResource(automationAccountResourceId);

// get the collection of this AutomationWebhookResource
AutomationWebhookCollection collection = automationAccount.GetAutomationWebhooks();

// invoke the operation
string webhookName = "TestWebhook";
AutomationWebhookCreateOrUpdateContent content = new AutomationWebhookCreateOrUpdateContent("TestWebhook")
{
    IsEnabled = true,
    Uri = new Uri("<uri>"),
    ExpireOn = DateTimeOffset.Parse("2018-03-29T22:18:13.7002872Z"),
    RunbookName = "TestRunbook",
};
ArmOperation<AutomationWebhookResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, webhookName, content);
AutomationWebhookResource result = lro.Value;

// 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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 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"
  }
}

Definice

Name	Description
ErrorResponse	Chybová odpověď při selhání operace
RunbookAssociationProperty	Vlastnost runbooku přidružená k entitě.
Webhook	Definice typu webhooku
WebhookCreateOrUpdateParameters	Parametry zadané pro operaci vytvoření nebo aktualizace webhooku.

ErrorResponse

Chybová odpověď při selhání operace

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

RunbookAssociationProperty

Vlastnost runbooku přidružená k entitě.

Name	Typ	Description
name	string	Získá nebo nastaví název runbooku.

Webhook

Definice typu webhooku

Name	Typ	Default value	Description
id	string		Plně kvalifikované ID prostředku pro prostředek
name	string		Název prostředku
properties.creationTime	string		Získá nebo nastaví čas vytvoření.
properties.description	string		Získá nebo nastaví popis.
properties.expiryTime	string		Získá nebo nastaví čas vypršení platnosti.
properties.isEnabled	boolean	False	Získá nebo nastaví hodnotu povoleného příznaku webhooku.
properties.lastInvokedTime	string		Získá nebo nastaví čas posledního vyvolání.
properties.lastModifiedBy	string		Podrobnosti o uživateli, který webhook naposledy upravil
properties.lastModifiedTime	string		Získá nebo nastaví čas poslední změny.
properties.parameters	object		Získá nebo nastaví parametry úlohy, která se vytvoří, když webhook volá runbook, ke kterému je přidružen.
properties.runOn	string		Získá nebo nastaví název skupiny hybrid worker, ve které bude úloha webhooku spuštěna.
properties.runbook	RunbookAssociationProperty		Získá nebo nastaví runbook, ke kterým je webhook přidružený.
properties.uri	string		Získá nebo nastaví identifikátor URI webhooku.
type	string		Typ prostředku.

WebhookCreateOrUpdateParameters

Parametry zadané pro operaci vytvoření nebo aktualizace webhooku.

Name	Typ	Description
name	string	Získá nebo nastaví název webhooku.
properties.expiryTime	string	Získá nebo nastaví čas vypršení platnosti.
properties.isEnabled	boolean	Získá nebo nastaví hodnotu povoleného příznaku webhooku.
properties.parameters	object	Získá nebo nastaví parametry úlohy.
properties.runOn	string	Získá nebo nastaví název skupiny hybrid worker, ve které bude úloha webhooku spuštěna.
properties.runbook	RunbookAssociationProperty	Získá nebo nastaví runbook.
properties.uri	string	Získá nebo nastaví identifikátor URI.