1. Packages
  2. Azure Classic
  3. API Docs
  4. iot
  5. FileUpload

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

azure.iot.FileUpload

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

    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

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleAccount = new azure.storage.Account("example", {
        name: "examplestorage",
        resourceGroupName: example.name,
        location: example.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
    });
    const exampleContainer = new azure.storage.Container("example", {
        name: "examplecontainer",
        storageAccountName: exampleAccount.name,
        containerAccessType: "private",
    });
    const exampleIoTHub = new azure.iot.IoTHub("example", {
        name: "example",
        resourceGroupName: example.name,
        location: example.location,
        sku: {
            name: "S1",
            capacity: 1,
        },
    });
    const exampleFileUpload = new azure.iot.FileUpload("example", {
        iothubId: exampleIoTHub.id,
        connectionString: exampleAccount.primaryBlobConnectionString,
        containerName: exampleContainer.name,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_account = azure.storage.Account("example",
        name="examplestorage",
        resource_group_name=example.name,
        location=example.location,
        account_tier="Standard",
        account_replication_type="LRS")
    example_container = azure.storage.Container("example",
        name="examplecontainer",
        storage_account_name=example_account.name,
        container_access_type="private")
    example_io_t_hub = azure.iot.IoTHub("example",
        name="example",
        resource_group_name=example.name,
        location=example.location,
        sku={
            "name": "S1",
            "capacity": 1,
        })
    example_file_upload = azure.iot.FileUpload("example",
        iothub_id=example_io_t_hub.id,
        connection_string=example_account.primary_blob_connection_string,
        container_name=example_container.name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/iot"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
    			Name:                   pulumi.String("examplestorage"),
    			ResourceGroupName:      example.Name,
    			Location:               example.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleContainer, err := storage.NewContainer(ctx, "example", &storage.ContainerArgs{
    			Name:                pulumi.String("examplecontainer"),
    			StorageAccountName:  exampleAccount.Name,
    			ContainerAccessType: pulumi.String("private"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleIoTHub, err := iot.NewIoTHub(ctx, "example", &iot.IoTHubArgs{
    			Name:              pulumi.String("example"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			Sku: &iot.IoTHubSkuArgs{
    				Name:     pulumi.String("S1"),
    				Capacity: pulumi.Int(1),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = iot.NewFileUpload(ctx, "example", &iot.FileUploadArgs{
    			IothubId:         exampleIoTHub.ID(),
    			ConnectionString: exampleAccount.PrimaryBlobConnectionString,
    			ContainerName:    exampleContainer.Name,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleAccount = new Azure.Storage.Account("example", new()
        {
            Name = "examplestorage",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
    
        var exampleContainer = new Azure.Storage.Container("example", new()
        {
            Name = "examplecontainer",
            StorageAccountName = exampleAccount.Name,
            ContainerAccessType = "private",
        });
    
        var exampleIoTHub = new Azure.Iot.IoTHub("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            Location = example.Location,
            Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
            {
                Name = "S1",
                Capacity = 1,
            },
        });
    
        var exampleFileUpload = new Azure.Iot.FileUpload("example", new()
        {
            IothubId = exampleIoTHub.Id,
            ConnectionString = exampleAccount.PrimaryBlobConnectionString,
            ContainerName = exampleContainer.Name,
        });
    
    });
    
    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());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleAccount:
        type: azure:storage:Account
        name: example
        properties:
          name: examplestorage
          resourceGroupName: ${example.name}
          location: ${example.location}
          accountTier: Standard
          accountReplicationType: LRS
      exampleContainer:
        type: azure:storage:Container
        name: example
        properties:
          name: examplecontainer
          storageAccountName: ${exampleAccount.name}
          containerAccessType: private
      exampleIoTHub:
        type: azure:iot:IoTHub
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          location: ${example.location}
          sku:
            name: S1
            capacity: '1'
      exampleFileUpload:
        type: azure:iot:FileUpload
        name: example
        properties:
          iothubId: ${exampleIoTHub.id}
          connectionString: ${exampleAccount.primaryBlobConnectionString}
          containerName: ${exampleContainer.name}
    

    Create FileUpload Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FileUpload(name: string, args: FileUploadArgs, opts?: CustomResourceOptions);
    @overload
    def FileUpload(resource_name: str,
                   args: FileUploadArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def FileUpload(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   connection_string: Optional[str] = None,
                   container_name: Optional[str] = None,
                   iothub_id: Optional[str] = None,
                   authentication_type: Optional[str] = None,
                   default_ttl: Optional[str] = None,
                   identity_id: Optional[str] = None,
                   lock_duration: Optional[str] = None,
                   max_delivery_count: Optional[int] = None,
                   notifications_enabled: Optional[bool] = None,
                   sas_ttl: Optional[str] = None)
    func NewFileUpload(ctx *Context, name string, args FileUploadArgs, opts ...ResourceOption) (*FileUpload, error)
    public FileUpload(string name, FileUploadArgs args, CustomResourceOptions? opts = null)
    public FileUpload(String name, FileUploadArgs args)
    public FileUpload(String name, FileUploadArgs args, CustomResourceOptions options)
    
    type: azure:iot:FileUpload
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FileUploadArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FileUploadArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FileUploadArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileUploadArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileUploadArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var fileUploadResource = new Azure.Iot.FileUpload("fileUploadResource", new()
    {
        ConnectionString = "string",
        ContainerName = "string",
        IothubId = "string",
        AuthenticationType = "string",
        DefaultTtl = "string",
        IdentityId = "string",
        LockDuration = "string",
        MaxDeliveryCount = 0,
        NotificationsEnabled = false,
        SasTtl = "string",
    });
    
    example, err := iot.NewFileUpload(ctx, "fileUploadResource", &iot.FileUploadArgs{
    	ConnectionString:     pulumi.String("string"),
    	ContainerName:        pulumi.String("string"),
    	IothubId:             pulumi.String("string"),
    	AuthenticationType:   pulumi.String("string"),
    	DefaultTtl:           pulumi.String("string"),
    	IdentityId:           pulumi.String("string"),
    	LockDuration:         pulumi.String("string"),
    	MaxDeliveryCount:     pulumi.Int(0),
    	NotificationsEnabled: pulumi.Bool(false),
    	SasTtl:               pulumi.String("string"),
    })
    
    var fileUploadResource = new FileUpload("fileUploadResource", FileUploadArgs.builder()
        .connectionString("string")
        .containerName("string")
        .iothubId("string")
        .authenticationType("string")
        .defaultTtl("string")
        .identityId("string")
        .lockDuration("string")
        .maxDeliveryCount(0)
        .notificationsEnabled(false)
        .sasTtl("string")
        .build());
    
    file_upload_resource = azure.iot.FileUpload("fileUploadResource",
        connection_string="string",
        container_name="string",
        iothub_id="string",
        authentication_type="string",
        default_ttl="string",
        identity_id="string",
        lock_duration="string",
        max_delivery_count=0,
        notifications_enabled=False,
        sas_ttl="string")
    
    const fileUploadResource = new azure.iot.FileUpload("fileUploadResource", {
        connectionString: "string",
        containerName: "string",
        iothubId: "string",
        authenticationType: "string",
        defaultTtl: "string",
        identityId: "string",
        lockDuration: "string",
        maxDeliveryCount: 0,
        notificationsEnabled: false,
        sasTtl: "string",
    });
    
    type: azure:iot:FileUpload
    properties:
        authenticationType: string
        connectionString: string
        containerName: string
        defaultTtl: string
        identityId: string
        iothubId: string
        lockDuration: string
        maxDeliveryCount: 0
        notificationsEnabled: false
        sasTtl: string
    

    FileUpload Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FileUpload resource accepts the following input properties:

    ConnectionString string
    The connection string for the Azure Storage account to which files are uploaded.
    ContainerName 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.
    IothubId string
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    AuthenticationType string
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    DefaultTtl 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.
    IdentityId string

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    LockDuration 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 int
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    NotificationsEnabled bool
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    SasTtl 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.
    ConnectionString string
    The connection string for the Azure Storage account to which files are uploaded.
    ContainerName 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.
    IothubId string
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    AuthenticationType string
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    DefaultTtl 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.
    IdentityId string

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    LockDuration 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 int
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    NotificationsEnabled bool
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    SasTtl 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.
    connectionString String
    The connection string for the Azure Storage account to which files are uploaded.
    containerName 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.
    iothubId String
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    authenticationType String
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    defaultTtl 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.
    identityId String

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    lockDuration 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 Integer
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    notificationsEnabled Boolean
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    sasTtl 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.
    connectionString string
    The connection string for the Azure Storage account to which files are uploaded.
    containerName 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.
    iothubId string
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    authenticationType string
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    defaultTtl 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.
    identityId string

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    lockDuration 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 number
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    notificationsEnabled boolean
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    sasTtl 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.
    connection_string str
    The connection string for the Azure Storage account to which files are uploaded.
    container_name str
    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.
    iothub_id str
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    authentication_type str
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    default_ttl str
    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.
    identity_id str

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    lock_duration str
    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.
    max_delivery_count int
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    notifications_enabled bool
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    sas_ttl str
    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.
    connectionString String
    The connection string for the Azure Storage account to which files are uploaded.
    containerName 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.
    iothubId String
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    authenticationType String
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    defaultTtl 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.
    identityId String

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    lockDuration 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 Number
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    notificationsEnabled Boolean
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    sasTtl 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FileUpload resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FileUpload Resource

    Get an existing FileUpload resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FileUploadState, opts?: CustomResourceOptions): FileUpload
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authentication_type: Optional[str] = None,
            connection_string: Optional[str] = None,
            container_name: Optional[str] = None,
            default_ttl: Optional[str] = None,
            identity_id: Optional[str] = None,
            iothub_id: Optional[str] = None,
            lock_duration: Optional[str] = None,
            max_delivery_count: Optional[int] = None,
            notifications_enabled: Optional[bool] = None,
            sas_ttl: Optional[str] = None) -> FileUpload
    func GetFileUpload(ctx *Context, name string, id IDInput, state *FileUploadState, opts ...ResourceOption) (*FileUpload, error)
    public static FileUpload Get(string name, Input<string> id, FileUploadState? state, CustomResourceOptions? opts = null)
    public static FileUpload get(String name, Output<String> id, FileUploadState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AuthenticationType string
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    ConnectionString string
    The connection string for the Azure Storage account to which files are uploaded.
    ContainerName 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 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.
    IdentityId string

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    IothubId string
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    LockDuration 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 int
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    NotificationsEnabled bool
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    SasTtl 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.
    AuthenticationType string
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    ConnectionString string
    The connection string for the Azure Storage account to which files are uploaded.
    ContainerName 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 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.
    IdentityId string

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    IothubId string
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    LockDuration 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 int
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    NotificationsEnabled bool
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    SasTtl 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.
    authenticationType String
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString String
    The connection string for the Azure Storage account to which files are uploaded.
    containerName 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 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.
    identityId String

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    iothubId String
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    lockDuration 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 Integer
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    notificationsEnabled Boolean
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    sasTtl 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.
    authenticationType string
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString string
    The connection string for the Azure Storage account to which files are uploaded.
    containerName 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 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.
    identityId string

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    iothubId string
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    lockDuration 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 number
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    notificationsEnabled boolean
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    sasTtl 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.
    authentication_type str
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    connection_string str
    The connection string for the Azure Storage account to which files are uploaded.
    container_name str
    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.
    default_ttl str
    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.
    identity_id str

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    iothub_id str
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    lock_duration str
    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.
    max_delivery_count int
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    notifications_enabled bool
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    sas_ttl str
    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.
    authenticationType String
    The type used to authenticate against the storage account. Possible values are keyBased and identityBased. Defaults to keyBased.
    connectionString String
    The connection string for the Azure Storage account to which files are uploaded.
    containerName 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 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.
    identityId String

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

    NOTE: identity_id can only be specified when authentication_type is identityBased. It must be one of the identity_ids of the IoT Hub. If identity_id is omitted when authentication_type is identityBased, then the System-Assigned Managed Identity of the IoT Hub will be used.

    iothubId String
    The ID of the IoT Hub. Changing this forces a new IoT Hub to be created.
    lockDuration 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 Number
    The number of times the IoT Hub attempts to deliver a file upload notification message. Defaults to 10.
    notificationsEnabled Boolean
    Used to specify whether file notifications are sent to IoT Hub on upload. Defaults to false.
    sasTtl 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.

    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
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi