RestApiPollerRequestConfig Class

Definition

The request configuration.

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

Constructors

RestApiPollerRequestConfig(String)

Initializes a new instance of RestApiPollerRequestConfig.

Properties

ApiEndpoint

The API endpoint.

EndTimeAttributeName

The query parameter name which the remote server expect to end query. This property goes hand to hand with startTimeAttributeName.

Headers

The header for the request for the remote server.

HttpMethod

The HTTP method, default value GET.

IsPostPayloadJson

Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded).

QueryParameters

The HTTP query parameters to RESTful API.

To assign an object to the value of 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

the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios.

QueryTimeFormat

The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse.

QueryTimeIntervalAttributeName

The query parameter name which we need to send the server for query logs in time interval. Should be defined with queryTimeIntervalPrepend and queryTimeIntervalDelimiter.

QueryTimeIntervalDelimiter

The delimiter string between 2 QueryTimeFormat in the query parameter queryTimeIntervalAttributeName.

QueryTimeIntervalPrepend

The string prepend to the value of the query parameter in queryTimeIntervalAttributeName.

QueryWindowInMin

The query window in minutes for the request.

RateLimitQPS

The Rate limit queries per second for the request..

RetryCount

The retry count.

StartTimeAttributeName

The query parameter name which the remote server expect to start query. This property goes hand to hand with endTimeAttributeName.

TimeoutInSeconds

The timeout in seconds.

Explicit Interface Implementations

IJsonModel<RestApiPollerRequestConfig>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<RestApiPollerRequestConfig>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<RestApiPollerRequestConfig>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<RestApiPollerRequestConfig>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<RestApiPollerRequestConfig>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to