azure.mgmt.iothub.v2021_07_01.models.ExportDevicesRequest.yml

### YamlMime:PythonClass
uid: azure.mgmt.iothub.v2021_07_01.models.ExportDevicesRequest
name: ExportDevicesRequest
fullName: azure.mgmt.iothub.v2021_07_01.models.ExportDevicesRequest
module: azure.mgmt.iothub.v2021_07_01.models
inheritances:
- azure.mgmt.iothub._serialization.Model
summary: 'Use to provide parameters when requesting an export of all devices in the
  IoT hub.


  All required parameters must be populated in order to send to Azure.'
constructor:
  syntax: 'ExportDevicesRequest(*, export_blob_container_uri: str, exclude_keys: bool,
    export_blob_name: str | None = None, authentication_type: str | _models.AuthenticationType
    | None = None, identity: _models.ManagedIdentity | None = None, include_configurations:
    bool | None = None, configurations_blob_name: str | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: export_blob_container_uri
    description: The export blob container URI. Required.
    types:
    - <xref:str>
  - name: exclude_keys
    description: 'The value indicating whether keys should be excluded during export.

      Required.'
    types:
    - <xref:bool>
  - name: export_blob_name
    description: 'The name of the blob that will be created in the provided output

      blob container. This blob will contain the exported device registry information
      for the IoT

      Hub.'
    types:
    - <xref:str>
  - name: authentication_type
    description: 'Specifies authentication type being used for connecting to the

      storage account. Known values are: "keyBased" and "identityBased".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.iothub.v2021_07_01.models.AuthenticationType>
  - name: identity
    description: Managed identity properties of storage endpoint for export devices.
    types:
    - <xref:azure.mgmt.iothub.v2021_07_01.models.ManagedIdentity>
  - name: include_configurations
    description: 'The value indicating whether configurations should be

      exported.'
    types:
    - <xref:bool>
  - name: configurations_blob_name
    description: 'The name of the blob that will be created in the provided

      output blob container. This blob will contain the exported configurations for
      the Iot Hub.'
    types:
    - <xref:str>
variables:
- description: The export blob container URI. Required.
  name: export_blob_container_uri
  types:
  - <xref:str>
- description: 'The value indicating whether keys should be excluded during export.

    Required.'
  name: exclude_keys
  types:
  - <xref:bool>
- description: 'The name of the blob that will be created in the provided output blob

    container. This blob will contain the exported device registry information for
    the IoT Hub.'
  name: export_blob_name
  types:
  - <xref:str>
- description: 'Specifies authentication type being used for connecting to the

    storage account. Known values are: "keyBased" and "identityBased".'
  name: authentication_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.iothub.v2021_07_01.models.AuthenticationType>
- description: Managed identity properties of storage endpoint for export devices.
  name: identity
  types:
  - <xref:azure.mgmt.iothub.v2021_07_01.models.ManagedIdentity>
- description: The value indicating whether configurations should be exported.
  name: include_configurations
  types:
  - <xref:bool>
- description: 'The name of the blob that will be created in the provided

    output blob container. This blob will contain the exported configurations for
    the Iot Hub.'
  name: configurations_blob_name
  types:
  - <xref:str>