CodelessConnectorPollingRequestProperties interface

Package:

@azure/arm-securityinsight

Describe the request properties needed to successfully pull from the server

Properties

apiEndpoint	Describe the endpoint we should pull the data from
endTimeAttributeName	This will be used the query events from the end of the time window
headers	Describe the headers sent in the poll request
httpMethod	The http method type we will use in the poll request, GET or POST
queryParameters	Describe the query parameters sent in the poll request
queryParametersTemplate	For advanced scenarios for example user name/password embedded in nested JSON payload
queryTimeFormat	The time format will be used the query events in a specific window
queryWindowInMin	The window interval we will use the pull the data
rateLimitQps	Defines the rate limit QPS
retryCount	Describe the amount of time we should try and poll the data in case of failure
startTimeAttributeName	This will be used the query events from a start of the time window
timeoutInSeconds	The number of seconds we will consider as a request timeout

Property Details

apiEndpoint

Describe the endpoint we should pull the data from

apiEndpoint: string

Property Value

string

endTimeAttributeName

This will be used the query events from the end of the time window

endTimeAttributeName?: string

Property Value

string

headers

Describe the headers sent in the poll request

headers?: Record<string, unknown>

Property Value

Record<string, unknown>

httpMethod

The http method type we will use in the poll request, GET or POST

httpMethod: string

Property Value

string

queryParameters

Describe the query parameters sent in the poll request

queryParameters?: Record<string, unknown>

Property Value

Record<string, unknown>

queryParametersTemplate

For advanced scenarios for example user name/password embedded in nested JSON payload

queryParametersTemplate?: string

Property Value

string

queryTimeFormat

The time format will be used the query events in a specific window

queryTimeFormat: string

Property Value

string

queryWindowInMin

The window interval we will use the pull the data

queryWindowInMin: number

Property Value

number

rateLimitQps

Defines the rate limit QPS

rateLimitQps?: number

Property Value

number

retryCount

Describe the amount of time we should try and poll the data in case of failure

retryCount?: number

Property Value

number

startTimeAttributeName

This will be used the query events from a start of the time window

startTimeAttributeName?: string

Property Value

string

timeoutInSeconds

The number of seconds we will consider as a request timeout

timeoutInSeconds?: number

Property Value

number