Triggers - Create Or Replace

Dienst:: Purview

API-Version:: 2023-09-01

Erstellt oder ersetzt eine Instanz eines Triggers.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dataSourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Der Name der Datenquelle.
endpoint	path	True	string (url)	Der Überprüfungsendpunkt Ihres Purview-Kontos. Beispiel: https://{accountName}.purview.azure.com.
scanName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Der Scanname.
api-version	query	True	string	Die zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
properties	TriggerProperties	Die Eigenschaften des Triggers.
validationErrorInfo	string	Die Überprüfungsfehlerinformationen des Triggers.

Antworten

Name	Typ	Beschreibung
200 OK	Trigger	Erfolg.
201 Created	Trigger	Erfolg.
Other Status Codes	ErrorResponseModel	Eine Vom Scandienst empfangene Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

Trigger

Erfolg.

201 Created

Trigger

Erfolg.

Other Status Codes

ErrorResponseModel

Eine Vom Scandienst empfangene Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Triggers_CreateOrReplace

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Definitionen

Name	Beschreibung
DayOfWeek	Der Termintermin des Terminplans am Tag.
DaysOfWeek	Die Wochentage des Serienzeitplans.
ErrorModel	Das Fehlermodell.
ErrorResponseModel	Das Fehlerantwortmodell.
RecurrenceSchedule	Terminplan der Serie.
RecurrenceScheduleOccurrence	Das Auftreten eines Serienzeitplans.
ScanLevelType	Typ der Scanebene.
Trigger	Das Triggerobjekt.
TriggerFrequency	Die Häufigkeit der Triggerserie.
TriggerProperties	Eigenschaftendetails des Triggers.
TriggerRecurrence	Die Serie des Triggers.
TriggerState	Der Zustand des Triggers.

DayOfWeek

Enumeration

Der Termintermin des Terminplans am Tag.

Wert	Beschreibung
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

DaysOfWeek

Enumeration

Die Wochentage des Serienzeitplans.

Wert	Beschreibung
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

ErrorModel

Objekt

Das Fehlermodell.

Name	Typ	Beschreibung
code	string	Ein eindeutiger Fehlercode, der den spezifischen Fehler identifiziert.
details	ErrorModel[]	Ein Array geschachtelter ErrorModel-Objekte, die zusätzliche Fehlerdetails enthalten.
message	string	Eine für Menschen lesbare Fehlermeldung, die weitere Details zum Fehler bereitstellt.
target	string	Die spezifische Komponente, der der Fehler zugeordnet ist.

ErrorResponseModel

Objekt

Das Fehlerantwortmodell.

Name	Typ	Beschreibung
error	ErrorModel	Das Fehlermodell.

RecurrenceSchedule

Objekt

Terminplan der Serie.

Name	Typ	Beschreibung
hours	integer[] (int32)	Die Stunden des Wiederholungszeitplans.
minutes	integer[] (int32)	Die Minuten des Wiederholungszeitplans.
monthDays	integer[] (int32)	Monatstage des Serienzeitplans.
monthlyOccurrences	RecurrenceScheduleOccurrence[]	Die monatlichen Vorkommen des Serienzeitplans.
weekDays	DaysOfWeek[]	Die Wochentage des Serienzeitplans.

RecurrenceScheduleOccurrence

Objekt

Das Auftreten eines Serienzeitplans.

Name	Typ	Beschreibung
day	DayOfWeek	Der Termintermin des Terminplans am Tag.
occurrence	integer (int32)

ScanLevelType

Enumeration

Typ der Scanebene.

Wert	Beschreibung
Full	Der Scan ist vollständig gescannt.
Incremental	der Scan inkrementelle Überprüfung ist

Trigger

Objekt

Das Triggerobjekt.

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.
name	string	Der Ressourcenname.
properties	TriggerProperties	Die Eigenschaften des Triggers.
validationErrorInfo	string	Die Überprüfungsfehlerinformationen des Triggers.

TriggerFrequency

Enumeration

Die Häufigkeit der Triggerserie.

Wert	Beschreibung
Week
Month
Day
Hour

TriggerProperties

Objekt

Eigenschaftendetails des Triggers.

Name	Typ	Standardwert	Beschreibung
createdAt	string (date-time)		Die Erstellungszeit des Triggers.
incrementalScanStartTime	string (date-time)		Die Inkrementelle Scan-Startzeit des Triggers.
lastModifiedAt	string (date-time)		Der Zeitpunkt der letzten Änderung des Triggers.
lastScheduled	string (date-time)		Der letzte geplante Auslösertermin.
recurrence	TriggerRecurrence		Die Serie des Triggers.
recurrenceInterval	string		Das Serienintervall des Triggers.
scanLevel	ScanLevelType		Die Scanebene des Triggers.
state	TriggerState	Enabled	Der Zustand des Triggers.

TriggerRecurrence

Objekt

Die Serie des Triggers.

Name	Typ	Beschreibung
endTime	string (date-time)	Die Endzeit der Triggerserie.
frequency	TriggerFrequency	Die Häufigkeit der Triggerserie.
interval	integer (int32)	Das Intervall der Triggerserie.
schedule	RecurrenceSchedule	Der Zeitplan der Triggerserie.
startTime	string (date-time)	Die Startzeit der Triggerserie.
timeZone	string	Die Zeitzone der Triggerserie.

TriggerState

Enumeration

Der Zustand des Triggers.

Wert	Beschreibung
Enabled
Disabled

Freigeben über

Triggers - Create Or Replace

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Triggers_CreateOrReplace

Beispielanforderung

Beispiel für eine Antwort

Definitionen

DayOfWeek

DaysOfWeek

ErrorModel

ErrorResponseModel

RecurrenceSchedule

RecurrenceScheduleOccurrence

ScanLevelType

Trigger

TriggerFrequency

TriggerProperties

TriggerRecurrence

TriggerState