Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

getIotHubResource

The description of the IoT hub. API Version: 2020-08-31.

Using getIotHubResource

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIotHubResource(args: GetIotHubResourceArgs, opts?: InvokeOptions): Promise<GetIotHubResourceResult>
function getIotHubResourceOutput(args: GetIotHubResourceOutputArgs, opts?: InvokeOptions): Output<GetIotHubResourceResult>
def get_iot_hub_resource(resource_group_name: Optional[str] = None,
                         resource_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetIotHubResourceResult
def get_iot_hub_resource_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                         resource_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetIotHubResourceResult]
func LookupIotHubResource(ctx *Context, args *LookupIotHubResourceArgs, opts ...InvokeOption) (*LookupIotHubResourceResult, error)
func LookupIotHubResourceOutput(ctx *Context, args *LookupIotHubResourceOutputArgs, opts ...InvokeOption) LookupIotHubResourceResultOutput

> Note: This function is named LookupIotHubResource in the Go SDK.

public static class GetIotHubResource 
{
    public static Task<GetIotHubResourceResult> InvokeAsync(GetIotHubResourceArgs args, InvokeOptions? opts = null)
    public static Output<GetIotHubResourceResult> Invoke(GetIotHubResourceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetIotHubResourceResult> getIotHubResource(GetIotHubResourceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:devices:getIotHubResource
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ResourceGroupName string

The name of the resource group that contains the IoT hub.

ResourceName string

The name of the IoT hub.

ResourceGroupName string

The name of the resource group that contains the IoT hub.

ResourceName string

The name of the IoT hub.

resourceGroupName String

The name of the resource group that contains the IoT hub.

resourceName String

The name of the IoT hub.

resourceGroupName string

The name of the resource group that contains the IoT hub.

resourceName string

The name of the IoT hub.

resource_group_name str

The name of the resource group that contains the IoT hub.

resource_name str

The name of the IoT hub.

resourceGroupName String

The name of the resource group that contains the IoT hub.

resourceName String

The name of the IoT hub.

getIotHubResource Result

The following output properties are available:

Id string

The resource identifier.

Location string

The resource location.

Name string

The resource name.

Properties Pulumi.AzureNative.Devices.Outputs.IotHubPropertiesResponse

IotHub properties

Sku Pulumi.AzureNative.Devices.Outputs.IotHubSkuInfoResponse

IotHub SKU info

Type string

The resource type.

Etag string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.

Tags Dictionary<string, string>

The resource tags.

Id string

The resource identifier.

Location string

The resource location.

Name string

The resource name.

Properties IotHubPropertiesResponse

IotHub properties

Sku IotHubSkuInfoResponse

IotHub SKU info

Type string

The resource type.

Etag string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.

Tags map[string]string

The resource tags.

id String

The resource identifier.

location String

The resource location.

name String

The resource name.

properties IotHubPropertiesResponse

IotHub properties

sku IotHubSkuInfoResponse

IotHub SKU info

type String

The resource type.

etag String

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.

tags Map<String,String>

The resource tags.

id string

The resource identifier.

location string

The resource location.

name string

The resource name.

properties IotHubPropertiesResponse

IotHub properties

sku IotHubSkuInfoResponse

IotHub SKU info

type string

The resource type.

etag string

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.

tags {[key: string]: string}

The resource tags.

id str

The resource identifier.

location str

The resource location.

name str

The resource name.

properties IotHubPropertiesResponse

IotHub properties

sku IotHubSkuInfoResponse

IotHub SKU info

type str

The resource type.

etag str

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.

tags Mapping[str, str]

The resource tags.

id String

The resource identifier.

location String

The resource location.

name String

The resource name.

properties Property Map

IotHub properties

sku Property Map

IotHub SKU info

type String

The resource type.

etag String

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.

tags Map<String>

The resource tags.

Supporting Types

CloudToDevicePropertiesResponse

DefaultTtlAsIso8601 string

The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

Feedback Pulumi.AzureNative.Devices.Inputs.FeedbackPropertiesResponse

The properties of the feedback queue for cloud-to-device messages.

MaxDeliveryCount int

The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

DefaultTtlAsIso8601 string

The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

Feedback FeedbackPropertiesResponse

The properties of the feedback queue for cloud-to-device messages.

MaxDeliveryCount int

The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

defaultTtlAsIso8601 String

The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback FeedbackPropertiesResponse

The properties of the feedback queue for cloud-to-device messages.

maxDeliveryCount Integer

The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

defaultTtlAsIso8601 string

The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback FeedbackPropertiesResponse

The properties of the feedback queue for cloud-to-device messages.

maxDeliveryCount number

The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

default_ttl_as_iso8601 str

The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback FeedbackPropertiesResponse

The properties of the feedback queue for cloud-to-device messages.

max_delivery_count int

The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

defaultTtlAsIso8601 String

The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback Property Map

The properties of the feedback queue for cloud-to-device messages.

maxDeliveryCount Number

The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

EnrichmentPropertiesResponse

EndpointNames List<string>

The list of endpoints for which the enrichment is applied to the message.

Key string

The key or name for the enrichment property.

Value string

The value for the enrichment property.

EndpointNames []string

The list of endpoints for which the enrichment is applied to the message.

Key string

The key or name for the enrichment property.

Value string

The value for the enrichment property.

endpointNames List<String>

The list of endpoints for which the enrichment is applied to the message.

key String

The key or name for the enrichment property.

value String

The value for the enrichment property.

endpointNames string[]

The list of endpoints for which the enrichment is applied to the message.

key string

The key or name for the enrichment property.

value string

The value for the enrichment property.

endpoint_names Sequence[str]

The list of endpoints for which the enrichment is applied to the message.

key str

The key or name for the enrichment property.

value str

The value for the enrichment property.

endpointNames List<String>

The list of endpoints for which the enrichment is applied to the message.

key String

The key or name for the enrichment property.

value String

The value for the enrichment property.

EventHubPropertiesResponse

Endpoint string

The Event Hub-compatible endpoint.

PartitionIds List<string>

The partition ids in the Event Hub-compatible endpoint.

Path string

The Event Hub-compatible name.

PartitionCount int

The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

RetentionTimeInDays double

The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

Endpoint string

The Event Hub-compatible endpoint.

PartitionIds []string

The partition ids in the Event Hub-compatible endpoint.

Path string

The Event Hub-compatible name.

PartitionCount int

The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

RetentionTimeInDays float64

The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

endpoint String

The Event Hub-compatible endpoint.

partitionIds List<String>

The partition ids in the Event Hub-compatible endpoint.

path String

The Event Hub-compatible name.

partitionCount Integer

The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

retentionTimeInDays Double

The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

endpoint string

The Event Hub-compatible endpoint.

partitionIds string[]

The partition ids in the Event Hub-compatible endpoint.

path string

The Event Hub-compatible name.

partitionCount number

The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

retentionTimeInDays number

The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

endpoint str

The Event Hub-compatible endpoint.

partition_ids Sequence[str]

The partition ids in the Event Hub-compatible endpoint.

path str

The Event Hub-compatible name.

partition_count int

The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

retention_time_in_days float

The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

endpoint String

The Event Hub-compatible endpoint.

partitionIds List<String>

The partition ids in the Event Hub-compatible endpoint.

path String

The Event Hub-compatible name.

partitionCount Number

The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

retentionTimeInDays Number

The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRoutePropertiesResponse

EndpointNames List<string>

The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.

IsEnabled bool

Used to specify whether the fallback route is enabled.

Source string

The source to which the routing rule is to be applied to. For example, DeviceMessages

Condition string

The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

Name string

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

EndpointNames []string

The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.

IsEnabled bool

Used to specify whether the fallback route is enabled.

Source string

The source to which the routing rule is to be applied to. For example, DeviceMessages

Condition string

The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

Name string

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

endpointNames List<String>

The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.

isEnabled Boolean

Used to specify whether the fallback route is enabled.

source String

The source to which the routing rule is to be applied to. For example, DeviceMessages

condition String

The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

name String

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

endpointNames string[]

The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.

isEnabled boolean

Used to specify whether the fallback route is enabled.

source string

The source to which the routing rule is to be applied to. For example, DeviceMessages

condition string

The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

name string

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

endpoint_names Sequence[str]

The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.

is_enabled bool

Used to specify whether the fallback route is enabled.

source str

The source to which the routing rule is to be applied to. For example, DeviceMessages

condition str

The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

name str

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

endpointNames List<String>

The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.

isEnabled Boolean

Used to specify whether the fallback route is enabled.

source String

The source to which the routing rule is to be applied to. For example, DeviceMessages

condition String

The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

name String

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

FeedbackPropertiesResponse

LockDurationAsIso8601 string

The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

MaxDeliveryCount int

The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

TtlAsIso8601 string

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

LockDurationAsIso8601 string

The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

MaxDeliveryCount int

The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

TtlAsIso8601 string

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

lockDurationAsIso8601 String

The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

maxDeliveryCount Integer

The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttlAsIso8601 String

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

lockDurationAsIso8601 string

The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

maxDeliveryCount number

The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttlAsIso8601 string

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

lock_duration_as_iso8601 str

The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

max_delivery_count int

The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttl_as_iso8601 str

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

lockDurationAsIso8601 String

The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

maxDeliveryCount Number

The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttlAsIso8601 String

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubLocationDescriptionResponse

Location string

The name of the Azure region

Role string

The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.

Location string

The name of the Azure region

Role string

The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.

location String

The name of the Azure region

role String

The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.

location string

The name of the Azure region

role string

The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.

location str

The name of the Azure region

role str

The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.

location String

The name of the Azure region

role String

The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.

IotHubPropertiesResponse

HostName string

The name of the host.

Locations List<Pulumi.AzureNative.Devices.Inputs.IotHubLocationDescriptionResponse>

Primary and secondary location for iot hub

ProvisioningState string

The provisioning state.

State string

The hub state.

AuthorizationPolicies List<Pulumi.AzureNative.Devices.Inputs.SharedAccessSignatureAuthorizationRuleResponse>

The shared access policies you can use to secure a connection to the IoT hub.

CloudToDevice Pulumi.AzureNative.Devices.Inputs.CloudToDevicePropertiesResponse

The IoT hub cloud-to-device messaging properties.

Comments string

IoT hub comments.

EnableFileUploadNotifications bool

If True, file upload notifications are enabled.

EventHubEndpoints Dictionary<string, Pulumi.AzureNative.Devices.Inputs.EventHubPropertiesResponse>

The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.

Features string

The capabilities and features enabled for the IoT hub.

IpFilterRules List<Pulumi.AzureNative.Devices.Inputs.IpFilterRuleResponse>

The IP filter rules.

MessagingEndpoints Dictionary<string, Pulumi.AzureNative.Devices.Inputs.MessagingEndpointPropertiesResponse>

The messaging endpoint properties for the file upload notification queue.

MinTlsVersion string

Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.

NetworkRuleSets Pulumi.AzureNative.Devices.Inputs.NetworkRuleSetPropertiesResponse

Network Rule Set Properties of IotHub

PrivateEndpointConnections List<Pulumi.AzureNative.Devices.Inputs.PrivateEndpointConnectionResponse>

Private endpoint connections created on this IotHub

PublicNetworkAccess string

Whether requests from Public Network are allowed

Routing Pulumi.AzureNative.Devices.Inputs.RoutingPropertiesResponse

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

StorageEndpoints Dictionary<string, Pulumi.AzureNative.Devices.Inputs.StorageEndpointPropertiesResponse>

The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

HostName string

The name of the host.

Locations []IotHubLocationDescriptionResponse

Primary and secondary location for iot hub

ProvisioningState string

The provisioning state.

State string

The hub state.

AuthorizationPolicies []SharedAccessSignatureAuthorizationRuleResponse

The shared access policies you can use to secure a connection to the IoT hub.

CloudToDevice CloudToDevicePropertiesResponse

The IoT hub cloud-to-device messaging properties.

Comments string

IoT hub comments.

EnableFileUploadNotifications bool

If True, file upload notifications are enabled.

EventHubEndpoints map[string]EventHubPropertiesResponse

The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.

Features string

The capabilities and features enabled for the IoT hub.

IpFilterRules []IpFilterRuleResponse

The IP filter rules.

MessagingEndpoints map[string]MessagingEndpointPropertiesResponse

The messaging endpoint properties for the file upload notification queue.

MinTlsVersion string

Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.

NetworkRuleSets NetworkRuleSetPropertiesResponse

Network Rule Set Properties of IotHub

PrivateEndpointConnections []PrivateEndpointConnectionResponse

Private endpoint connections created on this IotHub

PublicNetworkAccess string

Whether requests from Public Network are allowed

Routing RoutingPropertiesResponse

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

StorageEndpoints map[string]StorageEndpointPropertiesResponse

The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

hostName String

The name of the host.

locations List<IotHubLocationDescriptionResponse>

Primary and secondary location for iot hub

provisioningState String

The provisioning state.

state String

The hub state.

authorizationPolicies List<SharedAccessSignatureAuthorizationRuleResponse>

The shared access policies you can use to secure a connection to the IoT hub.

cloudToDevice CloudToDevicePropertiesResponse

The IoT hub cloud-to-device messaging properties.

comments String

IoT hub comments.

enableFileUploadNotifications Boolean

If True, file upload notifications are enabled.

eventHubEndpoints Map<String,EventHubPropertiesResponse>

The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.

features String

The capabilities and features enabled for the IoT hub.

ipFilterRules List<IpFilterRuleResponse>

The IP filter rules.

messagingEndpoints Map<String,MessagingEndpointPropertiesResponse>

The messaging endpoint properties for the file upload notification queue.

minTlsVersion String

Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.

networkRuleSets NetworkRuleSetPropertiesResponse

Network Rule Set Properties of IotHub

privateEndpointConnections List<PrivateEndpointConnectionResponse>

Private endpoint connections created on this IotHub

publicNetworkAccess String

Whether requests from Public Network are allowed

routing RoutingPropertiesResponse

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

storageEndpoints Map<String,StorageEndpointPropertiesResponse>

The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

hostName string

The name of the host.

locations IotHubLocationDescriptionResponse[]

Primary and secondary location for iot hub

provisioningState string

The provisioning state.

state string

The hub state.

authorizationPolicies SharedAccessSignatureAuthorizationRuleResponse[]

The shared access policies you can use to secure a connection to the IoT hub.

cloudToDevice CloudToDevicePropertiesResponse

The IoT hub cloud-to-device messaging properties.

comments string

IoT hub comments.

enableFileUploadNotifications boolean

If True, file upload notifications are enabled.

eventHubEndpoints {[key: string]: EventHubPropertiesResponse}

The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.

features string

The capabilities and features enabled for the IoT hub.

ipFilterRules IpFilterRuleResponse[]

The IP filter rules.

messagingEndpoints {[key: string]: MessagingEndpointPropertiesResponse}

The messaging endpoint properties for the file upload notification queue.

minTlsVersion string

Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.

networkRuleSets NetworkRuleSetPropertiesResponse

Network Rule Set Properties of IotHub

privateEndpointConnections PrivateEndpointConnectionResponse[]

Private endpoint connections created on this IotHub

publicNetworkAccess string

Whether requests from Public Network are allowed

routing RoutingPropertiesResponse

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

storageEndpoints {[key: string]: StorageEndpointPropertiesResponse}

The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

host_name str

The name of the host.

locations Sequence[IotHubLocationDescriptionResponse]

Primary and secondary location for iot hub

provisioning_state str

The provisioning state.

state str

The hub state.

authorization_policies Sequence[SharedAccessSignatureAuthorizationRuleResponse]

The shared access policies you can use to secure a connection to the IoT hub.

cloud_to_device CloudToDevicePropertiesResponse

The IoT hub cloud-to-device messaging properties.

comments str

IoT hub comments.

enable_file_upload_notifications bool

If True, file upload notifications are enabled.

event_hub_endpoints Mapping[str, EventHubPropertiesResponse]

The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.

features str

The capabilities and features enabled for the IoT hub.

ip_filter_rules Sequence[IpFilterRuleResponse]

The IP filter rules.

messaging_endpoints Mapping[str, MessagingEndpointPropertiesResponse]

The messaging endpoint properties for the file upload notification queue.

min_tls_version str

Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.

network_rule_sets NetworkRuleSetPropertiesResponse

Network Rule Set Properties of IotHub

private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]

Private endpoint connections created on this IotHub

public_network_access str

Whether requests from Public Network are allowed

routing RoutingPropertiesResponse

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

storage_endpoints Mapping[str, StorageEndpointPropertiesResponse]

The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

hostName String

The name of the host.

locations List<Property Map>

Primary and secondary location for iot hub

provisioningState String

The provisioning state.

state String

The hub state.

authorizationPolicies List<Property Map>

The shared access policies you can use to secure a connection to the IoT hub.

cloudToDevice Property Map

The IoT hub cloud-to-device messaging properties.

comments String

IoT hub comments.

enableFileUploadNotifications Boolean

If True, file upload notifications are enabled.

eventHubEndpoints Map<Property Map>

The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.

features String

The capabilities and features enabled for the IoT hub.

ipFilterRules List<Property Map>

The IP filter rules.

messagingEndpoints Map<Property Map>

The messaging endpoint properties for the file upload notification queue.

minTlsVersion String

Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.

networkRuleSets Property Map

Network Rule Set Properties of IotHub

privateEndpointConnections List<Property Map>

Private endpoint connections created on this IotHub

publicNetworkAccess String

Whether requests from Public Network are allowed

routing Property Map

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

storageEndpoints Map<Property Map>

The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

IotHubSkuInfoResponse

Name string

The name of the SKU.

Tier string

The billing tier for the IoT hub.

Capacity double

The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

Name string

The name of the SKU.

Tier string

The billing tier for the IoT hub.

Capacity float64

The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name String

The name of the SKU.

tier String

The billing tier for the IoT hub.

capacity Double

The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name string

The name of the SKU.

tier string

The billing tier for the IoT hub.

capacity number

The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name str

The name of the SKU.

tier str

The billing tier for the IoT hub.

capacity float

The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name String

The name of the SKU.

tier String

The billing tier for the IoT hub.

capacity Number

The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

IpFilterRuleResponse

Action string

The desired action for requests captured by this rule.

FilterName string

The name of the IP filter rule.

IpMask string

A string that contains the IP address range in CIDR notation for the rule.

Action string

The desired action for requests captured by this rule.

FilterName string

The name of the IP filter rule.

IpMask string

A string that contains the IP address range in CIDR notation for the rule.

action String

The desired action for requests captured by this rule.

filterName String

The name of the IP filter rule.

ipMask String

A string that contains the IP address range in CIDR notation for the rule.

action string

The desired action for requests captured by this rule.

filterName string

The name of the IP filter rule.

ipMask string

A string that contains the IP address range in CIDR notation for the rule.

action str

The desired action for requests captured by this rule.

filter_name str

The name of the IP filter rule.

ip_mask str

A string that contains the IP address range in CIDR notation for the rule.

action String

The desired action for requests captured by this rule.

filterName String

The name of the IP filter rule.

ipMask String

A string that contains the IP address range in CIDR notation for the rule.

MessagingEndpointPropertiesResponse

LockDurationAsIso8601 string

The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

MaxDeliveryCount int

The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

TtlAsIso8601 string

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

LockDurationAsIso8601 string

The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

MaxDeliveryCount int

The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

TtlAsIso8601 string

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

lockDurationAsIso8601 String

The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

maxDeliveryCount Integer

The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttlAsIso8601 String

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

lockDurationAsIso8601 string

The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

maxDeliveryCount number

The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttlAsIso8601 string

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

lock_duration_as_iso8601 str

The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

max_delivery_count int

The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttl_as_iso8601 str

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

lockDurationAsIso8601 String

The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

maxDeliveryCount Number

The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttlAsIso8601 String

The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleSetIpRuleResponse

FilterName string

Name of the IP filter rule.

IpMask string

A string that contains the IP address range in CIDR notation for the rule.

Action string

IP Filter Action

FilterName string

Name of the IP filter rule.

IpMask string

A string that contains the IP address range in CIDR notation for the rule.

Action string

IP Filter Action

filterName String

Name of the IP filter rule.

ipMask String

A string that contains the IP address range in CIDR notation for the rule.

action String

IP Filter Action

filterName string

Name of the IP filter rule.

ipMask string

A string that contains the IP address range in CIDR notation for the rule.

action string

IP Filter Action

filter_name str

Name of the IP filter rule.

ip_mask str

A string that contains the IP address range in CIDR notation for the rule.

action str

IP Filter Action

filterName String

Name of the IP filter rule.

ipMask String

A string that contains the IP address range in CIDR notation for the rule.

action String

IP Filter Action

NetworkRuleSetPropertiesResponse

ApplyToBuiltInEventHubEndpoint bool

If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub

IpRules List<Pulumi.AzureNative.Devices.Inputs.NetworkRuleSetIpRuleResponse>

List of IP Rules

DefaultAction string

Default Action for Network Rule Set

ApplyToBuiltInEventHubEndpoint bool

If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub

IpRules []NetworkRuleSetIpRuleResponse

List of IP Rules

DefaultAction string

Default Action for Network Rule Set

applyToBuiltInEventHubEndpoint Boolean

If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub

ipRules List<NetworkRuleSetIpRuleResponse>

List of IP Rules

defaultAction String

Default Action for Network Rule Set

applyToBuiltInEventHubEndpoint boolean

If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub

ipRules NetworkRuleSetIpRuleResponse[]

List of IP Rules

defaultAction string

Default Action for Network Rule Set

apply_to_built_in_event_hub_endpoint bool

If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub

ip_rules Sequence[NetworkRuleSetIpRuleResponse]

List of IP Rules

default_action str

Default Action for Network Rule Set

applyToBuiltInEventHubEndpoint Boolean

If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub

ipRules List<Property Map>

List of IP Rules

defaultAction String

Default Action for Network Rule Set

PrivateEndpointConnectionPropertiesResponse

PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

The current state of a private endpoint connection

PrivateEndpoint PrivateEndpointResponse

The private endpoint property of a private endpoint connection

privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

The current state of a private endpoint connection

privateEndpoint PrivateEndpointResponse

The private endpoint property of a private endpoint connection

privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

The current state of a private endpoint connection

privateEndpoint PrivateEndpointResponse

The private endpoint property of a private endpoint connection

private_link_service_connection_state PrivateLinkServiceConnectionStateResponse

The current state of a private endpoint connection

private_endpoint PrivateEndpointResponse

The private endpoint property of a private endpoint connection

privateLinkServiceConnectionState Property Map

The current state of a private endpoint connection

privateEndpoint Property Map

The private endpoint property of a private endpoint connection

PrivateEndpointConnectionResponse

Id string

The resource identifier.

Name string

The resource name.

Properties Pulumi.AzureNative.Devices.Inputs.PrivateEndpointConnectionPropertiesResponse

The properties of a private endpoint connection

Type string

The resource type.

Id string

The resource identifier.

Name string

The resource name.

Properties PrivateEndpointConnectionPropertiesResponse

The properties of a private endpoint connection

Type string

The resource type.

id String

The resource identifier.

name String

The resource name.

properties PrivateEndpointConnectionPropertiesResponse

The properties of a private endpoint connection

type String

The resource type.

id string

The resource identifier.

name string

The resource name.

properties PrivateEndpointConnectionPropertiesResponse

The properties of a private endpoint connection

type string

The resource type.

id str

The resource identifier.

name str

The resource name.

properties PrivateEndpointConnectionPropertiesResponse

The properties of a private endpoint connection

type str

The resource type.

id String

The resource identifier.

name String

The resource name.

properties Property Map

The properties of a private endpoint connection

type String

The resource type.

PrivateEndpointResponse

Id string

The resource identifier.

Id string

The resource identifier.

id String

The resource identifier.

id string

The resource identifier.

id str

The resource identifier.

id String

The resource identifier.

PrivateLinkServiceConnectionStateResponse

Description string

The description for the current state of a private endpoint connection

Status string

The status of a private endpoint connection

ActionsRequired string

Actions required for a private endpoint connection

Description string

The description for the current state of a private endpoint connection

Status string

The status of a private endpoint connection

ActionsRequired string

Actions required for a private endpoint connection

description String

The description for the current state of a private endpoint connection

status String

The status of a private endpoint connection

actionsRequired String

Actions required for a private endpoint connection

description string

The description for the current state of a private endpoint connection

status string

The status of a private endpoint connection

actionsRequired string

Actions required for a private endpoint connection

description str

The description for the current state of a private endpoint connection

status str

The status of a private endpoint connection

actions_required str

Actions required for a private endpoint connection

description String

The description for the current state of a private endpoint connection

status String

The status of a private endpoint connection

actionsRequired String

Actions required for a private endpoint connection

RoutePropertiesResponse

EndpointNames List<string>

The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.

IsEnabled bool

Used to specify whether a route is enabled.

Name string

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

Source string

The source that the routing rule is to be applied to, such as DeviceMessages.

Condition string

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

EndpointNames []string

The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.

IsEnabled bool

Used to specify whether a route is enabled.

Name string

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

Source string

The source that the routing rule is to be applied to, such as DeviceMessages.

Condition string

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames List<String>

The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.

isEnabled Boolean

Used to specify whether a route is enabled.

name String

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

source String

The source that the routing rule is to be applied to, such as DeviceMessages.

condition String

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames string[]

The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.

isEnabled boolean

Used to specify whether a route is enabled.

name string

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

source string

The source that the routing rule is to be applied to, such as DeviceMessages.

condition string

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpoint_names Sequence[str]

The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.

is_enabled bool

Used to specify whether a route is enabled.

name str

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

source str

The source that the routing rule is to be applied to, such as DeviceMessages.

condition str

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames List<String>

The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.

isEnabled Boolean

Used to specify whether a route is enabled.

name String

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

source String

The source that the routing rule is to be applied to, such as DeviceMessages.

condition String

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

RoutingEndpointsResponse

EventHubs List<Pulumi.AzureNative.Devices.Inputs.RoutingEventHubPropertiesResponse>

The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.

ServiceBusQueues List<Pulumi.AzureNative.Devices.Inputs.RoutingServiceBusQueueEndpointPropertiesResponse>

The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.

ServiceBusTopics List<Pulumi.AzureNative.Devices.Inputs.RoutingServiceBusTopicEndpointPropertiesResponse>

The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.

StorageContainers List<Pulumi.AzureNative.Devices.Inputs.RoutingStorageContainerPropertiesResponse>

The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.

EventHubs []RoutingEventHubPropertiesResponse

The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.

ServiceBusQueues []RoutingServiceBusQueueEndpointPropertiesResponse

The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.

ServiceBusTopics []RoutingServiceBusTopicEndpointPropertiesResponse

The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.

StorageContainers []RoutingStorageContainerPropertiesResponse

The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.

eventHubs List<RoutingEventHubPropertiesResponse>

The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.

serviceBusQueues List<RoutingServiceBusQueueEndpointPropertiesResponse>

The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.

serviceBusTopics List<RoutingServiceBusTopicEndpointPropertiesResponse>

The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.

storageContainers List<RoutingStorageContainerPropertiesResponse>

The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.

eventHubs RoutingEventHubPropertiesResponse[]

The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.

serviceBusQueues RoutingServiceBusQueueEndpointPropertiesResponse[]

The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.

serviceBusTopics RoutingServiceBusTopicEndpointPropertiesResponse[]

The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.

storageContainers RoutingStorageContainerPropertiesResponse[]

The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.

event_hubs Sequence[RoutingEventHubPropertiesResponse]

The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.

service_bus_queues Sequence[RoutingServiceBusQueueEndpointPropertiesResponse]

The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.

service_bus_topics Sequence[RoutingServiceBusTopicEndpointPropertiesResponse]

The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.

storage_containers Sequence[RoutingStorageContainerPropertiesResponse]

The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.

eventHubs List<Property Map>

The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.

serviceBusQueues List<Property Map>

The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.

serviceBusTopics List<Property Map>

The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.

storageContainers List<Property Map>

The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.

RoutingEventHubPropertiesResponse

Name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

AuthenticationType string

Method used to authenticate against the event hub endpoint

ConnectionString string

The connection string of the event hub endpoint.

EndpointUri string

The url of the event hub endpoint. It must include the protocol sb://

EntityPath string

Event hub name on the event hub namespace

Id string

Id of the event hub endpoint

ResourceGroup string

The name of the resource group of the event hub endpoint.

SubscriptionId string

The subscription identifier of the event hub endpoint.

Name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

AuthenticationType string

Method used to authenticate against the event hub endpoint

ConnectionString string

The connection string of the event hub endpoint.

EndpointUri string

The url of the event hub endpoint. It must include the protocol sb://

EntityPath string

Event hub name on the event hub namespace

Id string

Id of the event hub endpoint

ResourceGroup string

The name of the resource group of the event hub endpoint.

SubscriptionId string

The subscription identifier of the event hub endpoint.

name String

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

authenticationType String

Method used to authenticate against the event hub endpoint

connectionString String

The connection string of the event hub endpoint.

endpointUri String

The url of the event hub endpoint. It must include the protocol sb://

entityPath String

Event hub name on the event hub namespace

id String

Id of the event hub endpoint

resourceGroup String

The name of the resource group of the event hub endpoint.

subscriptionId String

The subscription identifier of the event hub endpoint.

name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

authenticationType string

Method used to authenticate against the event hub endpoint

connectionString string

The connection string of the event hub endpoint.

endpointUri string

The url of the event hub endpoint. It must include the protocol sb://

entityPath string

Event hub name on the event hub namespace

id string

Id of the event hub endpoint

resourceGroup string

The name of the resource group of the event hub endpoint.

subscriptionId string

The subscription identifier of the event hub endpoint.

name str

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

authentication_type str

Method used to authenticate against the event hub endpoint

connection_string str

The connection string of the event hub endpoint.

endpoint_uri str

The url of the event hub endpoint. It must include the protocol sb://

entity_path str

Event hub name on the event hub namespace

id str

Id of the event hub endpoint

resource_group str

The name of the resource group of the event hub endpoint.

subscription_id str

The subscription identifier of the event hub endpoint.

name String

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

authenticationType String

Method used to authenticate against the event hub endpoint

connectionString String

The connection string of the event hub endpoint.

endpointUri String

The url of the event hub endpoint. It must include the protocol sb://

entityPath String

Event hub name on the event hub namespace

id String

Id of the event hub endpoint

resourceGroup String

The name of the resource group of the event hub endpoint.

subscriptionId String

The subscription identifier of the event hub endpoint.

RoutingPropertiesResponse

Endpoints Pulumi.AzureNative.Devices.Inputs.RoutingEndpointsResponse

The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

Enrichments List<Pulumi.AzureNative.Devices.Inputs.EnrichmentPropertiesResponse>

The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid

FallbackRoute Pulumi.AzureNative.Devices.Inputs.FallbackRoutePropertiesResponse

The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.

Routes List<Pulumi.AzureNative.Devices.Inputs.RoutePropertiesResponse>

The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.

Endpoints RoutingEndpointsResponse

The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

Enrichments []EnrichmentPropertiesResponse

The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid

FallbackRoute FallbackRoutePropertiesResponse

The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.

Routes []RoutePropertiesResponse

The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.

endpoints RoutingEndpointsResponse

The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

enrichments List<EnrichmentPropertiesResponse>

The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid

fallbackRoute FallbackRoutePropertiesResponse

The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.

routes List<RoutePropertiesResponse>

The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.

endpoints RoutingEndpointsResponse

The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

enrichments EnrichmentPropertiesResponse[]

The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid

fallbackRoute FallbackRoutePropertiesResponse

The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.

routes RoutePropertiesResponse[]

The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.

endpoints RoutingEndpointsResponse

The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

enrichments Sequence[EnrichmentPropertiesResponse]

The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid

fallback_route FallbackRoutePropertiesResponse

The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.

routes Sequence[RoutePropertiesResponse]

The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.

endpoints Property Map

The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

enrichments List<Property Map>

The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid

fallbackRoute Property Map

The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.

routes List<Property Map>

The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.

RoutingServiceBusQueueEndpointPropertiesResponse

Name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.

AuthenticationType string

Method used to authenticate against the service bus queue endpoint

ConnectionString string

The connection string of the service bus queue endpoint.

EndpointUri string

The url of the service bus queue endpoint. It must include the protocol sb://

EntityPath string

Queue name on the service bus namespace

Id string

Id of the service bus queue endpoint

ResourceGroup string

The name of the resource group of the service bus queue endpoint.

SubscriptionId string

The subscription identifier of the service bus queue endpoint.

Name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.

AuthenticationType string

Method used to authenticate against the service bus queue endpoint

ConnectionString string

The connection string of the service bus queue endpoint.

EndpointUri string

The url of the service bus queue endpoint. It must include the protocol sb://

EntityPath string

Queue name on the service bus namespace

Id string

Id of the service bus queue endpoint

ResourceGroup string

The name of the resource group of the service bus queue endpoint.

SubscriptionId string

The subscription identifier of the service bus queue endpoint.

name String

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.

authenticationType String

Method used to authenticate against the service bus queue endpoint

connectionString String

The connection string of the service bus queue endpoint.

endpointUri String

The url of the service bus queue endpoint. It must include the protocol sb://

entityPath String

Queue name on the service bus namespace

id String

Id of the service bus queue endpoint

resourceGroup String

The name of the resource group of the service bus queue endpoint.

subscriptionId String

The subscription identifier of the service bus queue endpoint.

name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.

authenticationType string

Method used to authenticate against the service bus queue endpoint

connectionString string

The connection string of the service bus queue endpoint.

endpointUri string

The url of the service bus queue endpoint. It must include the protocol sb://

entityPath string

Queue name on the service bus namespace

id string

Id of the service bus queue endpoint

resourceGroup string

The name of the resource group of the service bus queue endpoint.

subscriptionId string

The subscription identifier of the service bus queue endpoint.

name str

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.

authentication_type str

Method used to authenticate against the service bus queue endpoint

connection_string str

The connection string of the service bus queue endpoint.

endpoint_uri str

The url of the service bus queue endpoint. It must include the protocol sb://

entity_path str

Queue name on the service bus namespace

id str

Id of the service bus queue endpoint

resource_group str

The name of the resource group of the service bus queue endpoint.

subscription_id str

The subscription identifier of the service bus queue endpoint.

name String

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.

authenticationType String

Method used to authenticate against the service bus queue endpoint

connectionString String

The connection string of the service bus queue endpoint.

endpointUri String

The url of the service bus queue endpoint. It must include the protocol sb://

entityPath String

Queue name on the service bus namespace

id String

Id of the service bus queue endpoint

resourceGroup String

The name of the resource group of the service bus queue endpoint.

subscriptionId String

The subscription identifier of the service bus queue endpoint.

RoutingServiceBusTopicEndpointPropertiesResponse

Name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.

AuthenticationType string

Method used to authenticate against the service bus topic endpoint

ConnectionString string

The connection string of the service bus topic endpoint.

EndpointUri string

The url of the service bus topic endpoint. It must include the protocol sb://

EntityPath string

Queue name on the service bus topic

Id string

Id of the service bus topic endpoint

ResourceGroup string

The name of the resource group of the service bus topic endpoint.

SubscriptionId string

The subscription identifier of the service bus topic endpoint.

Name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.

AuthenticationType string

Method used to authenticate against the service bus topic endpoint

ConnectionString string

The connection string of the service bus topic endpoint.

EndpointUri string

The url of the service bus topic endpoint. It must include the protocol sb://

EntityPath string

Queue name on the service bus topic

Id string

Id of the service bus topic endpoint

ResourceGroup string

The name of the resource group of the service bus topic endpoint.

SubscriptionId string

The subscription identifier of the service bus topic endpoint.

name String

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.

authenticationType String

Method used to authenticate against the service bus topic endpoint

connectionString String

The connection string of the service bus topic endpoint.

endpointUri String

The url of the service bus topic endpoint. It must include the protocol sb://

entityPath String

Queue name on the service bus topic

id String

Id of the service bus topic endpoint

resourceGroup String

The name of the resource group of the service bus topic endpoint.

subscriptionId String

The subscription identifier of the service bus topic endpoint.

name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.

authenticationType string

Method used to authenticate against the service bus topic endpoint

connectionString string

The connection string of the service bus topic endpoint.

endpointUri string

The url of the service bus topic endpoint. It must include the protocol sb://

entityPath string

Queue name on the service bus topic

id string

Id of the service bus topic endpoint

resourceGroup string

The name of the resource group of the service bus topic endpoint.

subscriptionId string

The subscription identifier of the service bus topic endpoint.

name str

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.

authentication_type str

Method used to authenticate against the service bus topic endpoint

connection_string str

The connection string of the service bus topic endpoint.

endpoint_uri str

The url of the service bus topic endpoint. It must include the protocol sb://

entity_path str

Queue name on the service bus topic

id str

Id of the service bus topic endpoint

resource_group str

The name of the resource group of the service bus topic endpoint.

subscription_id str

The subscription identifier of the service bus topic endpoint.

name String

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.

authenticationType String

Method used to authenticate against the service bus topic endpoint

connectionString String

The connection string of the service bus topic endpoint.

endpointUri String

The url of the service bus topic endpoint. It must include the protocol sb://

entityPath String

Queue name on the service bus topic

id String

Id of the service bus topic endpoint

resourceGroup String

The name of the resource group of the service bus topic endpoint.

subscriptionId String

The subscription identifier of the service bus topic endpoint.

RoutingStorageContainerPropertiesResponse

ContainerName string

The name of storage container in the storage account.

Name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

AuthenticationType string

Method used to authenticate against the storage endpoint

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 of 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'.

EndpointUri string

The url of the storage endpoint. It must include the protocol https://

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.

Id string

Id of the storage container 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).

ResourceGroup string

The name of the resource group of the storage account.

SubscriptionId string

The subscription identifier of the storage account.

ContainerName string

The name of storage container in the storage account.

Name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

AuthenticationType string

Method used to authenticate against the storage endpoint

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 of 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'.

EndpointUri string

The url of the storage endpoint. It must include the protocol https://

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.

Id string

Id of the storage container 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).

