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

FileUpload

class FileUpload : KotlinCustomResource

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());
        var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
            .storageAccountName(exampleAccount.name())
            .containerAccessType("private")
            .build());
        var exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.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());
    }
}

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

Properties

authenticationType

val authenticationType: Output<String>?

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

connectionString

val connectionString: Output<String>

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

containerName

val containerName: Output<String>

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.

defaultTtl

val defaultTtl: Output<String>?

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.

val id: Output<String>

identityId

val identityId: Output<String>?

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

iothubId

val iothubId: Output<String>

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

lockDuration

val lockDuration: Output<String>?

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.

maxDeliveryCount

val maxDeliveryCount: Output<Int>?

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

notificationsEnabled

val notificationsEnabled: Output<Boolean>?

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

sasTtl

val sasTtl: Output<String>?

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.

urn

val urn: Output<String>