Compartir a través de

Triggers - Create Or Replace

  • Referencia
Servicio:
Purview
Versión de la API:
2023-09-01

Crea o reemplaza una instancia de un desencadenador.

PUT {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

Nombre del origen de datos.

Patrón de Regex: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
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

Nombre del examen.

Patrón de Regex: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
api-version
 query True

string

La versión de api que se va a usar.

Cuerpo de la solicitud

Nombre Tipo Description
properties

TriggerProperties

Propiedades del desencadenador.
validationErrorInfo

string

Información de error de validación del desencadenador.

Respuestas

Nombre Tipo Description
200 OK

Trigger

Correcto.
201 Created

Trigger

Correcto.
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 suplantación de su cuenta de usuario

Ejemplos

Triggers_CreateOrReplace

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
DayOfWeek

Día de 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

La 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

Día de repetición de la programación de periodicidad.

Nombre Tipo Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

DaysOfWeek

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

Nombre Tipo Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorModel

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

Modelo de respuesta de error.

Nombre Tipo Description
error

ErrorModel

Modelo de error.

RecurrenceSchedule

Programación de periodicidad.

Nombre Tipo Description
hours

integer[]

Horas de programación de periodicidad.
minutes

integer[]

Minutos de programación de periodicidad.
monthDays

integer[]

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

La repetición de la programación de periodicidad.

Nombre Tipo Description
day

DayOfWeek

Día de repetición de la programación de periodicidad.
occurrence

integer

ScanLevelType

Tipo de nivel de examen.

Nombre Tipo Description
Full

string

el examen es un examen completo
Incremental

string

el examen es un examen incremental

Trigger

Objeto de desencadenador.

Nombre Tipo Description
id

string

Identificador del recurso.
name

string

Nombre del recurso.
properties

TriggerProperties

Propiedades del desencadenador.
validationErrorInfo

string

Información de error de validación del desencadenador.

TriggerFrequency

Frecuencia de periodicidad del desencadenador.

Nombre Tipo Description
Day

string

Hour

string

Month

string

Week

string

TriggerProperties

Detalles de las propiedades del desencadenador.

Nombre Tipo Valor predeterminado Description
createdAt

string

Hora de creación del desencadenador.
incrementalScanStartTime

string

Hora de inicio del examen incremental del desencadenador.
lastModifiedAt

string

Hora de la última modificación del desencadenador.
lastScheduled

string

Ú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

Periodicidad del desencadenador.

Nombre Tipo Description
endTime

string

Hora de finalización de la periodicidad del desencadenador.
frequency

TriggerFrequency

Frecuencia de periodicidad del desencadenador.
interval

integer

Intervalo de periodicidad del desencadenador.
schedule

RecurrenceSchedule

Programación de periodicidad del desencadenador.
startTime

string

Hora de inicio de la periodicidad del desencadenador.
timeZone

string

Zona horaria de periodicidad del desencadenador.

TriggerState

Estado del desencadenador.

Nombre Tipo Description
Disabled

string

Enabled

string