Condividi tramite


Triggers - Enable

Abilita un trigger.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
dataSourceName
path True

string

Nome dataSource.

Criterio di espressione regolare: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

endpoint
path True

string

url

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

scanName
path True

string

Nome dell'analisi.

Criterio di espressione regolare: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

api-version
query True

string

Versione dell'API da usare.

Risposte

Nome Tipo Descrizione
200 OK

Trigger

Operazione completata.

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_Enable

Esempio di richiesta

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

Risposta di esempio

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"
  },
  "id": "datasources/myDataSourceName/scans/myScanName/triggers/default",
  "name": "default"
}

Definizioni

Nome Descrizione
DayOfWeek

Giorno dell'occorrenza della pianificazione della ricorrenza.

DaysOfWeek

Giorni della settimana della pianificazione della ricorrenza.

ErrorModel

Modello di errore.

ErrorResponseModel

Modello di risposta agli errori.

RecurrenceSchedule

Pianificazione della ricorrenza.

RecurrenceScheduleOccurrence

Occorrenza della pianificazione della ricorrenza.

ScanLevelType

Tipo di livello di analisi.

Trigger

Oggetto trigger.

TriggerFrequency

Frequenza della ricorrenza del trigger.

TriggerProperties

Dettaglio proprietà del trigger.

TriggerRecurrence

Ricorrenza del trigger.

TriggerState

Stato del trigger.

DayOfWeek

Giorno dell'occorrenza della pianificazione della ricorrenza.

Nome Tipo Descrizione
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

DaysOfWeek

Giorni della settimana della pianificazione della ricorrenza.

Nome Tipo Descrizione
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorModel

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

Modello di risposta agli errori.

Nome Tipo Descrizione
error

ErrorModel

Modello di errore.

RecurrenceSchedule

Pianificazione della ricorrenza.

Nome Tipo Descrizione
hours

integer[]

Ore di pianificazione della ricorrenza.

minutes

integer[]

Minuti di pianificazione della ricorrenza.

monthDays

integer[]

Giorni mensili di pianificazione della ricorrenza.

monthlyOccurrences

RecurrenceScheduleOccurrence[]

Occorrenze mensili della pianificazione della ricorrenza.

weekDays

DaysOfWeek[]

Giorni della settimana della pianificazione della ricorrenza.

RecurrenceScheduleOccurrence

Occorrenza della pianificazione della ricorrenza.

Nome Tipo Descrizione
day

DayOfWeek

Giorno dell'occorrenza della pianificazione della ricorrenza.

occurrence

integer

ScanLevelType

Tipo di livello di analisi.

Nome Tipo Descrizione
Full

string

l'analisi è completa

Incremental

string

l'analisi è un'analisi incrementale

Trigger

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

Frequenza della ricorrenza del trigger.

Nome Tipo Descrizione
Day

string

Hour

string

Month

string

Week

string

TriggerProperties

Dettaglio proprietà del trigger.

Nome Tipo Valore predefinito Descrizione
createdAt

string

Ora di creazione del trigger.

incrementalScanStartTime

string

Ora di inizio dell'analisi incrementale del trigger.

lastModifiedAt

string

Ora dell'ultima modifica del trigger.

lastScheduled

string

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

Ricorrenza del trigger.

Nome Tipo Descrizione
endTime

string

Ora di fine della ricorrenza del trigger.

frequency

TriggerFrequency

Frequenza della ricorrenza del trigger.

interval

integer

Intervallo di ricorrenza del trigger.

schedule

RecurrenceSchedule

Pianificazione della ricorrenza del trigger.

startTime

string

Ora di inizio della ricorrenza del trigger.

timeZone

string

Fuso orario della ricorrenza del trigger.

TriggerState

Stato del trigger.

Nome Tipo Descrizione
Disabled

string

Enabled

string