ExportDevicesRequest Class

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.

Inheritance

azure.mgmt.iothub._serialization.Model

ExportDevicesRequest

Constructor

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)

Keyword-Only Parameters

Name	Description
export_blob_container_uri	str The export blob container URI. Required.
exclude_keys	bool The value indicating whether keys should be excluded during export. Required.
export_blob_name	str 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.
authentication_type	str or AuthenticationType Specifies authentication type being used for connecting to the storage account. Known values are: "keyBased" and "identityBased".
identity	ManagedIdentity Managed identity properties of storage endpoint for export devices.
include_configurations	bool The value indicating whether configurations should be exported.
configurations_blob_name	str 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.

Variables

Name	Description
export_blob_container_uri	str The export blob container URI. Required.
exclude_keys	bool The value indicating whether keys should be excluded during export. Required.
export_blob_name	str 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.
authentication_type	str or AuthenticationType Specifies authentication type being used for connecting to the storage account. Known values are: "keyBased" and "identityBased".
identity	ManagedIdentity Managed identity properties of storage endpoint for export devices.
include_configurations	bool The value indicating whether configurations should be exported.
configurations_blob_name	str 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.