azure.mgmt.iothub.v2022_11_15_preview.models.RoutingStorageContainerProperties.yml

### YamlMime:PythonClass
uid: azure.mgmt.iothub.v2022_11_15_preview.models.RoutingStorageContainerProperties
name: RoutingStorageContainerProperties
fullName: azure.mgmt.iothub.v2022_11_15_preview.models.RoutingStorageContainerProperties
module: azure.mgmt.iothub.v2022_11_15_preview.models
inheritances:
- azure.mgmt.iothub._serialization.Model
summary: 'The properties related to a storage container endpoint.


  All required parameters must be populated in order to send to Azure.'
constructor:
  syntax: '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)'
  keywordOnlyParameters:
  - name: id
    description: Id of the storage container endpoint.
    types:
    - <xref:str>
  - name: connection_string
    description: The connection string of the storage account.
    types:
    - <xref:str>
  - name: endpoint_uri
    description: The url of the storage endpoint. It must include the protocol [https://](https://).
    types:
    - <xref:str>
  - name: authentication_type
    description: 'Method used to authenticate against the storage endpoint. Known

      values are: "keyBased" and "identityBased".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.iothub.v2022_11_15_preview.models.AuthenticationType>
  - name: identity
    description: Managed identity properties of routing storage endpoint.
    types:
    - <xref:azure.mgmt.iothub.v2022_11_15_preview.models.ManagedIdentity>
  - name: name
    description: '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.'
    types:
    - <xref:str>
  - name: subscription_id
    description: The subscription identifier of the storage account.
    types:
    - <xref:str>
  - name: resource_group
    description: The name of the resource group of the storage account.
    types:
    - <xref:str>
  - name: container_name
    description: The name of storage container in the storage account. Required.
    types:
    - <xref:str>
  - name: file_name_format
    description: 'File name format for the blob. Default format is

      {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory
      but can be

      reordered.'
    types:
    - <xref:str>
  - name: batch_frequency_in_seconds
    description: 'Time interval at which blobs are written to storage. Value

      should be between 60 and 720 seconds. Default value is 300 seconds.'
    types:
    - <xref:int>
  - name: max_chunk_size_in_bytes
    description: 'Maximum number of bytes for each blob written to storage.

      Value should be between 10485760(10MB) and 524288000(500MB). Default value is
      314572800(300MB).'
    types:
    - <xref:int>
  - name: encoding
    description: '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".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.iothub.v2022_11_15_preview.models.RoutingStorageContainerPropertiesEncoding>
variables:
- description: Id of the storage container endpoint.
  name: id
  types:
  - <xref:str>
- description: The connection string of the storage account.
  name: connection_string
  types:
  - <xref:str>
- description: The url of the storage endpoint. It must include the protocol [https://](https://).
  name: endpoint_uri
  types:
  - <xref:str>
- description: 'Method used to authenticate against the storage endpoint. Known

    values are: "keyBased" and "identityBased".'
  name: authentication_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.iothub.v2022_11_15_preview.models.AuthenticationType>
- description: Managed identity properties of routing storage endpoint.
  name: identity
  types:
  - <xref:azure.mgmt.iothub.v2022_11_15_preview.models.ManagedIdentity>
- description: '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.'
  name: name
  types:
  - <xref:str>
- description: The subscription identifier of the storage account.
  name: subscription_id
  types:
  - <xref:str>
- description: The name of the resource group of the storage account.
  name: resource_group
  types:
  - <xref:str>
- description: The name of storage container in the storage account. Required.
  name: container_name
  types:
  - <xref:str>
- description: 'File name format for the blob. Default format is

    {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory
    but can be

    reordered.'
  name: file_name_format
  types:
  - <xref:str>
- description: 'Time interval at which blobs are written to storage. Value

    should be between 60 and 720 seconds. Default value is 300 seconds.'
  name: batch_frequency_in_seconds
  types:
  - <xref:int>
- description: '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: max_chunk_size_in_bytes
  types:
  - <xref:int>
- description: '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".'
  name: encoding
  types:
  - <xref:str>
  - <xref:azure.mgmt.iothub.v2022_11_15_preview.models.RoutingStorageContainerPropertiesEncoding>