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

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: 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

Сведения о свойствах триггера.

Имя	Тип	Default value	Описание
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

Дополнительные ресурсы