Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.14.0 published on Thursday, Jul 28, 2022 by Pulumi

EndpointStorageContainer

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

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var exampleContainer = new Azure.Storage.Container("exampleContainer", new Azure.Storage.ContainerArgs
        {
            StorageAccountName = exampleAccount.Name,
            ContainerAccessType = "private",
        });
        var exampleIoTHub = new Azure.Iot.IoTHub("exampleIoTHub", new Azure.Iot.IoTHubArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
            {
                Name = "S1",
                Capacity = 1,
            },
        });
        var exampleEndpointStorageContainer = new Azure.Iot.EndpointStorageContainer("exampleEndpointStorageContainer", new Azure.Iot.EndpointStorageContainerArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            IothubId = exampleIoTHub.Id,
            ContainerName = "acctestcont",
            ConnectionString = exampleAccount.PrimaryBlobConnectionString,
            FileNameFormat = "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
            BatchFrequencyInSeconds = 60,
            MaxChunkSizeInBytes = 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 {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewContainer(ctx, "exampleContainer", &storage.ContainerArgs{
			StorageAccountName:  exampleAccount.Name,
			ContainerAccessType: pulumi.String("private"),
		})
		if err != nil {
			return err
		}
		exampleIoTHub, err := iot.NewIoTHub(ctx, "exampleIoTHub", &iot.IoTHubArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			Sku: &iot.IoTHubSkuArgs{
				Name:     pulumi.String("S1"),
				Capacity: pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		_, err = iot.NewEndpointStorageContainer(ctx, "exampleEndpointStorageContainer", &iot.EndpointStorageContainerArgs{
			ResourceGroupName:       exampleResourceGroup.Name,
			IothubId:                exampleIoTHub.ID(),
			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
	})
}
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()        
            .storageAccountName(exampleAccount.name())
            .containerAccessType("private")
            .build());

        var exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .sku(IoTHubSkuArgs.builder()
                .name("S1")
                .capacity("1")
                .build())
            .build());

        var exampleEndpointStorageContainer = new EndpointStorageContainer("exampleEndpointStorageContainer", EndpointStorageContainerArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .iothubId(exampleIoTHub.id())
            .containerName("acctestcont")
            .connectionString(exampleAccount.primaryBlobConnectionString())
            .fileNameFormat("{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}")
            .batchFrequencyInSeconds(60)
            .maxChunkSizeInBytes(10485760)
            .encoding("JSON")
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_container = azure.storage.Container("exampleContainer",
    storage_account_name=example_account.name,
    container_access_type="private")
example_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku=azure.iot.IoTHubSkuArgs(
        name="S1",
        capacity=1,
    ))
example_endpoint_storage_container = azure.iot.EndpointStorageContainer("exampleEndpointStorageContainer",
    resource_group_name=example_resource_group.name,
    iothub_id=example_io_t_hub.id,
    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")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("exampleContainer", {
    storageAccountName: exampleAccount.name,
    containerAccessType: "private",
});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "S1",
        capacity: 1,
    },
});
const exampleEndpointStorageContainer = new azure.iot.EndpointStorageContainer("exampleEndpointStorageContainer", {
    resourceGroupName: exampleResourceGroup.name,
    iothubId: exampleIoTHub.id,
    containerName: "acctestcont",
    connectionString: exampleAccount.primaryBlobConnectionString,
    fileNameFormat: "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
    batchFrequencyInSeconds: 60,
    maxChunkSizeInBytes: 10485760,
    encoding: "JSON",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleContainer:
    type: azure:storage:Container
    properties:
      storageAccountName: ${exampleAccount.name}
      containerAccessType: private
  exampleIoTHub:
    type: azure:iot:IoTHub
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      sku:
        name: S1
        capacity: 1
  exampleEndpointStorageContainer:
    type: azure:iot:EndpointStorageContainer
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      iothubId: ${exampleIoTHub.id}
      containerName: acctestcont
      connectionString: ${exampleAccount.primaryBlobConnectionString}
      fileNameFormat: '{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}'
      batchFrequencyInSeconds: 60
      maxChunkSizeInBytes: 1.048576e+07
      encoding: JSON

Create a EndpointStorageContainer Resource

new EndpointStorageContainer(name: string, args: EndpointStorageContainerArgs, opts?: CustomResourceOptions);
@overload
def EndpointStorageContainer(resource_name: 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)
@overload
def EndpointStorageContainer(resource_name: str,
                             args: EndpointStorageContainerArgs,
                             opts: Optional[ResourceOptions] = 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.

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.

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.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

IdentityId string

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

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.

ContainerName string

The name of storage container in the storage account.

IothubId string

The IoTHub ID for the endpoint.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

IdentityId string

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

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.

containerName String

The name of storage container in the storage account.

iothubId String

The IoTHub ID for the endpoint.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

identityId String

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

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.

containerName string

The name of storage container in the storage account.

iothubId string

The IoTHub ID for the endpoint.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

identityId string

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

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.

container_name str

The name of storage container in the storage account.

iothub_id str

The IoTHub ID for the endpoint.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

identity_id str

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

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.

containerName String

The name of storage container in the storage account.

iothubId String

The IoTHub ID for the endpoint.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

identityId String

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

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.

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 an 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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

IdentityId string

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

IothubId string

The IoTHub ID for the endpoint.

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.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

IdentityId string

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

IothubId string

The IoTHub ID for the endpoint.

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.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

identityId String

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

iothubId String

The IoTHub ID for the endpoint.

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.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

identityId string

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

iothubId string

The IoTHub ID for the endpoint.

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.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

identity_id str

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

iothub_id str

The IoTHub ID for the endpoint.

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.

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. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.

identityId String

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

iothubId String

The IoTHub ID for the endpoint.

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.

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.