Compartilhar via

Triggers - Get

  • Referência
Serviço:
Purview
Versão da API:
2023-09-01

Obtém informações de gatilho.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
dataSourceName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

O nome da fonte de dados.
endpoint
 path True

string (url)

O ponto de extremidade de verificação da sua conta do Purview. Exemplo: https://{accountName}.purview.azure.com.
scanName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

O nome da verificação.
api-version
 query True

string

A versão da API a ser usada.

Respostas

Nome Tipo Description
200 OK

Trigger

Êxito.
Other Status Codes

ErrorResponseModel

Uma resposta de erro recebida do Serviço de Verificação.

Cabeçalhos

x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Triggers_Get

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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."
}

Definições

Nome Description
DayOfWeek

O dia da ocorrência de agendamento de recorrência.
DaysOfWeek

Os dias da semana de agendamento de recorrência.
ErrorModel

O modelo de erro.
ErrorResponseModel

O modelo de resposta de erro.
RecurrenceSchedule

Agendamento de recorrência.
RecurrenceScheduleOccurrence

A ocorrência de agendamento de recorrência.
ScanLevelType

Tipo de nível de verificação.
Trigger

O objeto de gatilho.
TriggerFrequency

A frequência da recorrência do gatilho.
TriggerProperties

Detalhes de propriedades do gatilho.
TriggerRecurrence

A recorrência do gatilho.
TriggerState

O estado do gatilho.

DayOfWeek

Enumeração

O dia da ocorrência de agendamento de recorrência.

Valor Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

DaysOfWeek

Enumeração

Os dias da semana de agendamento de recorrência.

Valor Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ErrorModel

Objeto

O modelo de erro.

Nome Tipo Description
code

string

Um código de erro exclusivo que identifica o erro específico.
details

ErrorModel[]

Uma matriz de objetos ErrorModel aninhados que fornece detalhes adicionais de erro.
message

string

Uma mensagem de erro legível por humanos que fornece mais detalhes sobre o erro.
target

string

O componente específico ao qual o erro está associado.

ErrorResponseModel

Objeto

O modelo de resposta de erro.

Nome Tipo Description
error

ErrorModel

O modelo de erro.

RecurrenceSchedule

Objeto

Agendamento de recorrência.

Nome Tipo Description
hours

integer[] (int32)

As horas de agendamento de recorrência.
minutes

integer[] (int32)

Os minutos de agendamento de recorrência.
monthDays

integer[] (int32)

Dias mensais de agendamento de recorrência.
monthlyOccurrences

RecurrenceScheduleOccurrence[]

As ocorrências mensais de agendamento de recorrência.
weekDays

DaysOfWeek[]

Os dias da semana de agendamento de recorrência.

RecurrenceScheduleOccurrence

Objeto

A ocorrência de agendamento de recorrência.

Nome Tipo Description
day

DayOfWeek

O dia da ocorrência de agendamento de recorrência.
occurrence

integer (int32)

ScanLevelType

Enumeração

Tipo de nível de verificação.

Valor Description
Full

a verificação é completa
Incremental

a verificação é incremental

Trigger

Objeto

O objeto de gatilho.

Nome Tipo Description
id

string

O identificador de recurso.
name

string

O nome do recurso.
properties

TriggerProperties

As propriedades do gatilho.
validationErrorInfo

string

As informações de erro de validação do gatilho.

TriggerFrequency

Enumeração

A frequência da recorrência do gatilho.

Valor Description
Day
Hour
Month
Week

TriggerProperties

Objeto

Detalhes de propriedades do gatilho.

Nome Tipo Valor padrão Description
createdAt

string (date-time)

A hora de criação do gatilho.
incrementalScanStartTime

string (date-time)

A hora de início da verificação incremental do gatilho.
lastModifiedAt

string (date-time)

A hora da última modificação do gatilho.
lastScheduled

string (date-time)

A última hora agendada do gatilho.
recurrence

TriggerRecurrence

A recorrência do gatilho.
recurrenceInterval

string

O intervalo de recorrência do gatilho.
scanLevel

ScanLevelType

O nível de verificação do gatilho.
state

TriggerState

Enabled

O estado do gatilho.

TriggerRecurrence

Objeto

A recorrência do gatilho.

Nome Tipo Description
endTime

string (date-time)

A hora de término da recorrência do gatilho.
frequency

TriggerFrequency

A frequência da recorrência do gatilho.
interval

integer (int32)

O intervalo de recorrência do gatilho.
schedule

RecurrenceSchedule

O agendamento da recorrência do gatilho.
startTime

string (date-time)

A hora de início da recorrência do gatilho.
timeZone

string

O fuso horário da recorrência do gatilho.

TriggerState

Enumeração

O estado do gatilho.

Valor Description
Disabled
Enabled