ApiPollingParameters Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview

Assembly:

Az.SecurityInsights.private.dll

Represents Codeless API Polling data connector

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ApiPollingParametersTypeConverter))]
public class ApiPollingParameters : Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IApiPollingParameters

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.ApiPollingParametersTypeConverter))>]
type ApiPollingParameters = class
    interface IApiPollingParameters
    interface IJsonSerializable

Public Class ApiPollingParameters
Implements IApiPollingParameters

Inheritance

Object

ApiPollingParameters

Attributes

TypeConverterAttribute

Implements

IApiPollingParameters IJsonSerializable

Constructors

ApiPollingParameters()

Creates an new ApiPollingParameters 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
AvailabilityIsPreview	Set connector as preview
AvailabilityStatus	The connector Availability Status
ConnectorUiConfigConnectivityCriterion	Define the way the connector check connectivity
ConnectorUiConfigCustomImage	An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery
ConnectorUiConfigDataType	Data types to check for last data received
ConnectorUiConfigDescriptionMarkdown	Connector description
ConnectorUiConfigGraphQueriesTableName	Name of the table the connector will insert the data to
ConnectorUiConfigGraphQuery	The graph query to show the current data status
ConnectorUiConfigInstructionStep	Instruction steps to enable the connector
ConnectorUiConfigPublisher	Connector publisher name
ConnectorUiConfigSampleQuery	The sample queries for the connector
ConnectorUiConfigTitle	Connector blade title
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'
PermissionCustom	Customs permissions required for the connector
PermissionResourceProvider	Resource provider permissions required for the connector
PollingConfigIsActive	The poller active status
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 ApiPollingParameters.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of ApiPollingParameters.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.SecurityInsights.Models.Api20210901Preview.IApiPollingParameters.
FromJsonString(String)	Creates a new instance of ApiPollingParameters, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of ApiPollingParameters into a JsonNode.
ToJsonString()	Serializes this instance to a json string.