StorageEndpointProperties Class

  • java.lang.Object
    • com.azure.resourcemanager.iothub.models.StorageEndpointProperties

public final class StorageEndpointProperties

The properties of the Azure Storage endpoint for file upload.

Constructor Summary

Constructor Description
StorageEndpointProperties()

Creates an instance of StorageEndpointProperties class.

Method Summary

Modifier and Type Method and Description
AuthenticationType authenticationType()

Get the authenticationType property: Specifies authentication type being used for connecting to the storage account.

String connectionString()

Get the connectionString property: The connection string for the Azure Storage account to which files are uploaded.

String containerName()

Get the containerName property: The name of the root container where you upload files.

ManagedIdentity identity()

Get the identity property: Managed identity properties of storage endpoint for file upload.

Duration sasTtlAsIso8601()

Get the sasTtlAsIso8601 property: The period of time for which the SAS URI generated by IoT Hub for file upload is valid.

void validate()

Validates the instance.

StorageEndpointProperties withAuthenticationType(AuthenticationType authenticationType)

Set the authenticationType property: Specifies authentication type being used for connecting to the storage account.

StorageEndpointProperties withConnectionString(String connectionString)

Set the connectionString property: The connection string for the Azure Storage account to which files are uploaded.

StorageEndpointProperties withContainerName(String containerName)

Set the containerName property: The name of the root container where you upload files.

StorageEndpointProperties withIdentity(ManagedIdentity identity)

Set the identity property: Managed identity properties of storage endpoint for file upload.

StorageEndpointProperties withSasTtlAsIso8601(Duration sasTtlAsIso8601)

Set the sasTtlAsIso8601 property: The period of time for which the SAS URI generated by IoT Hub for file upload is valid.

Methods inherited from java.lang.Object

Constructor Details

StorageEndpointProperties

public StorageEndpointProperties()

Creates an instance of StorageEndpointProperties class.

Method Details

authenticationType

public AuthenticationType authenticationType()

Get the authenticationType property: Specifies authentication type being used for connecting to the storage account.

Returns:

the authenticationType value.

connectionString

public String connectionString()

Get the connectionString property: The connection string for the Azure Storage account to which files are uploaded.

Returns:

the connectionString value.

containerName

public String containerName()

Get the containerName property: The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.

Returns:

the containerName value.

identity

public ManagedIdentity identity()

Get the identity property: Managed identity properties of storage endpoint for file upload.

Returns:

the identity value.

sasTtlAsIso8601

public Duration sasTtlAsIso8601()

Get the sasTtlAsIso8601 property: The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload\#file-upload-notification-configuration-options.

Returns:

the sasTtlAsIso8601 value.

validate

public void validate()

Validates the instance.

withAuthenticationType

public StorageEndpointProperties 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 StorageEndpointProperties object itself.

withConnectionString

public StorageEndpointProperties withConnectionString(String connectionString)

Set the connectionString property: The connection string for the Azure Storage account to which files are uploaded.

Parameters:

connectionString - the connectionString value to set.

Returns:

the StorageEndpointProperties object itself.

withContainerName

public StorageEndpointProperties withContainerName(String containerName)

Set the containerName property: The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.

Parameters:

containerName - the containerName value to set.

Returns:

the StorageEndpointProperties object itself.

withIdentity

public StorageEndpointProperties withIdentity(ManagedIdentity identity)

Set the identity property: Managed identity properties of storage endpoint for file upload.

Parameters:

identity - the identity value to set.

Returns:

the StorageEndpointProperties object itself.

withSasTtlAsIso8601

public StorageEndpointProperties withSasTtlAsIso8601(Duration sasTtlAsIso8601)

Set the sasTtlAsIso8601 property: The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload\#file-upload-notification-configuration-options.

Parameters:

sasTtlAsIso8601 - the sasTtlAsIso8601 value to set.

Returns:

the StorageEndpointProperties object itself.

Applies to