Share via

EventGridDataConnection interface

  • Reference
Package:
@azure/arm-synapse

Class representing an Event Grid data connection.

Extends
DataConnection

Properties

blobStorageEventType

The name of blob storage event type to process.
consumerGroup

The event hub consumer group.
dataFormat

The data format of the message. Optionally the data format can be added to each message.
eventHubResourceId

The resource ID where the event grid is configured to send events.
ignoreFirstRecord

A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file
kind

Polymorphic discriminator, which specifies the different types this object can be
mappingRuleName

The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
provisioningState

The provisioned state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
storageAccountResourceId

The resource ID of the storage account where the data resides.
tableName

The table where the data should be ingested. Optionally the table information can be added to each message.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

blobStorageEventType

The name of blob storage event type to process.

blobStorageEventType?: string

Property Value

string

consumerGroup

The event hub consumer group.

consumerGroup?: string

Property Value

string

dataFormat

The data format of the message. Optionally the data format can be added to each message.

dataFormat?: string

Property Value

string

eventHubResourceId

The resource ID where the event grid is configured to send events.

eventHubResourceId?: string

Property Value

string

ignoreFirstRecord

A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file

ignoreFirstRecord?: boolean

Property Value

boolean

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "EventGrid"

Property Value

"EventGrid"

mappingRuleName

The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.

mappingRuleName?: string

Property Value

string

provisioningState

The provisioned state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

storageAccountResourceId

The resource ID of the storage account where the data resides.

storageAccountResourceId?: string

Property Value

string

tableName

The table where the data should be ingested. Optionally the table information can be added to each message.

tableName?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From DataConnection.id

location

Resource location.

location?: string

Property Value

string

Inherited From DataConnection.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From DataConnection.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From DataConnection.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From DataConnection.type