Triggers - Get

Dienst:

Purview

API-Version:

2023-09-01

Ruft Triggerinformationen ab.

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

URI-Parameter

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

Antworten

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

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Triggers_Get

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
DayOfWeek	Der Tag des Auftretens des Wiederholungszeitplans.
DaysOfWeek	Der Wochentage-Wiederholungszeitplan.
ErrorModel	Das Fehlermodell.
ErrorResponseModel	Das Fehlerantwortmodell.
RecurrenceSchedule	Wiederholungszeitplan.
RecurrenceScheduleOccurrence	Das Auftreten eines Wiederholungszeitplans.
ScanLevelType	Typ der Scanebene.
Trigger	Das Triggerobjekt.
TriggerFrequency	Die Häufigkeit der Triggerwiederkehr.
TriggerProperties	Eigenschaftendetails des Triggers.
TriggerRecurrence	Die Wiederholung des Triggers.
TriggerState	Der Status des Triggers.

DayOfWeek

Der Tag des Auftretens des Wiederholungszeitplans.

Name	Typ	Beschreibung
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

DaysOfWeek

Der Wochentage-Wiederholungszeitplan.

Name	Typ	Beschreibung
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorModel

Das Fehlermodell.

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

ErrorResponseModel

Das Fehlerantwortmodell.

Name	Typ	Beschreibung
error	ErrorModel	Das Fehlermodell.

RecurrenceSchedule

Wiederholungszeitplan.

Name	Typ	Beschreibung
hours	integer[]	Der Wiederholungszeitplan.
minutes	integer[]	Der Wiederholungszeitplan für Minuten.
monthDays	integer[]	Monatstage mit Wiederholungszeitplan.
monthlyOccurrences	RecurrenceScheduleOccurrence[]	Der monatliche Wiederholungszeitplan.
weekDays	DaysOfWeek[]	Der Wochentage-Wiederholungszeitplan.

RecurrenceScheduleOccurrence

Das Auftreten eines Wiederholungszeitplans.

Name	Typ	Beschreibung
day	DayOfWeek	Der Tag des Auftretens des Wiederholungszeitplans.
occurrence	integer

ScanLevelType

Typ der Scanebene.

Name	Typ	Beschreibung
Full	string	Der Scan ist vollständig.
Incremental	string	Der Scan ist eine inkrementelle Überprüfung.

Trigger

Das Triggerobjekt.

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.
name	string	Der Name der Ressource.
properties	TriggerProperties	Die Eigenschaften des Triggers.
validationErrorInfo	string	Die Validierungsfehlerinformationen des Triggers.

TriggerFrequency

Die Häufigkeit der Triggerwiederkehr.

Name	Typ	Beschreibung
Day	string
Hour	string
Month	string
Week	string

TriggerProperties

Eigenschaftendetails des Triggers.

Name	Typ	Standardwert	Beschreibung
createdAt	string		Die Erstellungszeit des Triggers.
incrementalScanStartTime	string		Die Startzeit des Triggers für den inkrementellen Scan.
lastModifiedAt	string		Der Zeitpunkt der letzten Änderung des Triggers.
lastScheduled	string		Der letzte geplante Zeitpunkt des Triggers.
recurrence	TriggerRecurrence		Die Wiederholung des Triggers.
recurrenceInterval	string		Das Wiederholungsintervall des Triggers.
scanLevel	ScanLevelType		Die Scanebene des Triggers.
state	TriggerState	Enabled	Der Status des Triggers.

TriggerRecurrence

Die Wiederholung des Triggers.

Name	Typ	Beschreibung
endTime	string	Die Endzeit der Triggerserie.
frequency	TriggerFrequency	Die Häufigkeit der Triggerwiederkehr.
interval	integer	Das Intervall der Triggerserie.
schedule	RecurrenceSchedule	Der Zeitplan der Triggerserie.
startTime	string	Die Startzeit der Triggerserie.
timeZone	string	Die Zeitzone der Triggerserie.

TriggerState

Der Status des Triggers.

Name	Typ	Beschreibung
Disabled	string
Enabled	string