Partager via


CodelessConnectorPollingRequestProperties Class

Definition

Describe the request properties needed to successfully pull from the server.

public class CodelessConnectorPollingRequestProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.SecurityInsights.Models.CodelessConnectorPollingRequestProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.SecurityInsights.Models.CodelessConnectorPollingRequestProperties>
type CodelessConnectorPollingRequestProperties = class
    interface IJsonModel<CodelessConnectorPollingRequestProperties>
    interface IPersistableModel<CodelessConnectorPollingRequestProperties>
Public Class CodelessConnectorPollingRequestProperties
Implements IJsonModel(Of CodelessConnectorPollingRequestProperties), IPersistableModel(Of CodelessConnectorPollingRequestProperties)
Inheritance
CodelessConnectorPollingRequestProperties
Implements

Constructors

CodelessConnectorPollingRequestProperties(String, Int32, String, String)

Initializes a new instance of CodelessConnectorPollingRequestProperties.

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

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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.

Explicit Interface Implementations

IJsonModel<CodelessConnectorPollingRequestProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CodelessConnectorPollingRequestProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CodelessConnectorPollingRequestProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CodelessConnectorPollingRequestProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CodelessConnectorPollingRequestProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to