RoutingStorageContainerProperties Class

The properties related to a storage container endpoint.

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

Inheritance

Model

RoutingStorageContainerProperties

Constructor

RoutingStorageContainerProperties(*, name: str, container_name: str, id: Optional[str] = None, connection_string: Optional[str] = None, endpoint_uri: Optional[str] = None, authentication_type: Optional[Union[str, azure.mgmt.iothub.v2021_03_31.models._iot_hub_client_enums.AuthenticationType]] = None, identity: Optional[azure.mgmt.iothub.v2021_03_31.models._models_py3.ManagedIdentity] = None, subscription_id: Optional[str] = None, resource_group: Optional[str] = None, file_name_format: Optional[str] = None, batch_frequency_in_seconds: Optional[int] = None, max_chunk_size_in_bytes: Optional[int] = None, encoding: Optional[Union[str, azure.mgmt.iothub.v2021_03_31.models._iot_hub_client_enums.RoutingStorageContainerPropertiesEncoding]] = None, **kwargs)

Variables

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. Possible values include: "keyBased", "identityBased".

identity

ManagedIdentity

Managed identity properties of routing storage endpoint.

name

str

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

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

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

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'. Possible values include: "Avro", "AvroDeflate", "JSON".