Triggers - Get

Gets trigger information.

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

URI Parameters

Name In Required Type Description
dataSourceName
path True

string

The dataSource name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

endpoint
path True

string

url

The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com.

scanName
path True

string

The scan name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

api-version
query True

string

The api version to use.

Responses

Name Type Description
200 OK

Trigger

Success.

Other Status Codes

ErrorResponseModel

An error response received from the Scanning Service.

Headers

x-ms-error-code: string

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Triggers_Get

Sample request

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

Sample response

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

Definitions

Name Description
DayOfWeek

The day of recurrence schedule occurrence.

DaysOfWeek

The week days of recurrence schedule.

ErrorModel

The error model.

ErrorResponseModel

The error response model.

RecurrenceSchedule

Schedule of recurrence.

RecurrenceScheduleOccurrence

The occurrence of recurrence schedule.

ScanLevelType

Scan level type.

Trigger

The trigger object.

TriggerFrequency

The frequency of trigger recurrence.

TriggerProperties

Properties detail of trigger.

TriggerRecurrence

The recurrence of trigger.

TriggerState

The state of trigger.

DayOfWeek

The day of recurrence schedule occurrence.

Name Type Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

DaysOfWeek

The week days of recurrence schedule.

Name Type Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorModel

The error model.

Name Type Description
code

string

A unique error code that identifies the specific error.

details

ErrorModel[]

An array of nested ErrorModel objects that provides additional error details.

message

string

A human-readable error message that provides more details about the error.

target

string

The specific component that the error is associated with.

ErrorResponseModel

The error response model.

Name Type Description
error

ErrorModel

The error model.

RecurrenceSchedule

Schedule of recurrence.

Name Type Description
hours

integer[]

The hours of recurrence schedule.

minutes

integer[]

The minutes of recurrence schedule.

monthDays

integer[]

Month days of recurrence schedule.

monthlyOccurrences

RecurrenceScheduleOccurrence[]

The monthly occurrences of recurrence schedule.

weekDays

DaysOfWeek[]

The week days of recurrence schedule.

RecurrenceScheduleOccurrence

The occurrence of recurrence schedule.

Name Type Description
day

DayOfWeek

The day of recurrence schedule occurrence.

occurrence

integer

ScanLevelType

Scan level type.

Name Type Description
Full

string

the scan is full scan

Incremental

string

the scan is incremental scan

Trigger

The trigger object.

Name Type Description
id

string

The resource identifier.

name

string

The resource name.

properties

TriggerProperties

The properties of trigger.

validationErrorInfo

string

The validation error info of trigger.

TriggerFrequency

The frequency of trigger recurrence.

Name Type Description
Day

string

Hour

string

Month

string

Week

string

TriggerProperties

Properties detail of trigger.

Name Type Default value Description
createdAt

string

The create time of trigger.

incrementalScanStartTime

string

The incremental scan start time of trigger.

lastModifiedAt

string

The last modified time of trigger.

lastScheduled

string

The last scheduled time of trigger.

recurrence

TriggerRecurrence

The recurrence of trigger.

recurrenceInterval

string

The recurrence interval of trigger.

scanLevel

ScanLevelType

The scan level of trigger.

state

TriggerState

Enabled

The state of trigger.

TriggerRecurrence

The recurrence of trigger.

Name Type Description
endTime

string

The end time of trigger recurrence.

frequency

TriggerFrequency

The frequency of trigger recurrence.

interval

integer

The interval of trigger recurrence.

schedule

RecurrenceSchedule

The schedule of trigger recurrence.

startTime

string

The start time of trigger recurrence.

timeZone

string

The time zone of trigger recurrence.

TriggerState

The state of trigger.

Name Type Description
Disabled

string

Enabled

string