RestApiPollerRequestConfig interface

Paket:

@azure/arm-securityinsight

Die Anforderungskonfiguration.

Eigenschaften

apiEndpoint	Der API-Endpunkt.
endTimeAttributeName	Der Abfrageparametername, den der Remoteserver erwartet, um die Abfrage zu beenden. Diese Eigenschaft wird handhändig mit startTimeAttributeName
headers	Der Header für die Anforderung für den Remoteserver.
httpMethod	Die HTTP-Methode, Standardwert GET.
isPostPayloadJson	Flag, das angibt, ob die HTTP POST-Nutzlast im JSON-Format (vs form-urlencoded) ist.
queryParameters	Die HTTP-Abfrageparameter für DIE RESTful-API.
queryParametersTemplate	die Abfrageparametervorlage. Definiert die Abfrageparametervorlage, die beim Übergeben von Abfrageparametern in erweiterten Szenarien verwendet werden soll.
queryTimeFormat	Das Abfragezeitformat. Ein Remoteserver kann über eine Abfrage verfügen, um Daten aus dem Bereich "Start" bis "Ende" abzurufen. Diese Eigenschaft gibt an, was das erwartete Zeitformat ist, das der Remoteserver analysiert.
queryTimeIntervalAttributeName	Der Name des Abfrageparameters, den wir für Abfrageprotokolle im Zeitintervall senden müssen. Sollte mit queryTimeIntervalPrepend und queryTimeIntervalDelimiter definiert werden
queryTimeIntervalDelimiter	Die Trennzeichenzeichenfolge zwischen 2 QueryTimeFormat im Abfrageparameter queryTimeIntervalAttributeName.
queryTimeIntervalPrepend	Die Zeichenfolge wird dem Wert des Abfrageparameters in queryTimeIntervalAttributeNamevorangestellt.
queryWindowInMin	Das Abfragefenster in Minuten für die Anforderung.
rateLimitQPS	Die Ratelimitabfragen pro Sekunde für die Anforderung..
retryCount	Die Wiederholungsanzahl.
startTimeAttributeName	Der Abfrageparametername, den der Remoteserver erwartet, um die Abfrage zu starten. Diese Eigenschaft geht hand in Hand mit endTimeAttributeName.
timeoutInSeconds	Das Timeout in Sekunden.

Details zur Eigenschaft

apiEndpoint

Der API-Endpunkt.

apiEndpoint: string

Eigenschaftswert

string

endTimeAttributeName

Der Abfrageparametername, den der Remoteserver erwartet, um die Abfrage zu beenden. Diese Eigenschaft wird handhändig mit startTimeAttributeName

endTimeAttributeName?: string

Eigenschaftswert

string

headers

Der Header für die Anforderung für den Remoteserver.

headers?: Record<string, string>

Eigenschaftswert

Record<string, string>

httpMethod

Die HTTP-Methode, Standardwert GET.

httpMethod?: string

Eigenschaftswert

string

isPostPayloadJson

Flag, das angibt, ob die HTTP POST-Nutzlast im JSON-Format (vs form-urlencoded) ist.

isPostPayloadJson?: boolean

Eigenschaftswert

boolean

queryParameters

Die HTTP-Abfrageparameter für DIE RESTful-API.

queryParameters?: Record<string, any>

Eigenschaftswert

Record<string, any>

queryParametersTemplate

die Abfrageparametervorlage. Definiert die Abfrageparametervorlage, die beim Übergeben von Abfrageparametern in erweiterten Szenarien verwendet werden soll.

queryParametersTemplate?: string

Eigenschaftswert

string

queryTimeFormat

Das Abfragezeitformat. Ein Remoteserver kann über eine Abfrage verfügen, um Daten aus dem Bereich "Start" bis "Ende" abzurufen. Diese Eigenschaft gibt an, was das erwartete Zeitformat ist, das der Remoteserver analysiert.

queryTimeFormat?: string

Eigenschaftswert

string

queryTimeIntervalAttributeName

Der Name des Abfrageparameters, den wir für Abfrageprotokolle im Zeitintervall senden müssen. Sollte mit queryTimeIntervalPrepend und queryTimeIntervalDelimiter definiert werden

queryTimeIntervalAttributeName?: string

Eigenschaftswert

string

queryTimeIntervalDelimiter

Die Trennzeichenzeichenfolge zwischen 2 QueryTimeFormat im Abfrageparameter queryTimeIntervalAttributeName.

queryTimeIntervalDelimiter?: string

Eigenschaftswert

string

queryTimeIntervalPrepend

Die Zeichenfolge wird dem Wert des Abfrageparameters in queryTimeIntervalAttributeNamevorangestellt.

queryTimeIntervalPrepend?: string

Eigenschaftswert

string

queryWindowInMin

Das Abfragefenster in Minuten für die Anforderung.

queryWindowInMin?: number

Eigenschaftswert

number

rateLimitQPS

Die Ratelimitabfragen pro Sekunde für die Anforderung..

rateLimitQPS?: number

Eigenschaftswert

number

retryCount

Die Wiederholungsanzahl.

retryCount?: number

Eigenschaftswert

number

startTimeAttributeName

Der Abfrageparametername, den der Remoteserver erwartet, um die Abfrage zu starten. Diese Eigenschaft geht hand in Hand mit endTimeAttributeName.

startTimeAttributeName?: string

Eigenschaftswert

string

timeoutInSeconds

Das Timeout in Sekunden.

timeoutInSeconds?: number

Eigenschaftswert

number