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

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 バージョン。

要求本文

名前 型 説明
properties

TriggerProperties

トリガーのプロパティ。
validationErrorInfo

string

トリガーの検証エラー情報。

応答

名前 型 説明
200 OK

Trigger

成功。
201 Created

Trigger

成功。
Other Status Codes

ErrorResponseModel

スキャン サービスから受信したエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
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"
  }
}

定義

名前 説明
DayOfWeek

繰り返しスケジュールの発生日。
DaysOfWeek

繰り返しスケジュールの曜日。
ErrorModel

エラー モデル。
ErrorResponseModel

エラー応答モデル。
RecurrenceSchedule

繰り返しのスケジュール。
RecurrenceScheduleOccurrence

繰り返しスケジュールの発生。
ScanLevelType

スキャン レベルの種類。
Trigger

トリガー オブジェクト。
TriggerFrequency

トリガーの繰り返しの頻度。
TriggerProperties

トリガーのプロパティの詳細。
TriggerRecurrence

トリガーの繰り返し。
TriggerState

トリガーの状態。

DayOfWeek

列挙

繰り返しスケジュールの発生日。

値 説明
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

DaysOfWeek

列挙

繰り返しスケジュールの曜日。

値 説明
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

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

列挙

トリガーの繰り返しの頻度。

値 説明
Week
Month
Day
Hour

TriggerProperties

Object

トリガーのプロパティの詳細。

名前 型 規定値 説明
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

列挙

トリガーの状態。

値 説明
Enabled
Disabled