pulumi-azure-kotlin/com.pulumi.azure.iot.kotlin/FileUploadArgs

FileUploadArgs

data class FileUploadArgs(val authenticationType: Output<String>? = null, val connectionString: Output<String>? = null, val containerName: Output<String>? = null, val defaultTtl: Output<String>? = null, val identityId: Output<String>? = null, val iothubId: Output<String>? = null, val lockDuration: Output<String>? = null, val maxDeliveryCount: Output<Int>? = null, val notificationsEnabled: Output<Boolean>? = null, val sasTtl: Output<String>? = null) : ConvertibleToJava<FileUploadArgs>

Manages the File Upload of an IoT Hub.

NOTE: File upload can be defined either directly on the azure.iot.IoTHub resource, or using the azure.iot.FileUpload resource - but the two cannot be used together. If both are used against the same IoTHub, spurious changes will occur.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.Container;
import com.pulumi.azure.storage.ContainerArgs;
import com.pulumi.azure.iot.IoTHub;
import com.pulumi.azure.iot.IoTHubArgs;
import com.pulumi.azure.iot.inputs.IoTHubSkuArgs;
import com.pulumi.azure.iot.FileUpload;
import com.pulumi.azure.iot.FileUploadArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("examplestorage")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());
        var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
            .name("examplecontainer")
            .storageAccountName(exampleAccount.name())
            .containerAccessType("private")
            .build());
        var exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku(IoTHubSkuArgs.builder()
                .name("S1")
                .capacity("1")
                .build())
            .build());
        var exampleFileUpload = new FileUpload("exampleFileUpload", FileUploadArgs.builder()
            .iothubId(exampleIoTHub.id())
            .connectionString(exampleAccount.primaryBlobConnectionString())
            .containerName(exampleContainer.name())
            .build());
    }
}
Content copied to clipboard

Import

IoT Hub File Uploads can be imported using the resource id, e.g.

$ pulumi import azure:iot/fileUpload:FileUpload example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/iotHubs/hub1
Content copied to clipboard

Constructors

Link copied to clipboard
fun FileUploadArgs(authenticationType: Output<String>? = null, connectionString: Output<String>? = null, containerName: Output<String>? = null, defaultTtl: Output<String>? = null, identityId: Output<String>? = null, iothubId: Output<String>? = null, lockDuration: Output<String>? = null, maxDeliveryCount: Output<Int>? = null, notificationsEnabled: Output<Boolean>? = null, sasTtl: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): FileUploadArgs

Properties

Link copied to clipboard
val authenticationType: Output<String>? = null

The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.

Link copied to clipboard
val connectionString: Output<String>? = null

The connection string for the Azure Storage account to which files are uploaded.

Link copied to clipboard
val containerName: Output<String>? = null

The name of the root container where the files should be uploaded to. The container need not exist but should be creatable using the connection_string specified.

Link copied to clipboard
val defaultTtl: Output<String>? = null

The period of time for which a file upload notification message is available to consume before it expires, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours. Defaults to PT1H.

Link copied to clipboard
val identityId: Output<String>? = null

The ID of the User Managed Identity used to authenticate against the storage account.

Link copied to clipboard
val iothubId: Output<String>? = null

The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.

Link copied to clipboard
val lockDuration: Output<String>? = null

The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds. Defaults to PT1M.

Link copied to clipboard
val maxDeliveryCount: Output<Int>? = null

The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.

Link copied to clipboard
val notificationsEnabled: Output<Boolean>? = null

Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.

Link copied to clipboard
val sasTtl: Output<String>? = null

The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours. Defaults to PT1H.