RestApiPollerDataConnector interface

Represents Rest Api Poller data connector.

Extends

Properties

addOnAttributes

The add on attributes. The key name will become attribute name (a column) and the value will become the attribute value in the payload.

auth

The a authentication model.

connectorDefinitionName

The connector definition name (the dataConnectorDefinition resource id).

dataType

The Log Analytics table destination.

dcrConfig

The DCR related properties.

isActive

Indicates whether the connector is active or not.

kind

The data connector kind

paging

The paging configuration.

request

The request configuration.

response

The response configuration.

Inherited Properties

etag

Etag of the azure resource

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

addOnAttributes

The add on attributes. The key name will become attribute name (a column) and the value will become the attribute value in the payload.

addOnAttributes?: Record<string, string>

Property Value

Record<string, string>

auth

The a authentication model.

auth?: CcpAuthConfigUnion

Property Value

connectorDefinitionName

The connector definition name (the dataConnectorDefinition resource id).

connectorDefinitionName?: string

Property Value

string

dataType

The Log Analytics table destination.

dataType?: string

Property Value

string

dcrConfig

The DCR related properties.

dcrConfig?: DCRConfiguration

Property Value

isActive

Indicates whether the connector is active or not.

isActive?: boolean

Property Value

boolean

kind

The data connector kind

kind: "RestApiPoller"

Property Value

"RestApiPoller"

paging

The paging configuration.

paging?: RestApiPollerRequestPagingConfig

Property Value

request

The request configuration.

request?: RestApiPollerRequestConfig

Property Value

response

The response configuration.

response?: CcpResponseConfig

Property Value

Inherited Property Details

etag

Etag of the azure resource

etag?: string

Property Value

string

Inherited From DataConnector.etag

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From DataConnector.id

name

The name of the resource

name?: string

Property Value

string

Inherited From DataConnector.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From DataConnector.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From DataConnector.type