Condividi tramite

Triggers - Get

  • Riferimento
Servizio:
Purview
Versione API:
2023-09-01

Ottiene le informazioni sul trigger.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
dataSourceName
 path True

string

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

Nome dataSource.
endpoint
 path True

string (url)

Endpoint di analisi dell'account purview. Esempio: https://{accountName}.purview.azure.com.
scanName
 path True

string

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

Nome dell'analisi.
api-version
 query True

string

Versione dell'API da usare.

Risposte

Nome Tipo Descrizione
200 OK

Trigger

Successo.
Other Status Codes

ErrorResponseModel

Risposta di errore ricevuta dal servizio di analisi.

Intestazioni

x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Triggers_Get

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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."
}

Definizioni

Nome Descrizione
DayOfWeek

Giorno dell'occorrenza della pianificazione ricorrenza.
DaysOfWeek

Giorni della settimana di pianificazione della ricorrenza.
ErrorModel

Modello di errore.
ErrorResponseModel

Modello di risposta di errore.
RecurrenceSchedule

Pianificazione della ricorrenza.
RecurrenceScheduleOccurrence

Occorrenza della pianificazione della ricorrenza.
ScanLevelType

Tipo di livello di analisi.
Trigger

Oggetto trigger.
TriggerFrequency

Frequenza di ricorrenza del trigger.
TriggerProperties

Dettaglio proprietà del trigger.
TriggerRecurrence

Ricorrenza del trigger.
TriggerState

Stato del trigger.

DayOfWeek

Enumerazione

Giorno dell'occorrenza della pianificazione ricorrenza.

Valore Descrizione
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

DaysOfWeek

Enumerazione

Giorni della settimana di pianificazione della ricorrenza.

Valore Descrizione
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ErrorModel

Object

Modello di errore.

Nome Tipo Descrizione
code

string

Codice di errore univoco che identifica l'errore specifico.
details

ErrorModel[]

Matrice di oggetti ErrorModel annidati che fornisce dettagli aggiuntivi sull'errore.
message

string

Messaggio di errore leggibile che fornisce altri dettagli sull'errore.
target

string

Componente specifico a cui è associato l'errore.

ErrorResponseModel

Object

Modello di risposta di errore.

Nome Tipo Descrizione
error

ErrorModel

Modello di errore.

RecurrenceSchedule

Object

Pianificazione della ricorrenza.

Nome Tipo Descrizione
hours

integer[] (int32)

Ore di pianificazione della ricorrenza.
minutes

integer[] (int32)

Minuti di pianificazione della ricorrenza.
monthDays

integer[] (int32)

Giorni mensili di pianificazione della ricorrenza.
monthlyOccurrences

RecurrenceScheduleOccurrence[]

Occorrenze mensili della pianificazione delle ricorrenze.
weekDays

DaysOfWeek[]

Giorni della settimana di pianificazione della ricorrenza.

RecurrenceScheduleOccurrence

Object

Occorrenza della pianificazione della ricorrenza.

Nome Tipo Descrizione
day

DayOfWeek

Giorno dell'occorrenza della pianificazione ricorrenza.
occurrence

integer (int32)

ScanLevelType

Enumerazione

Tipo di livello di analisi.

Valore Descrizione
Full

l'analisi è completa
Incremental

l'analisi è un'analisi incrementale

Trigger

Object

Oggetto trigger.

Nome Tipo Descrizione
id

string

Identificatore della risorsa.
name

string

Nome della risorsa.
properties

TriggerProperties

Proprietà del trigger.
validationErrorInfo

string

Informazioni sull'errore di convalida del trigger.

TriggerFrequency

Enumerazione

Frequenza di ricorrenza del trigger.

Valore Descrizione
Day
Hour
Month
Week

TriggerProperties

Object

Dettaglio proprietà del trigger.

Nome Tipo Valore predefinito Descrizione
createdAt

string (date-time)

Ora di creazione del trigger.
incrementalScanStartTime

string (date-time)

Ora di inizio dell'analisi incrementale del trigger.
lastModifiedAt

string (date-time)

Ora dell'ultima modifica del trigger.
lastScheduled

string (date-time)

Ora pianificata dell'ultimo trigger.
recurrence

TriggerRecurrence

Ricorrenza del trigger.
recurrenceInterval

string

Intervallo di ricorrenza del trigger.
scanLevel

ScanLevelType

Livello di analisi del trigger.
state

TriggerState

Enabled

Stato del trigger.

TriggerRecurrence

Object

Ricorrenza del trigger.

Nome Tipo Descrizione
endTime

string (date-time)

Ora di fine della ricorrenza del trigger.
frequency

TriggerFrequency

Frequenza di ricorrenza del trigger.
interval

integer (int32)

Intervallo di ricorrenza del trigger.
schedule

RecurrenceSchedule

Pianificazione della ricorrenza del trigger.
startTime

string (date-time)

Ora di inizio della ricorrenza del trigger.
timeZone

string

Fuso orario della ricorrenza del trigger.

TriggerState

Enumerazione

Stato del trigger.

Valore Descrizione
Disabled
Enabled