Webhook - Update

Référence

Service:: Automation

API Version:: 2015-10-31

Mettez à jour le webhook identifié par son nom.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
automationAccountName	path	True	string	Nom du compte Automation.
resourceGroupName	path	True	string	Nom d’un groupe de ressources Azure. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Obtient les informations d'identification d'abonnement qui identifient l'abonnement Microsoft Azure de manière unique. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
webhookName	path	True	string	Nom du webhook.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
name	string	Obtient ou définit le nom du webhook.
properties.description	string	Obtient ou définit la description du webhook.
properties.isEnabled	boolean	Obtient ou définit la valeur de l’indicateur activé du webhook.
properties.parameters	object	Obtient ou définit les paramètres du travail.
properties.runOn	string	Obtient ou définit le nom du groupe de workers hybride sur lequel le travail de webhook s’exécutera.

Réponses

Nom	Type	Description
200 OK	Webhook	Ok
Other Status Codes	ErrorResponse	Réponse d’erreur Automation décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Update webhook

Sample Request

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

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

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

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

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

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

Sample Response

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

Définitions

Nom	Description
ErrorResponse	Réponse d’erreur d’un échec d’opération
RunbookAssociationProperty	Propriété de runbook associée à l’entité.
Webhook	Définition du type de webhook.
WebhookUpdateParameters	Paramètres fournis à l’opération de mise à jour du webhook.

ErrorResponse

Réponse d’erreur d’un échec d’opération

Nom	Type	Description
code	string	Code d'erreur
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

RunbookAssociationProperty

Propriété de runbook associée à l’entité.

Nom	Type	Description
name	string	Obtient ou définit le nom du runbook.

Webhook

Définition du type de webhook.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource complet pour la ressource
name	string		nom de la ressource.
properties.creationTime	string		Obtient ou définit l’heure de création.
properties.description	string		Obtient ou définit la description.
properties.expiryTime	string		Obtient ou définit l’heure d’expiration.
properties.isEnabled	boolean	False	Obtient ou définit la valeur de l’indicateur activé du webhook.
properties.lastInvokedTime	string		Obtient ou définit l’heure du dernier appel.
properties.lastModifiedBy	string		Détails de l’utilisateur qui a modifié le webhook pour la dernière fois
properties.lastModifiedTime	string		Obtient ou définit l’heure de la dernière modification.
properties.parameters	object		Obtient ou définit les paramètres du travail créé lorsque le webhook appelle le runbook auquel il est associé.
properties.runOn	string		Obtient ou définit le nom du groupe de workers hybride sur lequel le travail de webhook s’exécutera.
properties.runbook	RunbookAssociationProperty		Obtient ou définit le runbook à lequel le webhook est associé.
properties.uri	string		Obtient ou définit l’URI du webhook.
type	string		Type de la ressource.

WebhookUpdateParameters

Paramètres fournis à l’opération de mise à jour du webhook.

Nom	Type	Description
name	string	Obtient ou définit le nom du webhook.
properties.description	string	Obtient ou définit la description du webhook.
properties.isEnabled	boolean	Obtient ou définit la valeur de l’indicateur activé du webhook.
properties.parameters	object	Obtient ou définit les paramètres du travail.
properties.runOn	string	Obtient ou définit le nom du groupe de workers hybride sur lequel le travail de webhook s’exécutera.