Triggers - Create Or Replace

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 minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nom de la source de données.
endpoint	path	True	string (url)	Point de terminaison d’analyse de votre compte Purview. Exemple : https://{accountName}.purview.azure.com.
scanName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nom de l’analyse.
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	Succès.
201 Created	Trigger	Succès.
Other Status Codes	ErrorResponseModel	Réponse d’erreur reçue du service d’analyse. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

Trigger

Succès.

201 Created

Trigger

Succès.

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

HTTP

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	Jours de semaine de la planification 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étails des propriétés du déclencheur.
TriggerRecurrence	Périodicité du déclencheur.
TriggerState	État du déclencheur.

DayOfWeek

Énumération

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

Valeur	Description
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

DaysOfWeek

Énumération

Jours de semaine de la planification de périodicité.

Valeur	Description
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

ErrorModel

Object

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’homme qui fournit plus de détails sur l’erreur.
target	string	Composant spécifique auquel l’erreur est associée.

ErrorResponseModel

Object

Modèle de réponse d’erreur.

Nom	Type	Description
error	ErrorModel	Modèle d’erreur.

RecurrenceSchedule

Object

Planification de la périodicité.

Nom	Type	Description
hours	integer[] (int32)	Heures de planification de périodicité.
minutes	integer[] (int32)	Minutes de la planification de périodicité.
monthDays	integer[] (int32)	Jours de mois de la planification de périodicité.
monthlyOccurrences	RecurrenceScheduleOccurrence[]	Occurrences mensuelles de la planification de périodicité.
weekDays	DaysOfWeek[]	Jours de semaine de la planification de périodicité.

RecurrenceScheduleOccurrence

Object

Occurrence de la planification de périodicité.

Nom	Type	Description
day	DayOfWeek	Jour de l’occurrence de la planification de périodicité.
occurrence	integer (int32)

ScanLevelType

Énumération

Type de niveau d’analyse.

Valeur	Description
Full	l’analyse est complète
Incremental	l’analyse est incrémentielle

Trigger

Object

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

Énumération

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

Valeur	Description
Week
Month
Day
Hour

TriggerProperties

Object

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

Nom	Type	Valeur par défaut	Description
createdAt	string (date-time)		Heure de création du déclencheur.
incrementalScanStartTime	string (date-time)		Heure de début de l’analyse incrémentielle du déclencheur.
lastModifiedAt	string (date-time)		Heure de la dernière modification du déclencheur.
lastScheduled	string (date-time)		Dernière heure planifiée du déclencheur.
recurrence	TriggerRecurrence		Périodicité 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

Object

Périodicité du déclencheur.

Nom	Type	Description
endTime	string (date-time)	Heure de fin de la périodicité du déclencheur.
frequency	TriggerFrequency	Fréquence de périodicité du déclencheur.
interval	integer (int32)	Intervalle de périodicité du déclencheur.
schedule	RecurrenceSchedule	Planification de la périodicité du déclencheur.
startTime	string (date-time)	Heure de début de la périodicité du déclencheur.
timeZone	string	Fuseau horaire de la périodicité du déclencheur.

TriggerState

Énumération

État du déclencheur.

Valeur	Description
Enabled
Disabled

Partager via

Triggers - Create Or Replace

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Triggers_CreateOrReplace

Exemple de requête

Exemple de réponse

Définitions

DayOfWeek

DaysOfWeek

ErrorModel

ErrorResponseModel

RecurrenceSchedule

RecurrenceScheduleOccurrence

ScanLevelType

Trigger

TriggerFrequency

TriggerProperties

TriggerRecurrence

TriggerState