Class 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.

Inheritance

System.Object

Resource

CustomResource

EndpointStorageContainer

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Iot

Assembly: Pulumi.Azure.dll

Syntax

public class EndpointStorageContainer : CustomResource

Constructors

EndpointStorageContainer(String, EndpointStorageContainerArgs, CustomResourceOptions)

Create a EndpointStorageContainer resource with the given unique name, arguments, and options.

Declaration

public EndpointStorageContainer(string name, EndpointStorageContainerArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EndpointStorageContainerArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

BatchFrequencyInSeconds

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

Declaration

public Output<int?> BatchFrequencyInSeconds { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

ConnectionString

The connection string for the endpoint.

Declaration

public Output<string> ConnectionString { get; }

Property Value

Type	Description
Output<System.String>

ContainerName

The name of storage container in the storage account. *

Declaration

public Output<string> ContainerName { get; }

Property Value

Type	Description
Output<System.String>

Encoding

Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avrodeflate'. Default value is 'avro'.

Declaration

public Output<string> Encoding { get; }

Property Value

Type	Description
Output<System.String>

FileNameFormat

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

Declaration

public Output<string> FileNameFormat { get; }

Property Value

Type	Description
Output<System.String>

IothubName

The name of the IoTHub to which this Storage Container Endpoint belongs. Changing this forces a new resource to be created.

Declaration

public Output<string> IothubName { get; }

Property Value

Type	Description
Output<System.String>

MaxChunkSizeInBytes

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

Declaration

public Output<int?> MaxChunkSizeInBytes { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Name

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, EndpointStorageContainerState, CustomResourceOptions)

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

Declaration

public static EndpointStorageContainer Get(string name, Input<string> id, EndpointStorageContainerState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EndpointStorageContainerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
EndpointStorageContainer