Partager via

Triggers - Create Or Replace

  • Référence
Service:
Purview
Version d'API:
2023-09-01

Crée ou remplace une instance d’un déclencheur.

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

Paramètres URI

Nom Dans Obligatoire Type Description
dataSourceName
 path True

string

Nom dataSource.

Modèle d’expression régulière: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
endpoint
 path True

string

url

Point de terminaison d’analyse de votre compte purview. Exemple : https://{accountName}.purview.azure.com.
scanName
 path True

string

Nom de l’analyse.

Modèle d’expression régulière: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
api-version
 query True

string

Version de l’API à utiliser.

Corps de la demande

Nom Type Description
properties

TriggerProperties

Propriétés du déclencheur.
validationErrorInfo

string

Informations d’erreur de validation du déclencheur.

Réponses

Nom Type Description
200 OK

Trigger

Réussite.
201 Created

Trigger

Réussite.
Other Status Codes

ErrorResponseModel

Réponse d’erreur reçue du service d’analyse.

En-têtes

x-ms-error-code: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Triggers_CreateOrReplace

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
  }
}
Code d’état:
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"
  }
}

Définitions

Nom Description
DayOfWeek

Jour de l’occurrence de la planification de périodicité.
DaysOfWeek

Horaire des jours de la semaine de périodicité.
ErrorModel

Modèle d’erreur.
ErrorResponseModel

Modèle de réponse d’erreur.
RecurrenceSchedule

Planification de la périodicité.
RecurrenceScheduleOccurrence

Occurrence de la planification de périodicité.
ScanLevelType

Type de niveau d’analyse.
Trigger

Objet déclencheur.
TriggerFrequency

Fréquence de périodicité du déclencheur.
TriggerProperties

Détail des propriétés du déclencheur.
TriggerRecurrence

Récurrence du déclencheur.
TriggerState

État du déclencheur.

DayOfWeek

Jour de l’occurrence de la planification de périodicité.

Nom Type Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

DaysOfWeek

Horaire des jours de la semaine de périodicité.

Nom Type Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorModel

Modèle d’erreur.

Nom Type Description
code

string

Code d’erreur unique qui identifie l’erreur spécifique.
details

ErrorModel[]

Tableau d’objets ErrorModel imbriqués qui fournit des détails d’erreur supplémentaires.
message

string

Message d’erreur lisible par l’utilisateur qui fournit plus de détails sur l’erreur.
target

string

Composant spécifique auquel l’erreur est associée.

ErrorResponseModel

Modèle de réponse d’erreur.

Nom Type Description
error

ErrorModel

Modèle d’erreur.

RecurrenceSchedule

Planification de la périodicité.

Nom Type Description
hours

integer[]

Planification des heures de périodicité.
minutes

integer[]

Horaire de périodicité en minutes.
monthDays

integer[]

Calendrier des mois de périodicité.
monthlyOccurrences

RecurrenceScheduleOccurrence[]

Occurrences mensuelles de la planification de périodicité.
weekDays

DaysOfWeek[]

Horaire des jours de la semaine de périodicité.

RecurrenceScheduleOccurrence

Occurrence de la planification de périodicité.

Nom Type Description
day

DayOfWeek

Jour de l’occurrence de la planification de périodicité.
occurrence

integer

ScanLevelType

Type de niveau d’analyse.

Nom Type Description
Full

string

l’analyse est complète
Incremental

string

l’analyse est une analyse incrémentielle

Trigger

Objet déclencheur.

Nom Type Description
id

string

Identificateur de ressource.
name

string

Nom de la ressource.
properties

TriggerProperties

Propriétés du déclencheur.
validationErrorInfo

string

Informations d’erreur de validation du déclencheur.

TriggerFrequency

Fréquence de périodicité du déclencheur.

Nom Type Description
Day

string

Hour

string

Month

string

Week

string

TriggerProperties

Détail des propriétés du déclencheur.

Nom Type Valeur par défaut Description
createdAt

string

Heure de création du déclencheur.
incrementalScanStartTime

string

Heure de début de l’analyse incrémentielle du déclencheur.
lastModifiedAt

string

Heure de la dernière modification du déclencheur.
lastScheduled

string

Dernière heure planifiée du déclencheur.
recurrence

TriggerRecurrence

Récurrence du déclencheur.
recurrenceInterval

string

Intervalle de périodicité du déclencheur.
scanLevel

ScanLevelType

Niveau d’analyse du déclencheur.
state

TriggerState

Enabled

État du déclencheur.

TriggerRecurrence

Récurrence du déclencheur.

Nom Type Description
endTime

string

Heure de fin de la périodicité du déclencheur.
frequency

TriggerFrequency

Fréquence de périodicité du déclencheur.
interval

integer

Intervalle de périodicité du déclencheur.
schedule

RecurrenceSchedule

Planification de la périodicité du déclencheur.
startTime

string

Heure de début de la périodicité du déclencheur.
timeZone

string

Fuseau horaire de la périodicité du déclencheur.

TriggerState

État du déclencheur.

Nom Type Description
Disabled

string

Enabled

string