Webhook - Update

Layanan:

Automation

Versi API:

2024-10-23

Perbarui webhook yang diidentifikasi dengan nama webhook.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
automationAccountName	path	True	string	Nama akun automasi.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nama grup Sumber Daya Azure.
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.

Isi Permintaan

Nama	Jenis	Deskripsi
name	string	Mendapatkan atau mengatur nama webhook.
properties.description	string	Mendapatkan atau mengatur deskripsi webhook.
properties.isEnabled	boolean	Mendapatkan atau menetapkan nilai bendera webhook yang diaktifkan.
properties.parameters	object	Mendapatkan atau mengatur parameter pekerjaan.
properties.runOn	string	Mendapatkan atau mengatur nama grup hybrid worker tempat pekerjaan webhook akan berjalan.

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

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Update webhook

Permintaan sampel

HTTP

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

{
  "name": "TestWebhook",
  "properties": {
    "isEnabled": false,
    "description": "updated webhook"
  }
}

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorResponse	Respons kesalahan kegagalan operasi
RunbookAssociationProperty	Properti runbook yang terkait dengan entitas.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
Webhook	Definisi jenis webhook.
WebhookUpdateParameters	Parameter yang disediakan untuk operasi webhook pembaruan.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorResponse

Objek

Respons kesalahan kegagalan operasi

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

RunbookAssociationProperty

Objek

Properti runbook yang terkait dengan entitas.

Nama	Jenis	Deskripsi
name	string	Mendapatkan atau mengatur nama runbook.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

Webhook

Objek

Definisi jenis webhook.

Nama	Jenis	Nilai default	Deskripsi
id	string (arm-id)		ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Nama sumber daya
properties.creationTime	string (date-time)		Mendapatkan atau mengatur waktu pembuatan.
properties.description	string		Mendapatkan atau mengatur deskripsi.
properties.expiryTime	string (date-time)		Mendapatkan atau mengatur waktu kedaluwarsa.
properties.isEnabled	boolean	False	Mendapatkan atau mengatur nilai bendera webhook yang diaktifkan.
properties.lastInvokedTime	string (date-time)		Mendapatkan atau mengatur waktu terakhir yang dipanggil.
properties.lastModifiedBy	string		Detail pengguna yang terakhir memodifikasi Webhook
properties.lastModifiedTime	string (date-time)		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.
systemData	systemData		Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string		Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

WebhookUpdateParameters

Objek

Parameter yang disediakan untuk operasi webhook pembaruan.

Nama	Jenis	Deskripsi
name	string	Mendapatkan atau mengatur nama webhook.
properties.description	string	Mendapatkan atau mengatur deskripsi webhook.
properties.isEnabled	boolean	Mendapatkan atau menetapkan nilai bendera webhook yang diaktifkan.
properties.parameters	object	Mendapatkan atau mengatur parameter pekerjaan.
properties.runOn	string	Mendapatkan atau mengatur nama grup hybrid worker tempat pekerjaan webhook akan berjalan.