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

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.iot.EndpointStorageContainer

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages an IotHub Storage Container Endpoint

    NOTE: Endpoints can be defined either directly on the azure.iot.IoTHub resource, or using the azurerm_iothub_endpoint_* resources - but the two ways of defining the endpoints cannot be used together. If both are used against the same IoTHub, spurious changes will occur. Also, defining a azurerm_iothub_endpoint_* resource and another endpoint of a different type directly on the azure.iot.IoTHub resource is not supported.

    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: "example",
        resourceGroupName: example.name,
        location: example.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
    });
    const exampleContainer = new azure.storage.Container("example", {
        name: "acctestcont",
        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 exampleEndpointStorageContainer = new azure.iot.EndpointStorageContainer("example", {
        resourceGroupName: example.name,
        iothubId: exampleIoTHub.id,
        name: "acctest",
        containerName: "acctestcont",
        connectionString: exampleAccount.primaryBlobConnectionString,
        fileNameFormat: "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
        batchFrequencyInSeconds: 60,
        maxChunkSizeInBytes: 10485760,
        encoding: "JSON",
    });
    
    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="example",
        resource_group_name=example.name,
        location=example.location,
        account_tier="Standard",
        account_replication_type="LRS")
    example_container = azure.storage.Container("example",
        name="acctestcont",
        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=azure.iot.IoTHubSkuArgs(
            name="S1",
            capacity=1,
        ))
    example_endpoint_storage_container = azure.iot.EndpointStorageContainer("example",
        resource_group_name=example.name,
        iothub_id=example_io_t_hub.id,
        name="acctest",
        container_name="acctestcont",
        connection_string=example_account.primary_blob_connection_string,
        file_name_format="{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
        batch_frequency_in_seconds=60,
        max_chunk_size_in_bytes=10485760,
        encoding="JSON")
    
    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("example"),
    			ResourceGroupName:      example.Name,
    			Location:               example.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = storage.NewContainer(ctx, "example", &storage.ContainerArgs{
    			Name:                pulumi.String("acctestcont"),
    			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.NewEndpointStorageContainer(ctx, "example", &iot.EndpointStorageContainerArgs{
    			ResourceGroupName:       example.Name,
    			IothubId:                exampleIoTHub.ID(),
    			Name:                    pulumi.String("acctest"),
    			ContainerName:           pulumi.String("acctestcont"),
    			ConnectionString:        exampleAccount.PrimaryBlobConnectionString,
    			FileNameFormat:          pulumi.String("{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}"),
    			BatchFrequencyInSeconds: pulumi.Int(60),
    			MaxChunkSizeInBytes:     pulumi.Int(10485760),
    			Encoding:                pulumi.String("JSON"),
    		})
    		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 = "example",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
    
        var exampleContainer = new Azure.Storage.Container("example", new()
        {
            Name = "acctestcont",
            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 exampleEndpointStorageContainer = new Azure.Iot.EndpointStorageContainer("example", new()
        {
            ResourceGroupName = example.Name,
            IothubId = exampleIoTHub.Id,
            Name = "acctest",
            ContainerName = "acctestcont",
            ConnectionString = exampleAccount.PrimaryBlobConnectionString,
            FileNameFormat = "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
            BatchFrequencyInSeconds = 60,
            MaxChunkSizeInBytes = 10485760,
            Encoding = "JSON",
        });
    
    });
    
    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.EndpointStorageContainer;
    import com.pulumi.azure.iot.EndpointStorageContainerArgs;
    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("example")
                .resourceGroupName(example.name())
                .location(example.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .build());
    
            var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
                .name("acctestcont")
                .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 exampleEndpointStorageContainer = new EndpointStorageContainer("exampleEndpointStorageContainer", EndpointStorageContainerArgs.builder()
                .resourceGroupName(example.name())
                .iothubId(exampleIoTHub.id())
                .name("acctest")
                .containerName("acctestcont")
                .connectionString(exampleAccount.primaryBlobConnectionString())
                .fileNameFormat("{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}")
                .batchFrequencyInSeconds(60)
                .maxChunkSizeInBytes(10485760)
                .encoding("JSON")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleAccount:
        type: azure:storage:Account
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          location: ${example.location}
          accountTier: Standard
          accountReplicationType: LRS
      exampleContainer:
        type: azure:storage:Container
        name: example
        properties:
          name: acctestcont
          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'
      exampleEndpointStorageContainer:
        type: azure:iot:EndpointStorageContainer
        name: example
        properties:
          resourceGroupName: ${example.name}
          iothubId: ${exampleIoTHub.id}
          name: acctest
          containerName: acctestcont
          connectionString: ${exampleAccount.primaryBlobConnectionString}
          fileNameFormat: '{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}'
          batchFrequencyInSeconds: 60
          maxChunkSizeInBytes: 1.048576e+07
          encoding: JSON
    

    Create EndpointStorageContainer Resource

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

    Constructor syntax

    new EndpointStorageContainer(name: string, args: EndpointStorageContainerArgs, opts?: CustomResourceOptions);
    @overload
    def EndpointStorageContainer(resource_name: str,
                                 args: EndpointStorageContainerArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def EndpointStorageContainer(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 container_name: Optional[str] = None,
                                 iothub_id: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 authentication_type: Optional[str] = None,
                                 batch_frequency_in_seconds: Optional[int] = None,
                                 connection_string: Optional[str] = None,
                                 encoding: Optional[str] = None,
                                 endpoint_uri: Optional[str] = None,
                                 file_name_format: Optional[str] = None,
                                 identity_id: Optional[str] = None,
                                 max_chunk_size_in_bytes: Optional[int] = None,
                                 name: Optional[str] = None)
    func NewEndpointStorageContainer(ctx *Context, name string, args EndpointStorageContainerArgs, opts ...ResourceOption) (*EndpointStorageContainer, error)
    public EndpointStorageContainer(string name, EndpointStorageContainerArgs args, CustomResourceOptions? opts = null)
    public EndpointStorageContainer(String name, EndpointStorageContainerArgs args)
    public EndpointStorageContainer(String name, EndpointStorageContainerArgs args, CustomResourceOptions options)
    
    type: azure:iot:EndpointStorageContainer
    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 EndpointStorageContainerArgs
    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 EndpointStorageContainerArgs
    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 EndpointStorageContainerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointStorageContainerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointStorageContainerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var endpointStorageContainerResource = new Azure.Iot.EndpointStorageContainer("endpointStorageContainerResource", new()
    {
        ContainerName = "string",
        IothubId = "string",
        ResourceGroupName = "string",
        AuthenticationType = "string",
        BatchFrequencyInSeconds = 0,
        ConnectionString = "string",
        Encoding = "string",
        EndpointUri = "string",
        FileNameFormat = "string",
        IdentityId = "string",
        MaxChunkSizeInBytes = 0,
        Name = "string",
    });
    
    example, err := iot.NewEndpointStorageContainer(ctx, "endpointStorageContainerResource", &iot.EndpointStorageContainerArgs{
    	ContainerName:           pulumi.String("string"),
    	IothubId:                pulumi.String("string"),
    	ResourceGroupName:       pulumi.String("string"),
    	AuthenticationType:      pulumi.String("string"),
    	BatchFrequencyInSeconds: pulumi.Int(0),
    	ConnectionString:        pulumi.String("string"),
    	Encoding:                pulumi.String("string"),
    	EndpointUri:             pulumi.String("string"),
    	FileNameFormat:          pulumi.String("string"),
    	IdentityId:              pulumi.String("string"),
    	MaxChunkSizeInBytes:     pulumi.Int(0),
    	Name:                    pulumi.String("string"),
    })
    
    var endpointStorageContainerResource = new EndpointStorageContainer("endpointStorageContainerResource", EndpointStorageContainerArgs.builder()
        .containerName("string")
        .iothubId("string")
        .resourceGroupName("string")
        .authenticationType("string")
        .batchFrequencyInSeconds(0)
        .connectionString("string")
        .encoding("string")
        .endpointUri("string")
        .fileNameFormat("string")
        .identityId("string")
        .maxChunkSizeInBytes(0)
        .name("string")
        .build());
    
    endpoint_storage_container_resource = azure.iot.EndpointStorageContainer("endpointStorageContainerResource",
        container_name="string",
        iothub_id="string",
        resource_group_name="string",
        authentication_type="string",
        batch_frequency_in_seconds=0,
        connection_string="string",
        encoding="string",
        endpoint_uri="string",
        file_name_format="string",
        identity_id="string",
        max_chunk_size_in_bytes=0,
        name="string")
    
    const endpointStorageContainerResource = new azure.iot.EndpointStorageContainer("endpointStorageContainerResource", {
        containerName: "string",
        iothubId: "string",
        resourceGroupName: "string",
        authenticationType: "string",
        batchFrequencyInSeconds: 0,
        connectionString: "string",
        encoding: "string",
        endpointUri: "string",
        fileNameFormat: "string",
        identityId: "string",
        maxChunkSizeInBytes: 0,
        name: "string",
    });
    
    type: azure:iot:EndpointStorageContainer
    properties:
        authenticationType: string
        batchFrequencyInSeconds: 0
        connectionString: string
        containerName: string
        encoding: string
        endpointUri: string
        fileNameFormat: string
        identityId: string
        iothubId: string
        maxChunkSizeInBytes: 0
        name: string
        resourceGroupName: string
    

    EndpointStorageContainer 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 EndpointStorageContainer resource accepts the following input properties:

    ContainerName string
    The name of storage container in the storage account.
    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    AuthenticationType string
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    BatchFrequencyInSeconds int
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    Encoding string
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    EndpointUri string
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    FileNameFormat string
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    IdentityId string

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    MaxChunkSizeInBytes int
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    ContainerName string
    The name of storage container in the storage account.
    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    AuthenticationType string
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    BatchFrequencyInSeconds int
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    Encoding string
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    EndpointUri string
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    FileNameFormat string
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    IdentityId string

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    MaxChunkSizeInBytes int
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    containerName String
    The name of storage container in the storage account.
    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    batchFrequencyInSeconds Integer
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    encoding String
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    endpointUri String
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    fileNameFormat String
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    identityId String

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    maxChunkSizeInBytes Integer
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    containerName string
    The name of storage container in the storage account.
    iothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    authenticationType string
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    batchFrequencyInSeconds number
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    connectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    encoding string
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    endpointUri string
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    fileNameFormat string
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    identityId string

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    maxChunkSizeInBytes number
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    container_name str
    The name of storage container in the storage account.
    iothub_id str
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    authentication_type str
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    batch_frequency_in_seconds int
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    connection_string str
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    encoding str
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    endpoint_uri str
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    file_name_format str
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    identity_id str

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    max_chunk_size_in_bytes int
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    name str
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    containerName String
    The name of storage container in the storage account.
    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    batchFrequencyInSeconds Number
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    encoding String
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    endpointUri String
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    fileNameFormat String
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    identityId String

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    maxChunkSizeInBytes Number
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EndpointStorageContainer 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 EndpointStorageContainer Resource

    Get an existing EndpointStorageContainer 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?: EndpointStorageContainerState, opts?: CustomResourceOptions): EndpointStorageContainer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authentication_type: Optional[str] = None,
            batch_frequency_in_seconds: Optional[int] = None,
            connection_string: Optional[str] = None,
            container_name: Optional[str] = None,
            encoding: Optional[str] = None,
            endpoint_uri: Optional[str] = None,
            file_name_format: Optional[str] = None,
            identity_id: Optional[str] = None,
            iothub_id: Optional[str] = None,
            max_chunk_size_in_bytes: Optional[int] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None) -> EndpointStorageContainer
    func GetEndpointStorageContainer(ctx *Context, name string, id IDInput, state *EndpointStorageContainerState, opts ...ResourceOption) (*EndpointStorageContainer, error)
    public static EndpointStorageContainer Get(string name, Input<string> id, EndpointStorageContainerState? state, CustomResourceOptions? opts = null)
    public static EndpointStorageContainer get(String name, Output<String> id, EndpointStorageContainerState 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
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    BatchFrequencyInSeconds int
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    ContainerName string
    The name of storage container in the storage account.
    Encoding string
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    EndpointUri string
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    FileNameFormat string
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    IdentityId string

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    MaxChunkSizeInBytes int
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    AuthenticationType string
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    BatchFrequencyInSeconds int
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    ConnectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    ContainerName string
    The name of storage container in the storage account.
    Encoding string
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    EndpointUri string
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    FileNameFormat string
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    IdentityId string

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    IothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    MaxChunkSizeInBytes int
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    Name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    batchFrequencyInSeconds Integer
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    containerName String
    The name of storage container in the storage account.
    encoding String
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    endpointUri String
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    fileNameFormat String
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    identityId String

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    maxChunkSizeInBytes Integer
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    authenticationType string
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    batchFrequencyInSeconds number
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    connectionString string
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    containerName string
    The name of storage container in the storage account.
    encoding string
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    endpointUri string
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    fileNameFormat string
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    identityId string

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothubId string
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    maxChunkSizeInBytes number
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    name string
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    authentication_type str
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    batch_frequency_in_seconds int
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    connection_string str
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    container_name str
    The name of storage container in the storage account.
    encoding str
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    endpoint_uri str
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    file_name_format str
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    identity_id str

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothub_id str
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    max_chunk_size_in_bytes int
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    name str
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.
    authenticationType String
    Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.
    batchFrequencyInSeconds Number
    Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    connectionString String
    The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.
    containerName String
    The name of storage container in the storage account.
    encoding String
    Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. Changing this forces a new resource to be created.
    endpointUri String
    URI of the Storage Container endpoint. This corresponds to the primary_blob_endpoint of the parent storage account. This attribute can only be specified and is mandatory when authentication_type is identityBased.
    fileNameFormat String
    File name format for the blob. All parameters are mandatory but can be reordered. Defaults to {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}.
    identityId String

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

    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 not specified when authentication_type is identityBased, System Assigned Managed Identity of the Iot Hub will be used.

    iothubId String
    The IoTHub ID for the endpoint. Changing this forces a new resource to be created.
    maxChunkSizeInBytes Number
    Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    name String
    The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.

    Import

    IoTHub Storage Container Endpoint can be imported using the resource id, e.g.

    $ pulumi import azure:iot/endpointStorageContainer:EndpointStorageContainer storage_container1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/iotHubs/hub1/endpoints/storage_container_endpoint1
    

    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.80.0 published on Monday, Jun 10, 2024 by Pulumi