다음을 통해 공유

Triggers - Create Or Replace

서비스:
Purview
API 버전:
2023-09-01

트리거 인스턴스를 만들거나 대체합니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
dataSourceName
 path True

string

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

dataSource 이름입니다.
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 버전입니다.

요청 본문

Name 형식 Description
properties

TriggerProperties

트리거의 속성입니다.
validationErrorInfo

string

트리거의 유효성 검사 오류 정보입니다.

응답

Name 형식 Description
200 OK

Trigger

성공.
201 Created

Trigger

성공.
Other Status Codes

ErrorResponseModel

검색 서비스에서 받은 오류 응답입니다.

헤더

x-ms-error-code: string

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

Triggers_CreateOrReplace

샘플 요청

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

정의

Name Description
DayOfWeek

되풀이 일정 발생일입니다.
DaysOfWeek

되풀이 일정의 요일입니다.
ErrorModel

오류 모델입니다.
ErrorResponseModel

오류 응답 모델입니다.
RecurrenceSchedule

되풀이 일정입니다.
RecurrenceScheduleOccurrence

되풀이 일정의 발생입니다.
ScanLevelType

검사 수준 유형입니다.
Trigger

트리거 개체입니다.
TriggerFrequency

트리거 되풀이 빈도입니다.
TriggerProperties

트리거의 속성 세부 정보입니다.
TriggerRecurrence

트리거의 되풀이입니다.
TriggerState

트리거의 상태입니다.

DayOfWeek

열거형

되풀이 일정 발생일입니다.

값 Description
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

DaysOfWeek

열거형

되풀이 일정의 요일입니다.

값 Description
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

ErrorModel

Object

오류 모델입니다.

Name 형식 Description
code

string

특정 오류를 식별하는 고유한 오류 코드입니다.
details

ErrorModel[]

추가 오류 세부 정보를 제공하는 중첩된 ErrorModel 개체의 배열입니다.
message

string

오류에 대한 자세한 내용을 제공하는 사람이 읽을 수 있는 오류 메시지입니다.
target

string

오류가 연결된 특정 구성 요소입니다.

ErrorResponseModel

Object

오류 응답 모델입니다.

Name 형식 Description
error

ErrorModel

오류 모델입니다.

RecurrenceSchedule

Object

되풀이 일정입니다.

Name 형식 Description
hours

integer[] (int32)

되풀이 일정의 시간입니다.
minutes

integer[] (int32)

되풀이 일정의 분입니다.
monthDays

integer[] (int32)

되풀이 일정의 월 일 수입니다.
monthlyOccurrences

RecurrenceScheduleOccurrence[]

되풀이 일정의 월별 발생 횟수입니다.
weekDays

DaysOfWeek[]

되풀이 일정의 요일입니다.

RecurrenceScheduleOccurrence

Object

되풀이 일정의 발생입니다.

Name 형식 Description
day

DayOfWeek

되풀이 일정 발생일입니다.
occurrence

integer (int32)

ScanLevelType

열거형

검사 수준 유형입니다.

값 Description
Full

검색이 전체 검사입니다.
Incremental

검색이 증분 검사인 경우

Trigger

Object

트리거 개체입니다.

Name 형식 Description
id

string

리소스 식별자입니다.
name

string

리소스 이름입니다.
properties

TriggerProperties

트리거의 속성입니다.
validationErrorInfo

string

트리거의 유효성 검사 오류 정보입니다.

TriggerFrequency

열거형

트리거 되풀이 빈도입니다.

값 Description
Week
Month
Day
Hour

TriggerProperties

Object

트리거의 속성 세부 정보입니다.

Name 형식 Default value Description
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

트리거의 되풀이입니다.

Name 형식 Description
endTime

string (date-time)

트리거 되풀이의 종료 시간입니다.
frequency

TriggerFrequency

트리거 되풀이 빈도입니다.
interval

integer (int32)

트리거 되풀이 간격입니다.
schedule

RecurrenceSchedule

트리거 되풀이 일정입니다.
startTime

string (date-time)

트리거 되풀이의 시작 시간입니다.
timeZone

string

트리거 되풀이의 표준 시간대입니다.

TriggerState

열거형

트리거의 상태입니다.

값 Description
Enabled
Disabled