Webhook - Get

Service:

Automation

API Version:

2015-10-31

Ambil webhook yang diidentifikasi dengan nama webhook.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
automationAccountName	path	True	string	Nama akun otomatisasi.
resourceGroupName	path	True	string	Nama grup Sumber Daya Azure. Regex pattern: ^[-\w\._]+$
subscriptionId	path	True	string	Mendapatkan kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
webhookName	path	True	string	Nama webhook.
api-version	query	True	string	Versi Api Klien.

Respons

Nama	Jenis	Deskripsi
200 OK	Webhook	OK
Other Status Codes	ErrorResponse	Respons kesalahan automasi yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get webhook

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for Webhook Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getWebhook.json
     */
    /**
     * Sample code: Get webhook.
     *
     * @param manager Entry point to AutomationManager.
     */
    public static void getWebhook(com.azure.resourcemanager.automation.AutomationManager manager) {
        manager.webhooks().getWithResponse("rg", "myAutomationAccount33", "TestWebhook", 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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-automation
# USAGE
    python get_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.get(
        resource_group_name="rg",
        automation_account_name="myAutomationAccount33",
        webhook_name="TestWebhook",
    )
    print(response)


# x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getWebhook.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/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/getWebhook.json
func ExampleWebhookClient_Get() {
	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().Get(ctx, "rg", "myAutomationAccount33", "TestWebhook", 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-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

JavaScript

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

/**
 * This sample demonstrates how to Retrieve the webhook identified by webhook name.
 *
 * @summary Retrieve the webhook identified by webhook name.
 * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getWebhook.json
 */
async function getWebhook() {
  const subscriptionId = process.env["AUTOMATION_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["AUTOMATION_RESOURCE_GROUP"] || "rg";
  const automationAccountName = "myAutomationAccount33";
  const webhookName = "TestWebhook";
  const credential = new DefaultAzureCredential();
  const client = new AutomationClient(credential, subscriptionId);
  const result = await client.webhookOperations.get(
    resourceGroupName,
    automationAccountName,
    webhookName
  );
  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/getWebhook.json
// this example is just showing the usage of "Webhook_Get" 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";
NullableResponse<AutomationWebhookResource> response = await collection.GetIfExistsAsync(webhookName);
AutomationWebhookResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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": 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"
  }
}

Definisi

Nama	Deskripsi
ErrorResponse	Respons kesalahan kegagalan operasi
RunbookAssociationProperty	Properti runbook yang terkait dengan entitas.
Webhook	Definisi jenis webhook.

ErrorResponse

Respons kesalahan kegagalan operasi

Nama	Jenis	Deskripsi
code	string	Kode kesalahan
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

RunbookAssociationProperty

Properti runbook yang terkait dengan entitas.

Nama	Jenis	Deskripsi
name	string	Mendapatkan atau mengatur nama runbook.

Webhook

Definisi jenis webhook.

Nama	Jenis	Nilai Default	Deskripsi
id	string		Id sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya
name	string		Nama sumber daya.
properties.creationTime	string		Mendapatkan atau mengatur waktu pembuatan.
properties.description	string		Mendapatkan atau mengatur deskripsi.
properties.expiryTime	string		Mendapatkan atau mengatur waktu kedaluwarsa.
properties.isEnabled	boolean	False	Mendapatkan atau menetapkan nilai bendera webhook yang diaktifkan.
properties.lastInvokedTime	string		Mendapatkan atau mengatur waktu terakhir yang dipanggil.
properties.lastModifiedBy	string		Detail pengguna yang terakhir mengubah Webhook
properties.lastModifiedTime	string		Mendapatkan atau mengatur waktu terakhir yang dimodifikasi.
properties.parameters	object		Mendapatkan atau mengatur parameter pekerjaan yang dibuat saat webhook memanggil runbook yang terkait dengannya.
properties.runOn	string		Mendapatkan atau mengatur nama grup hybrid worker tempat pekerjaan webhook akan berjalan.
properties.runbook	RunbookAssociationProperty		Mendapatkan atau mengatur runbook yang dikaitkan dengan webhook.
properties.uri	string		Mendapatkan atau mengatur uri webhook.
type	string		Jenis sumber daya.