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

EndpointStorageContainerArgs

data class EndpointStorageContainerArgs(val authenticationType: Output<String>? = null, val batchFrequencyInSeconds: Output<Int>? = null, val connectionString: Output<String>? = null, val containerName: Output<String>? = null, val encoding: Output<String>? = null, val endpointUri: Output<String>? = null, val fileNameFormat: Output<String>? = null, val identityId: Output<String>? = null, val iothubId: Output<String>? = null, val maxChunkSizeInBytes: Output<Int>? = null, val name: Output<String>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<EndpointStorageContainerArgs>

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

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());
    }
}
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
fun EndpointStorageContainerArgs(authenticationType: Output<String>? = null, batchFrequencyInSeconds: Output<Int>? = null, connectionString: Output<String>? = null, containerName: Output<String>? = null, encoding: Output<String>? = null, endpointUri: Output<String>? = null, fileNameFormat: Output<String>? = null, identityId: Output<String>? = null, iothubId: Output<String>? = null, maxChunkSizeInBytes: Output<Int>? = null, name: Output<String>? = null, resourceGroupName: Output<String>? = null)

Functions

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

Properties

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

Type used to authenticate against the storage endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.

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

Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.

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

The connection string for the endpoint. This attribute can only be specified and is mandatory when authentication_type is keyBased.

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

The name of storage container in the storage account.

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

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.

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

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.

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

File name format for the blob. Default format is `{iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}`. All parameters are mandatory but can be reordered.

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

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

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

The IoTHub ID for the endpoint. Changing this forces a new resource to be created.

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

Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).

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

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.

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

The name of the resource group under which the Storage Container has been created. Changing this forces a new resource to be created.