EventGridDataConnection interface
Class representing an Event Grid data connection.
- Extends
Properties
blob |
The name of blob storage event type to process. |
consumer |
The event hub consumer group. |
database |
Indication for database routing information from the data connection, by default only database routing information is allowed |
data |
The data format of the message. Optionally the data format can be added to each message. |
event |
The resource ID of the event grid that is subscribed to the storage account events. |
event |
The resource ID where the event grid is configured to send events. |
ignore |
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 |
managed |
The object ID of managedIdentityResourceId NOTE: This property will not be serialized. It can only be populated by the server. |
managed |
The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account. |
mapping |
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. |
provisioning |
The provisioned state of the resource. NOTE: This property will not be serialized. It can only be populated by the server. |
storage |
The resource ID of the storage account where the data resides. |
table |
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. |
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
databaseRouting
Indication for database routing information from the data connection, by default only database routing information is allowed
databaseRouting?: 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
eventGridResourceId
The resource ID of the event grid that is subscribed to the storage account events.
eventGridResourceId?: 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"
managedIdentityObjectId
The object ID of managedIdentityResourceId NOTE: This property will not be serialized. It can only be populated by the server.
managedIdentityObjectId?: string
Property Value
string
managedIdentityResourceId
The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account.
managedIdentityResourceId?: string
Property Value
string
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
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
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