Freigeben über

Triggers - Get

  • Referenz
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

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.

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-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_Get

Beispielanforderung

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 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
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

DaysOfWeek

Enumeration

Die Wochentage des Serienzeitplans.

Wert Beschreibung
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

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
Day
Hour
Month
Week

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
Disabled
Enabled