Share via

RoutingStorageContainerProperties Class

The properties related to a storage container endpoint.

All required parameters must be populated in order to send to server.

Constructor

RoutingStorageContainerProperties(*, name: str, container_name: str, id: str | None = None, connection_string: str | None = None, endpoint_uri: str | None = None, authentication_type: str | _models.AuthenticationType | None = None, identity: _models.ManagedIdentity | None = None, subscription_id: str | None = None, resource_group: str | None = None, file_name_format: str | None = None, batch_frequency_in_seconds: int | None = None, max_chunk_size_in_bytes: int | None = None, encoding: str | _models.RoutingStorageContainerPropertiesEncoding | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Id of the storage container endpoint.

Default value: None
connection_string
str

The connection string of the storage account.

Default value: None
endpoint_uri
str

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

Default value: None
authentication_type
str or AuthenticationType

Method used to authenticate against the storage endpoint. Known values are: "keyBased" and "identityBased".

Default value: None
identity
ManagedIdentity

Managed identity properties of routing storage endpoint.

Default value: None
name
str

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. Required.
subscription_id
str

The subscription identifier of the storage account.

Default value: None
resource_group
str

The name of the resource group of the storage account.

Default value: None
container_name
str

The name of storage container in the storage account. Required.
file_name_format
str

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

Default value: None
batch_frequency_in_seconds
int

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

Default value: None
max_chunk_size_in_bytes
int

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

Default value: None
encoding
str or RoutingStorageContainerPropertiesEncoding

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

Default value: None

Variables

Name Description
id
str

Id of the storage container endpoint.
connection_string
str

The connection string of the storage account.
endpoint_uri
str

The url of the storage endpoint. It must include the protocol https://.
authentication_type
str or AuthenticationType

Method used to authenticate against the storage endpoint. Known values are: "keyBased" and "identityBased".
identity
ManagedIdentity

Managed identity properties of routing storage endpoint.
name
str

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. Required.
subscription_id
str

The subscription identifier of the storage account.
resource_group
str

The name of the resource group of the storage account.
container_name
str

The name of storage container in the storage account. Required.
file_name_format
str

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

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

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

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