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

Triggers - Get

  • Ссылка
Служба:
Purview
Версия API:
2023-09-01

Возвращает сведения о триггере.

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

Параметры URI

Имя В Обязательно Тип Описание
dataSourceName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

Имя источника данных.
endpoint
 path True

string (url)

Конечная точка сканирования учетной записи purview. Пример: https://{accountName}.purview.azure.com.
scanName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

Имя проверки.
api-version
 query True

string

Используемая версия API.

Ответы

Имя Тип Описание
200 OK

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_Get

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

GET {endpoint}/scan/datasources/myDataSourceName/scans/myScanName/triggers/default?api-version=2023-09-01

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

Код состояния:
200 
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
{
  "properties": {
    "recurrence": {
      "frequency": "Month",
      "interval": 1,
      "startTime": "2020-06-03T19:15:00Z",
      "endTime": "2020-06-03T19:22:00Z",
      "schedule": {
        "minutes": [
          56
        ],
        "hours": [
          23
        ],
        "weekDays": null,
        "monthDays": null,
        "monthlyOccurrences": [
          {
            "day": "Wednesday",
            "occurrence": 2
          }
        ]
      }
    },
    "recurrenceInterval": null,
    "createdAt": "2020-06-11T05:15:04.1940429Z",
    "lastModifiedAt": "2020-06-19T22:26:22.6514064Z",
    "lastScheduled": null,
    "scanLevel": "Incremental",
    "state": "Enabled"
  },
  "validationErrorInfo": "Trigger is invalid: monthDays or monthlyOccurrences is required."
}

Определения

Имя Описание
DayOfWeek

День возникновения расписания повторения.
DaysOfWeek

Выходные дни расписания повторения.
ErrorModel

Модель ошибок.
ErrorResponseModel

Модель ответа на ошибку.
RecurrenceSchedule

Расписание повторения.
RecurrenceScheduleOccurrence

Вхождение расписания повторения.
ScanLevelType

Тип уровня сканирования.
Trigger

Объект триггера.
TriggerFrequency

Частота повторения триггера.
TriggerProperties

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

Повторение триггера.
TriggerState

Состояние триггера.

DayOfWeek

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

День возникновения расписания повторения.

Значение Описание
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

DaysOfWeek

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

Выходные дни расписания повторения.

Значение Описание
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ErrorModel

Object

Модель ошибок.

Имя Тип Описание
code

string

Уникальный код ошибки, определяющий конкретную ошибку.
details

ErrorModel[]

Массив вложенных объектов ErrorModel, предоставляющий дополнительные сведения об ошибке.
message

string

Сообщение об ошибке, доступное для чтения пользователем, которое содержит дополнительные сведения об ошибке.
target

string

Конкретный компонент, с которым связана ошибка.

ErrorResponseModel

Object

Модель ответа на ошибку.

Имя Тип Описание
error

ErrorModel

Модель ошибок.

RecurrenceSchedule

Object

Расписание повторения.

Имя Тип Описание
hours

integer[] (int32)

Часы расписания повторения.
minutes

integer[] (int32)

Минуты расписания повторения.
monthDays

integer[] (int32)

Месяцы расписания повторения.
monthlyOccurrences

RecurrenceScheduleOccurrence[]

Ежемесячные вхождения расписания повторения.
weekDays

DaysOfWeek[]

Выходные дни расписания повторения.

RecurrenceScheduleOccurrence

Object

Вхождение расписания повторения.

Имя Тип Описание
day

DayOfWeek

День возникновения расписания повторения.
occurrence

integer (int32)

ScanLevelType

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

Тип уровня сканирования.

Значение Описание
Full

Проверка является полной проверкой
Incremental

Сканирование является добавочным сканированием

Trigger

Object

Объект триггера.

Имя Тип Описание
id

string

Идентификатор ресурса.
name

string

Имя ресурса.
properties

TriggerProperties

Свойства триггера.
validationErrorInfo

string

Сведения об ошибке проверки триггера.

TriggerFrequency

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

Частота повторения триггера.

Значение Описание
Day
Hour
Month
Week

TriggerProperties

Object

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

Имя Тип Default value Описание
createdAt

string (date-time)

Время создания триггера.
incrementalScanStartTime

string (date-time)

Время начала добавочного сканирования триггера.
lastModifiedAt

string (date-time)

Время последнего изменения триггера.
lastScheduled

string (date-time)

Последнее запланированное время триггера.
recurrence

TriggerRecurrence

Повторение триггера.
recurrenceInterval

string

Интервал повторения триггера.
scanLevel

ScanLevelType

Уровень сканирования триггера.
state

TriggerState

Enabled

Состояние триггера.

TriggerRecurrence

Object

Повторение триггера.

Имя Тип Описание
endTime

string (date-time)

Время окончания повторения триггера.
frequency

TriggerFrequency

Частота повторения триггера.
interval

integer (int32)

Интервал повторения триггера.
schedule

RecurrenceSchedule

Расписание повторения триггера.
startTime

string (date-time)

Время начала повторения триггера.
timeZone

string

Часовой пояс повторения триггера.

TriggerState

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

Состояние триггера.

Значение Описание
Disabled
Enabled