RestApiPollerRequestConfig interface

Package:

@azure/arm-securityinsight

The request configuration.

Properties

apiEndpoint	The API endpoint.
endTimeAttributeName	The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName
headers	The header for the request for the remote server.
httpMethod	The HTTP method, default value GET.
isPostPayloadJson	Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).
queryParameters	The HTTP query parameters to RESTful API.
queryParametersTemplate	the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.
queryTimeFormat	The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.
queryTimeIntervalAttributeName	The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter
queryTimeIntervalDelimiter	The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.
queryTimeIntervalPrepend	The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.
queryWindowInMin	The query window in minutes for the request.
rateLimitQPS	The Rate limit queries per second for the request..
retryCount	The retry count.
startTimeAttributeName	The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.
timeoutInSeconds	The timeout in seconds.

Property Details

apiEndpoint

The API endpoint.

apiEndpoint: string

Property Value

string

endTimeAttributeName

The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName

endTimeAttributeName?: string

Property Value

string

headers

The header for the request for the remote server.

headers?: Record<string, string>

Property Value

Record<string, string>

httpMethod

The HTTP method, default value GET.

httpMethod?: string

Property Value

string

isPostPayloadJson

Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).

isPostPayloadJson?: boolean

Property Value

boolean

queryParameters

The HTTP query parameters to RESTful API.

queryParameters?: Record<string, any>

Property Value

Record<string, any>

queryParametersTemplate

the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.

queryParametersTemplate?: string

Property Value

string

queryTimeFormat

The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.

queryTimeFormat?: string

Property Value

string

queryTimeIntervalAttributeName

The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter

queryTimeIntervalAttributeName?: string

Property Value

string

queryTimeIntervalDelimiter

The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.

queryTimeIntervalDelimiter?: string

Property Value

string

queryTimeIntervalPrepend

The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.

queryTimeIntervalPrepend?: string

Property Value

string

queryWindowInMin

The query window in minutes for the request.

queryWindowInMin?: number

Property Value

number

rateLimitQPS

The Rate limit queries per second for the request..

rateLimitQPS?: number

Property Value

number

retryCount

The retry count.

retryCount?: number

Property Value

number

startTimeAttributeName

The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.

startTimeAttributeName?: string

Property Value

string

timeoutInSeconds

The timeout in seconds.

timeoutInSeconds?: number

Property Value

number