ResourceGroup string

The name of the resource group of the storage account.

SubscriptionId string

The subscription identifier of the storage account.

containerName String

The name of storage container in the storage account.

name String

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

authenticationType String

Method used to authenticate against the storage endpoint

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 of 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'.

endpointUri String

The url of the storage endpoint. It must include the protocol https://

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.

id String

Id of the storage container 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).

resourceGroup String

The name of the resource group of the storage account.

subscriptionId String

The subscription identifier of the storage account.

containerName string

The name of storage container in the storage account.

name string

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

authenticationType string

Method used to authenticate against the storage endpoint

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 of 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'.

endpointUri string

The url of the storage endpoint. It must include the protocol https://

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.

id string

Id of the storage container 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).

resourceGroup string

The name of the resource group of the storage account.

subscriptionId string

The subscription identifier of the storage account.

container_name str

The name of storage container in the storage account.

name str

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

authentication_type str

Method used to authenticate against the storage endpoint

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 of 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'.

endpoint_uri str

The url of the storage endpoint. It must include the protocol https://

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.

id str

Id of the storage container 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).

resource_group str

The name of the resource group of the storage account.

subscription_id str

The subscription identifier of the storage account.

containerName String

The name of storage container in the storage account.

name String

The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.

authenticationType String

Method used to authenticate against the storage endpoint

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 of 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'.

