RoutingStorageContainerProperties interface
The properties related to a storage container endpoint.
Properties
| authentication |
Method used to authenticate against the storage endpoint |
| batch |
Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. |
| connection |
The connection string of the storage account. |
| container |
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'. |
| endpoint |
The url of the storage endpoint. It must include the protocol https:// |
| file |
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. |
| max |
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. |
| resource |
The name of the resource group of the storage account. |
| subscription |
The subscription identifier of the storage account. |
Property Details
authenticationType
Method used to authenticate against the storage endpoint
authenticationType?: stringProperty 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?: numberProperty Value
number
connectionString
The connection string of the storage account.
connectionString?: stringProperty Value
string
containerName
The name of storage container in the storage account.
containerName: stringProperty Value
string
encoding
Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.
encoding?: stringProperty Value
string
endpointUri
The url of the storage endpoint. It must include the protocol https://
endpointUri?: stringProperty 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?: stringProperty Value
string
id
Id of the storage container endpoint
id?: stringProperty Value
string
identity
Managed identity properties of routing storage endpoint.
identity?: ManagedIdentityProperty Value
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?: numberProperty 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: stringProperty Value
string
resourceGroup
The name of the resource group of the storage account.
resourceGroup?: stringProperty Value
string
subscriptionId
The subscription identifier of the storage account.
subscriptionId?: stringProperty Value
string