RestApiPollerRequestConfig interface

Pacchetto:

@azure/arm-securityinsight

Configurazione della richiesta.

Proprietà

apiEndpoint	Endpoint API.
endTimeAttributeName	Nome del parametro di query che il server remoto prevede di terminare la query. Questa proprietà va a portata di mano con startTimeAttributeName
headers	Intestazione per la richiesta per il server remoto.
httpMethod	Metodo HTTP, valore predefinito GET.
isPostPayloadJson	Flag per indicare se il payload HTTP POST è in formato JSON (vs form-urlencoded).
queryParameters	Parametri di query HTTP per l'API RESTful.
queryParametersTemplate	modello di parametri di query. Definisce il modello di parametri di query da utilizzare per il passaggio di parametri di query in scenari avanzati.
queryTimeFormat	Formato dell'ora della query. Un server remoto può avere una query per eseguire il pull dei dati dall'intervallo 'start' a 'end'. Questa proprietà indica il formato dell'ora prevista che il server remoto sa analizzare.
queryTimeIntervalAttributeName	Nome del parametro di query che è necessario inviare al server per i log di query in intervallo di tempo. Deve essere definito con queryTimeIntervalPrepend e queryTimeIntervalDelimiter
queryTimeIntervalDelimiter	Stringa delimitatore tra 2 QueryTimeFormat nel parametro di query queryTimeIntervalAttributeName.
queryTimeIntervalPrepend	La stringa antepone al valore del parametro di query in queryTimeIntervalAttributeName.
queryWindowInMin	Finestra della query in minuti per la richiesta.
rateLimitQPS	Query relative al limite di velocità al secondo per la richiesta.
retryCount	Numero di tentativi.
startTimeAttributeName	Nome del parametro di query previsto dal server remoto per avviare la query. Questa proprietà va a portata di mano con endTimeAttributeName.
timeoutInSeconds	Timeout in secondi.

Dettagli proprietà

apiEndpoint

Endpoint API.

apiEndpoint: string

Valore della proprietà

string

endTimeAttributeName

Nome del parametro di query che il server remoto prevede di terminare la query. Questa proprietà va a portata di mano con startTimeAttributeName

endTimeAttributeName?: string

Valore della proprietà

string

headers

Intestazione per la richiesta per il server remoto.

headers?: Record<string, string>

Valore della proprietà

Record<string, string>

httpMethod

Metodo HTTP, valore predefinito GET.

httpMethod?: string

Valore della proprietà

string

isPostPayloadJson

Flag per indicare se il payload HTTP POST è in formato JSON (vs form-urlencoded).

isPostPayloadJson?: boolean

Valore della proprietà

boolean

queryParameters

Parametri di query HTTP per l'API RESTful.

queryParameters?: Record<string, any>

Valore della proprietà

Record<string, any>

queryParametersTemplate

modello di parametri di query. Definisce il modello di parametri di query da utilizzare per il passaggio di parametri di query in scenari avanzati.

queryParametersTemplate?: string

Valore della proprietà

string

queryTimeFormat

Formato dell'ora della query. Un server remoto può avere una query per eseguire il pull dei dati dall'intervallo 'start' a 'end'. Questa proprietà indica il formato dell'ora prevista che il server remoto sa analizzare.

queryTimeFormat?: string

Valore della proprietà

string

queryTimeIntervalAttributeName

Nome del parametro di query che è necessario inviare al server per i log di query in intervallo di tempo. Deve essere definito con queryTimeIntervalPrepend e queryTimeIntervalDelimiter

queryTimeIntervalAttributeName?: string

Valore della proprietà

string

queryTimeIntervalDelimiter

Stringa delimitatore tra 2 QueryTimeFormat nel parametro di query queryTimeIntervalAttributeName.

queryTimeIntervalDelimiter?: string

Valore della proprietà

string

queryTimeIntervalPrepend

La stringa antepone al valore del parametro di query in queryTimeIntervalAttributeName.

queryTimeIntervalPrepend?: string

Valore della proprietà

string

queryWindowInMin

Finestra della query in minuti per la richiesta.

queryWindowInMin?: number

Valore della proprietà

number

rateLimitQPS

Query relative al limite di velocità al secondo per la richiesta.

rateLimitQPS?: number

Valore della proprietà

number

retryCount

Numero di tentativi.

retryCount?: number

Valore della proprietà

number

startTimeAttributeName

Nome del parametro di query previsto dal server remoto per avviare la query. Questa proprietà va a portata di mano con endTimeAttributeName.

startTimeAttributeName?: string

Valore della proprietà

string

timeoutInSeconds

Timeout in secondi.

timeoutInSeconds?: number

Valore della proprietà

number