endpointUri String

The url of the storage endpoint. It must include the protocol https://

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.

id String

Id of the storage container 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).

resourceGroup String

The name of the resource group of the storage account.

subscriptionId String

The subscription identifier of the storage account.

SharedAccessSignatureAuthorizationRuleResponse

KeyName string

The name of the shared access policy.

Rights string

The permissions assigned to the shared access policy.

PrimaryKey string

The primary key.

SecondaryKey string

The secondary key.

KeyName string

The name of the shared access policy.

Rights string

The permissions assigned to the shared access policy.

PrimaryKey string

The primary key.

SecondaryKey string

The secondary key.

keyName String

The name of the shared access policy.

rights String

The permissions assigned to the shared access policy.

primaryKey String

The primary key.

secondaryKey String

The secondary key.

keyName string

The name of the shared access policy.

rights string

The permissions assigned to the shared access policy.

primaryKey string

The primary key.

secondaryKey string

The secondary key.

key_name str

The name of the shared access policy.

rights str

The permissions assigned to the shared access policy.

primary_key str

The primary key.

secondary_key str

The secondary key.

keyName String

The name of the shared access policy.

rights String

The permissions assigned to the shared access policy.

primaryKey String

The primary key.

secondaryKey String

The secondary key.

StorageEndpointPropertiesResponse

