CcpResponseConfig interface

Package:

@azure/arm-securityinsight

A custom response configuration for a rule.

Properties

compressionAlgo	The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.
convertChildPropertiesToArray	The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.
csvDelimiter	The csv delimiter, in case the response format is CSV.
csvEscape	The character used to escape characters in CSV.
eventsJsonPaths	The json paths, '$' char is the json root.
format	The response format. possible values are json,csv,xml
hasCsvBoundary	The value indicating whether the response has CSV boundary in case the response in CSV format.
hasCsvHeader	The value indicating whether the response has headers in case the response in CSV format.
isGzipCompressed	The value indicating whether the remote server support Gzip and we should expect Gzip response.
successStatusJsonPath	The value where the status message/code should appear in the response.
successStatusValue	The status value.

Property Details

compressionAlgo

The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.

compressionAlgo?: string

Property Value

string

convertChildPropertiesToArray

The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.

convertChildPropertiesToArray?: boolean

Property Value

boolean

csvDelimiter

The csv delimiter, in case the response format is CSV.

csvDelimiter?: string

Property Value

string

csvEscape

The character used to escape characters in CSV.

csvEscape?: string

Property Value

string

eventsJsonPaths

The json paths, '$' char is the json root.

eventsJsonPaths: string[]

Property Value

string[]

format

The response format. possible values are json,csv,xml

format?: string

Property Value

string

hasCsvBoundary

The value indicating whether the response has CSV boundary in case the response in CSV format.

hasCsvBoundary?: boolean

Property Value

boolean

hasCsvHeader

The value indicating whether the response has headers in case the response in CSV format.

hasCsvHeader?: boolean

Property Value

boolean

isGzipCompressed

The value indicating whether the remote server support Gzip and we should expect Gzip response.

isGzipCompressed?: boolean

Property Value

boolean

successStatusJsonPath

The value where the status message/code should appear in the response.

successStatusJsonPath?: string

Property Value

string

successStatusValue

The status value.

successStatusValue?: string

Property Value

string