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

Triggers - Create Or Replace

参考

服务:: Purview

API 版本:: 2023-09-01

创建或替换触发器的实例。

PUT {endpoint}/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default?api-version=2023-09-01

URI 参数

名称	在	必需	类型	说明
dataSourceName	path	True	string	dataSource 名称。正则表达式模式: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
endpoint	path	True	string url	purview 帐户的扫描终结点。示例：https://{accountName}.purview.azure.com。
scanName	path	True	string	扫描名称。正则表达式模式: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
api-version	query	True	string	要使用的 API 版本。

请求正文

名称	类型	说明
properties	TriggerProperties	触发器的属性。
validationErrorInfo	string	触发器的验证错误信息。

响应

名称	类型	说明
200 OK	Trigger	成功。
201 Created	Trigger	成功。
Other Status Codes	ErrorResponseModel	从扫描服务收到的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

Trigger

成功。

201 Created

Trigger

成功。

Other Status Codes

ErrorResponseModel

从扫描服务收到的错误响应。

标头

x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Triggers_CreateOrReplace

示例请求

HTTP

PUT {endpoint}/scan/datasources/DataSource1/scans/Scan1/triggers/default?api-version=2023-09-01

{
  "properties": {
    "recurrenceInterval": null,
    "scanLevel": "Incremental",
    "state": "Enabled",
    "recurrence": {
      "startTime": "2021-02-12T14:59:00.416Z",
      "endTime": "2021-02-25T00:00:00.000Z",
      "interval": 1,
      "frequency": "Month",
      "schedule": {
        "hours": [
          23
        ],
        "minutes": [
          56
        ],
        "monthDays": [
          10
        ]
      }
    }
  }
}

示例响应

状态代码:: 201

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

{
  "name": "default",
  "id": "datasources/AzureBlob-DSTDParv/scans/Scan-PUl/triggers/default",
  "properties": {
    "recurrence": {
      "frequency": "Month",
      "interval": 4,
      "startTime": "2021-02-12T14:59:00.416Z",
      "endTime": "2021-02-25T00:00:00Z",
      "schedule": {
        "minutes": [
          56
        ],
        "hours": [
          23
        ],
        "weekDays": null,
        "monthDays": null,
        "monthlyOccurrences": [
          {
            "day": "Wednesday",
            "occurrence": 2
          }
        ]
      }
    },
    "recurrenceInterval": null,
    "createdAt": "2021-02-12T14:58:58.0478425Z",
    "lastModifiedAt": "2021-02-12T15:39:53.6482996Z",
    "lastScheduled": null,
    "scanLevel": "Incremental",
    "state": "Enabled"
  }
}

状态代码:: 200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

{
  "name": "default",
  "id": "datasources/AzureBlob-DSTDParv/scans/Scan-PUl/triggers/default",
  "properties": {
    "recurrence": {
      "frequency": "Month",
      "interval": 4,
      "startTime": "2021-02-12T14:59:00.416Z",
      "endTime": "2021-02-25T00:00:00Z",
      "schedule": {
        "minutes": [
          56
        ],
        "hours": [
          23
        ],
        "weekDays": null,
        "monthDays": null,
        "monthlyOccurrences": [
          {
            "day": "Wednesday",
            "occurrence": 2
          }
        ]
      }
    },
    "recurrenceInterval": null,
    "createdAt": "2021-02-12T14:58:58.0478425Z",
    "lastModifiedAt": "2021-02-12T15:39:53.6482996Z",
    "lastScheduled": null,
    "scanLevel": "Incremental",
    "state": "Enabled"
  }
}

定义

名称	说明
DayOfWeek	重复计划发生的日期。
DaysOfWeek	定期计划的周天数。
ErrorModel	错误模型。
ErrorResponseModel	错误响应模型。
RecurrenceSchedule	定期计划。
RecurrenceScheduleOccurrence	重复计划的发生。
ScanLevelType	扫描级别类型。
Trigger	触发器对象。
TriggerFrequency	触发器重复的频率。
TriggerProperties	触发器的属性详细信息。
TriggerRecurrence	触发器的重复周期。
TriggerState	触发器的状态。

DayOfWeek

重复计划发生的日期。

名称	类型	说明
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

DaysOfWeek

定期计划的周天数。

名称	类型	说明
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorModel

错误模型。

名称	类型	说明
code	string	标识特定错误的唯一错误代码。
details	ErrorModel[]	提供其他错误详细信息的嵌套 ErrorModel 对象的数组。
message	string	一条用户可读的错误消息，提供有关错误的更多详细信息。
target	string	与错误关联的特定组件。

ErrorResponseModel

错误响应模型。

名称	类型	说明
error	ErrorModel	错误模型。

RecurrenceSchedule

定期计划。

名称	类型	说明
hours	integer[]	定期计划的小时数。
minutes	integer[]	定期计划的分钟数。
monthDays	integer[]	重复计划的月份天数。
monthlyOccurrences	RecurrenceScheduleOccurrence[]	定期计划的每月发生次数。
weekDays	DaysOfWeek[]	定期计划的周天数。

RecurrenceScheduleOccurrence

重复计划的发生。

名称	类型	说明
day	DayOfWeek	重复计划发生的日期。
occurrence	integer

ScanLevelType

扫描级别类型。

名称	类型	说明
Full	string	扫描为完全扫描
Incremental	string	扫描是增量扫描

Trigger

触发器对象。

名称	类型	说明
id	string	资源标识符。
name	string	资源名称。
properties	TriggerProperties	触发器的属性。
validationErrorInfo	string	触发器的验证错误信息。

TriggerFrequency

触发器重复的频率。

名称	类型	说明
Day	string
Hour	string
Month	string
Week	string

TriggerProperties

触发器的属性详细信息。

名称	类型	默认值	说明
createdAt	string		触发器的创建时间。
incrementalScanStartTime	string		触发器的增量扫描开始时间。
lastModifiedAt	string		上次修改触发器的时间。
lastScheduled	string		上次计划的触发器时间。
recurrence	TriggerRecurrence		触发器的重复周期。
recurrenceInterval	string		触发器的重复间隔。
scanLevel	ScanLevelType		触发器的扫描级别。
state	TriggerState	Enabled	触发器的状态。

TriggerRecurrence

触发器的重复周期。

名称	类型	说明
endTime	string	触发器重复的结束时间。
frequency	TriggerFrequency	触发器重复的频率。
interval	integer	触发器重复周期的间隔。
schedule	RecurrenceSchedule	触发器重复计划。
startTime	string	触发器重复周期的开始时间。
timeZone	string	触发器重复周期的时区。

TriggerState

触发器的状态。

名称	类型	说明
Disabled	string
Enabled	string

通过

Triggers - Create Or Replace

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Triggers_CreateOrReplace

示例请求

示例响应

定义

DayOfWeek

DaysOfWeek

ErrorModel

ErrorResponseModel

RecurrenceSchedule

RecurrenceScheduleOccurrence

ScanLevelType

Trigger

TriggerFrequency

TriggerProperties

TriggerRecurrence

TriggerState

其他资源