ConnectionString string

The connection string for the Azure Storage account to which files are uploaded.

ContainerName string

The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.

AuthenticationType string

Specifies authentication type being used for connecting to the storage account.

SasTtlAsIso8601 string

The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

ConnectionString string

The connection string for the Azure Storage account to which files are uploaded.

ContainerName string

The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.

AuthenticationType string

Specifies authentication type being used for connecting to the storage account.

SasTtlAsIso8601 string

The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

connectionString String

The connection string for the Azure Storage account to which files are uploaded.

containerName String

The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.

authenticationType String

Specifies authentication type being used for connecting to the storage account.

sasTtlAsIso8601 String

The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

connectionString string

The connection string for the Azure Storage account to which files are uploaded.

containerName string

The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.

authenticationType string

Specifies authentication type being used for connecting to the storage account.

sasTtlAsIso8601 string

The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

connection_string str

The connection string for the Azure Storage account to which files are uploaded.

container_name str

The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.

authentication_type str

Specifies authentication type being used for connecting to the storage account.

sas_ttl_as_iso8601 str

The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

connectionString String

The connection string for the Azure Storage account to which files are uploaded.

containerName String

The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.

authenticationType String

Specifies authentication type being used for connecting to the storage account.

sasTtlAsIso8601 String

The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

Package Details

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