Triggers - Get

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	O nome do dataSource. Padrão Regex: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
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	O nome da verificação. Padrão Regex: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
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

HTTP

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 do agendamento de recorrência.
DaysOfWeek	Os dias da semana do agendamento de recorrência.
ErrorModel	O modelo de erro.
ErrorResponseModel	O modelo de resposta de erro.
RecurrenceSchedule	Agenda 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 de recorrência do gatilho.
TriggerProperties	Detalhes de propriedades do gatilho.
TriggerRecurrence	A recorrência do gatilho.
TriggerState	O estado do gatilho.

DayOfWeek

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

Nome	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

DaysOfWeek

Os dias da semana do agendamento de recorrência.

Nome	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorModel

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 do 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

O modelo de resposta de erro.

Nome	Tipo	Description
error	ErrorModel	O modelo de erro.

RecurrenceSchedule

Agenda de recorrência.

Nome	Tipo	Description
hours	integer[]	As horas de agendamento de recorrência.
minutes	integer[]	Os minutos de agendamento de recorrência.
monthDays	integer[]	Dias do mês de agendamento de recorrência.
monthlyOccurrences	RecurrenceScheduleOccurrence[]	As ocorrências mensais do agendamento de recorrência.
weekDays	DaysOfWeek[]	Os dias da semana do agendamento de recorrência.

RecurrenceScheduleOccurrence

A ocorrência de agendamento de recorrência.

Nome	Tipo	Description
day	DayOfWeek	O dia da ocorrência do agendamento de recorrência.
occurrence	integer

ScanLevelType

Tipo de nível de verificação.

Nome	Tipo	Description
Full	string	a verificação está completa
Incremental	string	a verificação é incremental

Trigger

O objeto de gatilho.

Nome	Tipo	Description
id	string	O identificador do 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

A frequência de recorrência do gatilho.

Nome	Tipo	Description
Day	string
Hour	string
Month	string
Week	string

TriggerProperties

Detalhes de propriedades do gatilho.

Nome	Tipo	Valor padrão	Description
createdAt	string		A hora de criação do gatilho.
incrementalScanStartTime	string		A hora de início da verificação incremental do gatilho.
lastModifiedAt	string		A hora da última modificação do gatilho.
lastScheduled	string		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

A recorrência do gatilho.

Nome	Tipo	Description
endTime	string	A hora de término da recorrência do gatilho.
frequency	TriggerFrequency	A frequência de recorrência do gatilho.
interval	integer	O intervalo de recorrência do gatilho.
schedule	RecurrenceSchedule	O agendamento da recorrência do gatilho.
startTime	string	A hora de início da recorrência do gatilho.
timeZone	string	O fuso horário da recorrência do gatilho.

TriggerState

O estado do gatilho.

Nome	Tipo	Description
Disabled	string
Enabled	string