Webhook - List By Automation Account

Referencia

Service:: Automation

API Version:: 2015-10-31

Recuperar una lista de webhooks.

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
automationAccountName	path	True	string	Nombre de la cuenta de Automation.
resourceGroupName	path	True	string	Nombre de un grupo de recursos de Azure. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Obtiene las credenciales de suscripción que identifican a la suscripción de Microsoft Azure de forma única. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.
$filter	query		string	Filtro que se va a aplicar en la operación.

Respuestas

Nombre	Tipo	Description
200 OK	WebhookListResult	Aceptar
Other Status Codes	ErrorResponse	Respuesta de error de Automatización que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

List webhooks by Automation Account

Sample Request

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

import com.azure.core.util.Context;

/** Samples for Webhook ListByAutomationAccount. */
public final class Main {
    /*
     * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listWebhooksByAutomationAccount.json
     */
    /**
     * Sample code: List webhooks by Automation Account.
     *
     * @param manager Entry point to AutomationManager.
     */
    public static void listWebhooksByAutomationAccount(com.azure.resourcemanager.automation.AutomationManager manager) {
        manager.webhooks().listByAutomationAccount("rg", "myAutomationAccount33", null, Context.NONE);
    }
}

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 list_webhooks_by_automation_account.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.list_by_automation_account(
        resource_group_name="rg",
        automation_account_name="myAutomationAccount33",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listWebhooksByAutomationAccount.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/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/listWebhooksByAutomationAccount.json
func ExampleWebhookClient_NewListByAutomationAccountPager() {
	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)
	}
	pager := clientFactory.NewWebhookClient().NewListByAutomationAccountPager("rg", "myAutomationAccount33", &armautomation.WebhookClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.WebhookListResult = armautomation.WebhookListResult{
		// 	Value: []*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-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"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 Retrieve a list of webhooks.
 *
 * @summary Retrieve a list of webhooks.
 * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listWebhooksByAutomationAccount.json
 */
async function listWebhooksByAutomationAccount() {
  const subscriptionId = process.env["AUTOMATION_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["AUTOMATION_RESOURCE_GROUP"] || "rg";
  const automationAccountName = "myAutomationAccount33";
  const credential = new DefaultAzureCredential();
  const client = new AutomationClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.webhookOperations.listByAutomationAccount(
    resourceGroupName,
    automationAccountName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/listWebhooksByAutomationAccount.json
// this example is just showing the usage of "Webhook_ListByAutomationAccount" 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 and iterate over the result
await foreach (AutomationWebhookResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
      "name": "TestWebhook",
      "properties": {
        "isEnabled": true,
        "expiryTime": "2018-03-29T22:18:13.7002872+00:00",
        "runbook": {
          "name": "TestRunbook"
        },
        "lastInvokedTime": null,
        "runOn": null,
        "parameters": null,
        "uri": null,
        "creationTime": "2017-03-29T22:18:14.6651862+00:00",
        "lastModifiedBy": "",
        "lastModifiedTime": "2017-03-29T22:18:14.6651862+00:00"
      }
    }
  ]
}

Definiciones

Nombre	Description
ErrorResponse	Respuesta de error de un error de operación
RunbookAssociationProperty	Propiedad runbook asociada a la entidad.
Webhook	Definición del tipo de webhook.
WebhookListResult	Modelo de respuesta para la operación de webhook de lista.

ErrorResponse

Respuesta de error de un error de operación

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

RunbookAssociationProperty

Propiedad runbook asociada a la entidad.

Nombre	Tipo	Description
name	string	Obtiene o establece el nombre del runbook.

Webhook

Definición del tipo de webhook.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso completo para el recurso
name	string		Nombre del recurso.
properties.creationTime	string		Obtiene o establece la hora de creación.
properties.description	string		Obtiene o establece la descripción.
properties.expiryTime	string		Obtiene o establece la hora de expiración.
properties.isEnabled	boolean	False	Obtiene o establece el valor de la marca habilitada del webhook.
properties.lastInvokedTime	string		Obtiene o establece la última hora invocada.
properties.lastModifiedBy	string		Detalles del usuario que modificó por última vez el webhook
properties.lastModifiedTime	string		Obtiene o establece la hora de la última modificación.
properties.parameters	object		Obtiene o establece los parámetros del trabajo que se crea cuando el webhook llama al runbook al que está asociado.
properties.runOn	string		Obtiene o establece el nombre del grupo de Hybrid Worker en el que se ejecutará el trabajo de webhook.
properties.runbook	RunbookAssociationProperty		Obtiene o establece el runbook al que está asociado el webhook.
properties.uri	string		Obtiene o establece el URI del webhook.
type	string		Tipo de recurso.

WebhookListResult

Modelo de respuesta para la operación de webhook de lista.

Nombre	Tipo	Description
nextLink	string	Obtiene o establece el vínculo siguiente.
value	Webhook[]	Obtiene o establece una lista de webhooks.