Webhook - Create Or Update

Hizmet:

Automation

API Sürümü:

2024-10-23

Web kancası adıyla tanımlanan web kancasını oluşturun.

PUT 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 pattern: ^[-\w\._]+$	Azure Kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgilerini alır. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
webhookName	path	True	string	Web kancası adı.
api-version	query	True	string	İstemci Api Sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
name	True	string	Web kancasının adını 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.parameters		object	İş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	Runbook'u alır veya ayarlar.
properties.uri		string	URI'yi alır veya ayarlar.

Yanıtlar

Name	Tür	Description
200 OK	Webhook	Tamam
201 Created	Webhook	Oluşturuldu
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan otomasyon hatası yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

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

Create or update webhook

Örnek isteği

HTTP

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

{
  "name": "TestWebhook",
  "properties": {
    "isEnabled": true,
    "uri": "<uri>",
    "expiryTime": "2018-03-29T22:18:13.7002872Z",
    "runbook": {
      "name": "TestRunbook"
    }
  }
}

Örnek yanıt

Durum kodu:

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

Durum kodu:

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

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorResponse	İşlem hatasının 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ı.
WebhookCreateOrUpdateParameters	Web kancası oluşturma veya güncelleştirme işlemine sağlanan parametreler.

createdByType

Listeleme

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

Değer	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

İşlem hatasının hata yanıtı

Name	Tür	Description
code	string	Hata kodu
message	string	İşlemin neden başarısız olduğunu gösteren hata iletisi.

RunbookAssociationProperty

Object

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

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

systemData

Object

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

Object

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

Name	Tür	Default value	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	False	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"

WebhookCreateOrUpdateParameters

Object

Web kancası oluşturma veya güncelleştirme işlemine sağlanan parametreler.

Name	Tür	Description
name	string	Web kancasının adını 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.parameters	object	İş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	Runbook'u alır veya ayarlar.
properties.uri	string	URI'yi alır veya ayarlar.