RestApiPollerRequestConfig interface

Paquet:

@azure/arm-securityinsight

Configuration de la demande.

Propriétés

apiEndpoint	Point de terminaison de l’API.
endTimeAttributeName	Nom du paramètre de requête que le serveur distant s’attend à mettre fin à la requête. Cette propriété va de pair avec startTimeAttributeName
headers	En-tête de la demande pour le serveur distant.
httpMethod	Méthode HTTP, valeur par défaut GET.
isPostPayloadJson	Indicateur pour indiquer si la charge utile HTTP POST est au format JSON (vs form-urlencoded).
queryParameters	Paramètres de requête HTTP de l’API RESTful.
queryParametersTemplate	modèle de paramètres de requête. Définit le modèle de paramètres de requête à utiliser lors du passage des paramètres de requête dans des scénarios avancés.
queryTimeFormat	Format d’heure de la requête. Un serveur distant peut avoir une requête pour extraire des données de la plage « start » à « end ». Cette propriété indique le format de temps attendu que le serveur distant sait analyser.
queryTimeIntervalAttributeName	Nom du paramètre de requête que nous devons envoyer au serveur pour les journaux de requête dans un intervalle de temps. Doit être défini avec queryTimeIntervalPrepend et queryTimeIntervalDelimiter
queryTimeIntervalDelimiter	Chaîne de délimiteur comprise entre 2 QueryTimeFormat dans le paramètre de requête queryTimeIntervalAttributeName.
queryTimeIntervalPrepend	Chaîne ajoutée à la valeur du paramètre de requête dans queryTimeIntervalAttributeName.
queryWindowInMin	Fenêtre de requête en minutes pour la requête.
rateLimitQPS	Nombre maximal de requêtes par seconde pour la requête..
retryCount	Nombre de nouvelles tentatives.
startTimeAttributeName	Nom du paramètre de requête que le serveur distant s’attend à démarrer la requête. Cette propriété va de pair avec endTimeAttributeName.
timeoutInSeconds	Délai d’expiration en secondes.

Détails de la propriété

apiEndpoint

Point de terminaison de l’API.

apiEndpoint: string

Valeur de propriété

string

endTimeAttributeName

Nom du paramètre de requête que le serveur distant s’attend à mettre fin à la requête. Cette propriété va de pair avec startTimeAttributeName

endTimeAttributeName?: string

Valeur de propriété

string

headers

En-tête de la demande pour le serveur distant.

headers?: Record<string, string>

Valeur de propriété

Record<string, string>

httpMethod

Méthode HTTP, valeur par défaut GET.

httpMethod?: string

Valeur de propriété

string

isPostPayloadJson

Indicateur pour indiquer si la charge utile HTTP POST est au format JSON (vs form-urlencoded).

isPostPayloadJson?: boolean

Valeur de propriété

boolean

queryParameters

Paramètres de requête HTTP de l’API RESTful.

queryParameters?: Record<string, any>

Valeur de propriété

Record<string, any>

queryParametersTemplate

modèle de paramètres de requête. Définit le modèle de paramètres de requête à utiliser lors du passage des paramètres de requête dans des scénarios avancés.

queryParametersTemplate?: string

Valeur de propriété

string

queryTimeFormat

Format d’heure de la requête. Un serveur distant peut avoir une requête pour extraire des données de la plage « start » à « end ». Cette propriété indique le format de temps attendu que le serveur distant sait analyser.

queryTimeFormat?: string

Valeur de propriété

string

queryTimeIntervalAttributeName

Nom du paramètre de requête que nous devons envoyer au serveur pour les journaux de requête dans un intervalle de temps. Doit être défini avec queryTimeIntervalPrepend et queryTimeIntervalDelimiter

queryTimeIntervalAttributeName?: string

Valeur de propriété

string

queryTimeIntervalDelimiter

Chaîne de délimiteur comprise entre 2 QueryTimeFormat dans le paramètre de requête queryTimeIntervalAttributeName.

queryTimeIntervalDelimiter?: string

Valeur de propriété

string

queryTimeIntervalPrepend

Chaîne ajoutée à la valeur du paramètre de requête dans queryTimeIntervalAttributeName.

queryTimeIntervalPrepend?: string

Valeur de propriété

string

queryWindowInMin

Fenêtre de requête en minutes pour la requête.

queryWindowInMin?: number

Valeur de propriété

number

rateLimitQPS

Nombre maximal de requêtes par seconde pour la requête..

rateLimitQPS?: number

Valeur de propriété

number

retryCount

Nombre de nouvelles tentatives.

retryCount?: number

Valeur de propriété

number

startTimeAttributeName

Nom du paramètre de requête que le serveur distant s’attend à démarrer la requête. Cette propriété va de pair avec endTimeAttributeName.

startTimeAttributeName?: string

Valeur de propriété

string

timeoutInSeconds

Délai d’expiration en secondes.

timeoutInSeconds?: number

Valeur de propriété

number