Triggers - Get

Referencia

Servicio:: Purview

Versión de la API:: 2023-09-01

Obtiene información del desencadenador.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
dataSourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nombre del origen de datos.
endpoint	path	True	string (url)	Punto de conexión de examen de la cuenta de purview. Ejemplo: https://{accountName}.purview.azure.com.
scanName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nombre del examen.
api-version	query	True	string	Versión de api que se va a usar.

Respuestas

Nombre	Tipo	Description
200 OK	Trigger	Éxito.
Other Status Codes	ErrorResponseModel	Respuesta de error recibida del servicio de examen. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

Trigger

Éxito.

Other Status Codes

ErrorResponseModel

Respuesta de error recibida del servicio de examen.

Encabezados

x-ms-error-code: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Triggers_Get

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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."
}

Definiciones

Nombre	Description
DayOfWeek	El día de la repetición de la programación de periodicidad.
DaysOfWeek	Los días de la semana de la programación de periodicidad.
ErrorModel	Modelo de error.
ErrorResponseModel	Modelo de respuesta de error.
RecurrenceSchedule	Programación de periodicidad.
RecurrenceScheduleOccurrence	Repetición de la programación de periodicidad.
ScanLevelType	Tipo de nivel de examen.
Trigger	Objeto de desencadenador.
TriggerFrequency	Frecuencia de periodicidad del desencadenador.
TriggerProperties	Detalles de las propiedades del desencadenador.
TriggerRecurrence	Periodicidad del desencadenador.
TriggerState	Estado del desencadenador.

DayOfWeek

Enumeración

El día de la repetición de la programación de periodicidad.

Valor	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

DaysOfWeek

Enumeración

Los días de la semana de la programación de periodicidad.

Valor	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ErrorModel

Object

Modelo de error.

Nombre	Tipo	Description
code	string	Código de error único que identifica el error específico.
details	ErrorModel[]	Matriz de objetos ErrorModel anidados que proporciona detalles de error adicionales.
message	string	Mensaje de error legible que proporciona más detalles sobre el error.
target	string	Componente específico al que está asociado el error.

ErrorResponseModel

Object

Modelo de respuesta de error.

Nombre	Tipo	Description
error	ErrorModel	Modelo de error.

RecurrenceSchedule

Object

Programación de periodicidad.

Nombre	Tipo	Description
hours	integer[] (int32)	Las horas de programación de periodicidad.
minutes	integer[] (int32)	Los minutos de la programación de periodicidad.
monthDays	integer[] (int32)	Días de mes de la programación de periodicidad.
monthlyOccurrences	RecurrenceScheduleOccurrence[]	Las repeticiones mensuales de la programación de periodicidad.
weekDays	DaysOfWeek[]	Los días de la semana de la programación de periodicidad.

RecurrenceScheduleOccurrence

Object

Repetición de la programación de periodicidad.

Nombre	Tipo	Description
day	DayOfWeek	El día de la repetición de la programación de periodicidad.
occurrence	integer (int32)

ScanLevelType

Enumeración

Tipo de nivel de examen.

Valor	Description
Full	el examen es completo
Incremental	el examen es un examen incremental.

Trigger

Object

Objeto de desencadenador.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties	TriggerProperties	Propiedades del desencadenador.
validationErrorInfo	string	Información de error de validación del desencadenador.

TriggerFrequency

Enumeración

Frecuencia de periodicidad del desencadenador.

Valor	Description
Day
Hour
Month
Week

TriggerProperties

Object

Detalles de las propiedades del desencadenador.

Nombre	Tipo	Valor predeterminado	Description
createdAt	string (date-time)		Hora de creación del desencadenador.
incrementalScanStartTime	string (date-time)		Hora de inicio del examen incremental del desencadenador.
lastModifiedAt	string (date-time)		Hora de la última modificación del desencadenador.
lastScheduled	string (date-time)		La última hora programada del desencadenador.
recurrence	TriggerRecurrence		Periodicidad del desencadenador.
recurrenceInterval	string		Intervalo de periodicidad del desencadenador.
scanLevel	ScanLevelType		Nivel de examen del desencadenador.
state	TriggerState	Enabled	Estado del desencadenador.

TriggerRecurrence

Object

Periodicidad del desencadenador.

Nombre	Tipo	Description
endTime	string (date-time)	Hora de finalización de la periodicidad del desencadenador.
frequency	TriggerFrequency	Frecuencia de periodicidad del desencadenador.
interval	integer (int32)	Intervalo de periodicidad del desencadenador.
schedule	RecurrenceSchedule	Programación de periodicidad del desencadenador.
startTime	string (date-time)	Hora de inicio de la periodicidad del desencadenador.
timeZone	string	Zona horaria de periodicidad del desencadenador.

TriggerState

Enumeración

Estado del desencadenador.

Valor	Description
Disabled
Enabled

Compartir a través de

Triggers - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Triggers_Get

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DayOfWeek

DaysOfWeek

ErrorModel

ErrorResponseModel

RecurrenceSchedule

RecurrenceScheduleOccurrence

ScanLevelType

Trigger

TriggerFrequency

TriggerProperties

TriggerRecurrence

TriggerState

Recursos adicionales