Partilhar via

RoutingStorageContainerProperties interface

  • Reference
Package:
@azure/arm-iothub

The properties related to a storage container endpoint.

Properties

authenticationType

Method used to authenticate against the storage endpoint
batchFrequencyInSeconds

Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
connectionString

The connection string of the storage account.
containerName

The name of storage container in the storage account.
encoding

Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.
endpointUri

The url of the storage endpoint. It must include the protocol https://
fileNameFormat

File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
id

Id of the storage container endpoint
identity

Managed identity properties of routing storage endpoint.
maxChunkSizeInBytes

Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
name

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
resourceGroup

The name of the resource group of the storage account.
subscriptionId

The subscription identifier of the storage account.

Property Details

authenticationType

Method used to authenticate against the storage endpoint

authenticationType?: string

Property Value

string

batchFrequencyInSeconds

Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.

batchFrequencyInSeconds?: number

Property Value

number

connectionString

The connection string of the storage account.

connectionString?: string

Property Value

string

containerName

The name of storage container in the storage account.

containerName: string

Property Value

string

encoding

Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.

encoding?: string

Property Value

string

endpointUri

The url of the storage endpoint. It must include the protocol https://

endpointUri?: string

Property Value

string

fileNameFormat

File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

fileNameFormat?: string

Property Value

string

id

Id of the storage container endpoint

id?: string

Property Value

string

identity

Managed identity properties of routing storage endpoint.

identity?: ManagedIdentity

Property Value

ManagedIdentity

maxChunkSizeInBytes

Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).

maxChunkSizeInBytes?: number

Property Value

number

name

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

name: string

Property Value

string

resourceGroup

The name of the resource group of the storage account.

resourceGroup?: string

Property Value

string

subscriptionId

The subscription identifier of the storage account.

subscriptionId?: string

Property Value

string