你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Webhook - Create Or Update

创建由 Webhook 名称标识的 Webhook。

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

URI 参数

名称 必需 类型 说明
automationAccountName
path True

string

自动化帐户的名称。

resourceGroupName
path True

string

Azure 资源组的名称。

正则表达式模式: ^[-\w\._]+$

subscriptionId
path True

string

获取唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

webhookName
path True

string

Webhook 名称。

api-version
query True

string

客户端 API 版本。

请求正文

名称 必需 类型 说明
name True

string

获取或设置 Webhook 的名称。

properties.expiryTime

string

获取或设置到期时间。

properties.isEnabled

boolean

获取或设置 webhook 的已启用标志的值。

properties.parameters

object

获取或设置作业的参数。

properties.runOn

string

获取或设置运行 Webhook 作业的混合辅助角色组的名称。

properties.runbook

RunbookAssociationProperty

获取或设置 Runbook。

properties.uri

string

获取或设置 URI。

响应

名称 类型 说明
200 OK

Webhook

确定

201 Created

Webhook

创建

Other Status Codes

ErrorResponse

描述操作失败原因的自动化错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Create or update webhook

示例请求

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

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

示例响应

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

定义

名称 说明
ErrorResponse

操作失败的错误响应

RunbookAssociationProperty

与实体关联的 Runbook 属性。

Webhook

Webhook 类型的定义。

WebhookCreateOrUpdateParameters

提供给创建或更新 Webhook 操作的参数。

ErrorResponse

操作失败的错误响应

名称 类型 说明
code

string

错误代码

message

string

指示操作失败原因的错误消息。

RunbookAssociationProperty

与实体关联的 Runbook 属性。

名称 类型 说明
name

string

获取或设置 Runbook 的名称。

Webhook

Webhook 类型的定义。

名称 类型 默认值 说明
id

string

资源的完全限定资源 ID

name

string

资源的名称

properties.creationTime

string

获取或设置创建时间。

properties.description

string

获取或设置说明。

properties.expiryTime

string

获取或设置到期时间。

properties.isEnabled

boolean

False

获取或设置 Webhook 的已启用标志的值。

properties.lastInvokedTime

string

获取或设置上次调用的时间。

properties.lastModifiedBy

string

上次修改 Webhook 的用户的详细信息

properties.lastModifiedTime

string

获取或设置上次修改时间。

properties.parameters

object

获取或设置 Webhook 调用与之关联的 Runbook 时创建的作业的参数。

properties.runOn

string

获取或设置运行 Webhook 作业的混合辅助角色组的名称。

properties.runbook

RunbookAssociationProperty

获取或设置与 Webhook 关联的 Runbook。

properties.uri

string

获取或设置 Webhook URI。

type

string

资源类型。

WebhookCreateOrUpdateParameters

提供给创建或更新 Webhook 操作的参数。

名称 类型 说明
name

string

获取或设置 Webhook 的名称。

properties.expiryTime

string

获取或设置到期时间。

properties.isEnabled

boolean

获取或设置 webhook 的已启用标志的值。

properties.parameters

object

获取或设置作业的参数。

properties.runOn

string

获取或设置运行 Webhook 作业的混合辅助角色组的名称。

properties.runbook

RunbookAssociationProperty

获取或设置 Runbook。

properties.uri

string

获取或设置 URI。