Webhook - Get

Hizmet:

Automation

API Sürümü:

2024-10-23

Web kancası adıyla tanımlanan web kancasını alın.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
automationAccountName	path	True	string	Otomasyon hesabının adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. İsim büyük/küçük harfe duyarsızdır.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
webhookName	path	True	string	Web kancası adı.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	Webhook	Azure işlemi başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Get webhook

Örnek isteği

HTTP

GET https://management.azure.com/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook?api-version=2024-10-23

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="SUBSCRIPTION_ID",
    )

    response = client.webhook.get(
        resource_group_name="rg",
        automation_account_name="myAutomationAccount33",
        webhook_name="TestWebhook",
    )
    print(response)


# x-ms-original-file: 2024-10-23/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: 2024-10-23/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("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", 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 = armautomation.WebhookClientGetResponse{
	// 	Webhook: armautomation.Webhook{
	// 		Name: to.Ptr("TestWebhook"),
	// 		ID: to.Ptr("/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/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.6651862+00:00"); return t}()),
	// 			ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-29T22:18:13.7002872+00:00"); return t}()),
	// 			IsEnabled: to.Ptr(true),
	// 			LastInvokedTime: nil,
	// 			LastModifiedBy: to.Ptr(""),
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-29T22:18:14.6651862+00:00"); 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: 2024-10-23/getWebhook.json
 */
async function getWebhook() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee";
  const client = new AutomationClient(credential, subscriptionId);
  const result = await client.webhookOperations.get("rg", "myAutomationAccount33", "TestWebhook");
  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

Örnek yanıt

Durum kodu:

200

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

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
RunbookAssociationProperty	Varlıkla ilişkilendirilmiş runbook özelliği.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
Webhook	Web kancası türünün tanımı.

createdByType

Numaralandırma

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi

ErrorResponse

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

RunbookAssociationProperty

Nesne

Varlıkla ilişkilendirilmiş runbook özelliği.

Name	Tür	Description
name	string	Runbook'un adını alır veya ayarlar.

systemData

Nesne

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

Webhook

Nesne

Web kancası türünün tanımı.

Name	Tür	Description
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Kaynağın adı
properties.creationTime	string (date-time)	Oluşturma zamanını alır veya ayarlar.
properties.description	string	Açıklamayı alır veya ayarlar.
properties.expiryTime	string (date-time)	Süre sonunu alır veya ayarlar.
properties.isEnabled	boolean	Web kancasının etkin bayrağının değerini alır veya ayarlar.
properties.lastInvokedTime	string (date-time)	Son çağrılan zamanı alır veya ayarlar.
properties.lastModifiedBy	string	Web kancasını son değiştiren kullanıcının ayrıntıları
properties.lastModifiedTime	string (date-time)	Son değiştirme zamanını alır veya ayarlar.
properties.parameters	object	Web kancası ilişkili olduğu runbook'u çağırdığında oluşturulan işin parametrelerini alır veya ayarlar.
properties.runOn	string	Web kancası işinin üzerinde çalıştırılacağı karma çalışan grubunun adını alır veya ayarlar.
properties.runbook	RunbookAssociationProperty	Web kancasının ilişkili olduğu runbook'u alır veya ayarlar.
properties.uri	string	Web kancası uri'sini alır veya ayarlar.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"