CodelessConnectorPollingConfigProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Config to describe the polling config for API poller connector
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.CodelessConnectorPollingConfigPropertiesTypeConverter))]
public class CodelessConnectorPollingConfigProperties : Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ICodelessConnectorPollingConfigProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.CodelessConnectorPollingConfigPropertiesTypeConverter))>]
type CodelessConnectorPollingConfigProperties = class
interface ICodelessConnectorPollingConfigProperties
interface IJsonSerializable
Public Class CodelessConnectorPollingConfigProperties
Implements ICodelessConnectorPollingConfigProperties
- Inheritance
-
CodelessConnectorPollingConfigProperties
- Attributes
- Implements
Constructors
CodelessConnectorPollingConfigProperties() |
Creates an new CodelessConnectorPollingConfigProperties instance. |
Properties
AuthApiKeyIdentifier |
A prefix send in the header before the actual token |
AuthApiKeyName |
The header name which the token is sent with |
AuthAuthorizationEndpoint |
The endpoint used to authorize the user, used in Oauth 2.0 flow |
AuthAuthorizationEndpointQueryParameter |
The query parameters used in authorization request, used in Oauth 2.0 flow |
AuthFlowName |
Describes the flow name, for example 'AuthCode' for Oauth 2.0 |
AuthIsApiKeyInPostPayload |
Marks if the key should sent in header |
AuthIsClientSecretInHeader |
Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow |
AuthRedirectionEndpoint |
The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow |
AuthScope |
The OAuth token scope |
AuthTokenEndpoint |
The endpoint used to issue a token, used in Oauth 2.0 flow |
AuthTokenEndpointHeader |
The query headers used in token request, used in Oauth 2.0 flow |
AuthTokenEndpointQueryParameter |
The query parameters used in token request, used in Oauth 2.0 flow |
AuthType |
The authentication type |
IsActive |
The poller active status |
PagingNextPageParaName |
Defines the name of a next page attribute |
PagingNextPageTokenJsonPath |
Defines the path to a next page token JSON |
PagingPageCountAttributePath |
Defines the path to a page count attribute |
PagingPageSize |
Defines the paging size |
PagingPageSizeParaName |
Defines the name of the page size parameter |
PagingPageTimeStampAttributePath |
Defines the path to a paging time stamp attribute |
PagingPageTotalCountAttributePath |
Defines the path to a page total count attribute |
PagingSearchTheLatestTimeStampFromEventsList |
Determines whether to search for the latest time stamp in the events list |
PagingType |
Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp' |
RequestApiEndpoint |
Describe the endpoint we should pull the data from |
RequestEndTimeAttributeName |
This will be used the query events from the end of the time window |
RequestHeader |
Describe the headers sent in the poll request |
RequestHttpMethod |
The http method type we will use in the poll request, GET or POST |
RequestQueryParameter |
Describe the query parameters sent in the poll request |
RequestQueryParametersTemplate |
For advanced scenarios for example user name/password embedded in nested JSON payload |
RequestQueryTimeFormat |
The time format will be used the query events in a specific window |
RequestQueryWindowInMin |
The window interval we will use the pull the data |
RequestRateLimitQp |
Defines the rate limit QPS |
RequestRetryCount |
Describe the amount of time we should try and poll the data in case of failure |
RequestStartTimeAttributeName |
This will be used the query events from a start of the time window |
RequestTimeoutInSecond |
The number of seconds we will consider as a request timeout |
ResponseEventsJsonPath |
Describes the path we should extract the data in the response |
ResponseIsGzipCompressed |
Describes if the data in the response is Gzip |
ResponseSuccessStatusJsonPath |
Describes the path we should extract the status code in the response |
ResponseSuccessStatusValue |
Describes the path we should extract the status value in the response |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of CodelessConnectorPollingConfigProperties. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of CodelessConnectorPollingConfigProperties. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ICodelessConnectorPollingConfigProperties. |
FromJsonString(String) |
Creates a new instance of CodelessConnectorPollingConfigProperties, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of CodelessConnectorPollingConfigProperties into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |