Webhook - Update

Служба:: Automation

Версия API:: 2024-10-23

Обновите веб-перехватчик, определенный по имени веб-перехватчика.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
automationAccountName	path	True	string	Имя учетной записи службы автоматизации.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Имя группы ресурсов Azure.
subscriptionId	path	True	string	Получает учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
webhookName	path	True	string	Имя веб-перехватчика.
api-version	query	True	string	Версия клиентского API.

Текст запроса

Имя	Тип	Описание
name	string	Возвращает или задает имя веб-перехватчика.
properties.description	string	Возвращает или задает описание веб-перехватчика.
properties.isEnabled	boolean	Возвращает или задает значение включенного флага веб-перехватчика.
properties.parameters	object	Возвращает или задает параметры задания.
properties.runOn	string	Возвращает или задает имя гибридной рабочей группы, на котором будет выполняться задание веб-перехватчика.

Ответы

Имя	Тип	Описание
200 OK	Webhook	ХОРОШО
Other Status Codes	ErrorResponse	Ответ об ошибке автоматизации, описывающий, почему операция завершилась ошибкой.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update webhook

Образец запроса

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

Пример ответа

Код состояния:: 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"
  }
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorResponse	Ответ на ошибку сбоя операции
RunbookAssociationProperty	Свойство Runbook, связанное с сущностью.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
Webhook	Определение типа веб-перехватчика.
WebhookUpdateParameters	Параметры, предоставленные операции веб-перехватчика обновления.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Ответ на ошибку сбоя операции

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

RunbookAssociationProperty

Object

Свойство Runbook, связанное с сущностью.

Имя	Тип	Описание
name	string	Возвращает или задает имя модуля Runbook.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Webhook

Object

Определение типа веб-перехватчика.

Имя	Тип	Default value	Описание
id	string (arm-id)		Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Имя ресурса
properties.creationTime	string (date-time)		Возвращает или задает время создания.
properties.description	string		Возвращает или задает описание.
properties.expiryTime	string (date-time)		Возвращает или задает время истечения срока действия.
properties.isEnabled	boolean	False	Возвращает или задает значение включенного флага веб-перехватчика.
properties.lastInvokedTime	string (date-time)		Возвращает или задает время последнего вызова.
properties.lastModifiedBy	string		Сведения о пользователе, который последний раз изменил веб-перехватчик
properties.lastModifiedTime	string (date-time)		Возвращает или задает время последнего изменения.
properties.parameters	object		Возвращает или задает параметры задания, созданного при вызове веб-перехватчика модуля Runbook, с которым он связан.
properties.runOn	string		Возвращает или задает имя гибридной рабочей группы, на котором будет выполняться задание веб-перехватчика.
properties.runbook	RunbookAssociationProperty		Возвращает или задает модуль Runbook, с которым связан веб-перехватчик.
properties.uri	string		Возвращает или задает универсальный код ресурса (URI) веб-перехватчика.
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

WebhookUpdateParameters

Object

Параметры, предоставленные операции веб-перехватчика обновления.

Имя	Тип	Описание
name	string	Возвращает или задает имя веб-перехватчика.
properties.description	string	Возвращает или задает описание веб-перехватчика.
properties.isEnabled	boolean	Возвращает или задает значение включенного флага веб-перехватчика.
properties.parameters	object	Возвращает или задает параметры задания.
properties.runOn	string	Возвращает или задает имя гибридной рабочей группы, на котором будет выполняться задание веб-перехватчика.

Поделиться через

Webhook - Update

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

Update webhook

Образец запроса

Пример ответа

Определения

createdByType

ErrorResponse

RunbookAssociationProperty

systemData

Webhook

WebhookUpdateParameters