Package com.azure.resourcemanager.iothub.models

Class ExportDevicesRequest

java.lang.Object
com.azure.resourcemanager.iothub.models.ExportDevicesRequest
public final class ExportDevicesRequest extends Object
Use to provide parameters when requesting an export of all devices in the IoT hub.

  • Constructor Details

    • ExportDevicesRequest

      public ExportDevicesRequest()

  • Method Details

    • exportBlobContainerUri

      public String exportBlobContainerUri()
      Get the exportBlobContainerUri property: The export blob container URI.
      Returns:
      the exportBlobContainerUri value.

    • withExportBlobContainerUri

      public ExportDevicesRequest withExportBlobContainerUri(String exportBlobContainerUri)
      Set the exportBlobContainerUri property: The export blob container URI.
      Parameters:
      exportBlobContainerUri - the exportBlobContainerUri value to set.
      Returns:
      the ExportDevicesRequest object itself.

    • excludeKeys

      public boolean excludeKeys()
      Get the excludeKeys property: The value indicating whether keys should be excluded during export.
      Returns:
      the excludeKeys value.

    • withExcludeKeys

      public ExportDevicesRequest withExcludeKeys(boolean excludeKeys)
      Set the excludeKeys property: The value indicating whether keys should be excluded during export.
      Parameters:
      excludeKeys - the excludeKeys value to set.
      Returns:
      the ExportDevicesRequest object itself.

    • exportBlobName

      public String exportBlobName()
      Get the exportBlobName property: 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.
      Returns:
      the exportBlobName value.

    • withExportBlobName

      public ExportDevicesRequest withExportBlobName(String exportBlobName)
      Set the exportBlobName property: 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.
      Parameters:
      exportBlobName - the exportBlobName value to set.
      Returns:
      the ExportDevicesRequest object itself.

    • authenticationType

      public AuthenticationType authenticationType()
      Get the authenticationType property: Specifies authentication type being used for connecting to the storage account.
      Returns:
      the authenticationType value.

    • withAuthenticationType

      public ExportDevicesRequest withAuthenticationType(AuthenticationType authenticationType)
      Set the authenticationType property: Specifies authentication type being used for connecting to the storage account.
      Parameters:
      authenticationType - the authenticationType value to set.
      Returns:
      the ExportDevicesRequest object itself.

    • identity

      public ManagedIdentity identity()
      Get the identity property: Managed identity properties of storage endpoint for export devices.
      Returns:
      the identity value.

    • withIdentity

      public ExportDevicesRequest withIdentity(ManagedIdentity identity)
      Set the identity property: Managed identity properties of storage endpoint for export devices.
      Parameters:
      identity - the identity value to set.
      Returns:
      the ExportDevicesRequest object itself.

    • includeConfigurations

      public Boolean includeConfigurations()
      Get the includeConfigurations property: The value indicating whether configurations should be exported.
      Returns:
      the includeConfigurations value.

    • withIncludeConfigurations

      public ExportDevicesRequest withIncludeConfigurations(Boolean includeConfigurations)
      Set the includeConfigurations property: The value indicating whether configurations should be exported.
      Parameters:
      includeConfigurations - the includeConfigurations value to set.
      Returns:
      the ExportDevicesRequest object itself.

    • configurationsBlobName

      public String configurationsBlobName()
      Get the configurationsBlobName property: 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.
      Returns:
      the configurationsBlobName value.

    • withConfigurationsBlobName

      public ExportDevicesRequest withConfigurationsBlobName(String configurationsBlobName)
      Set the configurationsBlobName property: 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.
      Parameters:
      configurationsBlobName - the configurationsBlobName value to set.
      Returns:
      the ExportDevicesRequest object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.