1. Packages
  2. Azure Native
  3. API Docs
  4. iothub
  5. getIotHubResource
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.iothub.getIotHubResource

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Get the non-security related metadata of an IoT hub.

Uses Azure REST API version 2023-06-30.

Other available API versions: 2016-02-03, 2017-01-19, 2017-07-01, 2018-01-22, 2018-04-01, 2018-12-01-preview, 2019-03-22, 2019-03-22-preview, 2019-07-01-preview, 2019-11-04, 2020-03-01, 2020-04-01, 2020-06-15, 2020-07-10-preview, 2020-08-01, 2020-08-31, 2020-08-31-preview, 2021-02-01-preview, 2021-03-03-preview, 2021-03-31, 2021-07-01, 2021-07-01-preview, 2021-07-02, 2021-07-02-preview, 2022-04-30-preview, 2022-11-15-preview, 2023-06-30-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native iothub [ApiVersion]. See the version guide for details.

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>
Copy
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]
Copy
func LookupIotHubResource(ctx *Context, args *LookupIotHubResourceArgs, opts ...InvokeOption) (*LookupIotHubResourceResult, error)
func LookupIotHubResourceOutput(ctx *Context, args *LookupIotHubResourceOutputArgs, opts ...InvokeOption) LookupIotHubResourceResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetIotHubResourceResult> getIotHubResource(GetIotHubResourceArgs args, InvokeOptions options)
public static Output<GetIotHubResourceResult> getIotHubResource(GetIotHubResourceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:iothub:getIotHubResource
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the IoT hub.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoT hub.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the IoT hub.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoT hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the IoT hub.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the IoT hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the IoT hub.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoT hub.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the IoT hub.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the IoT hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the IoT hub.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the IoT hub.

getIotHubResource Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
The resource identifier.
Location string
The resource location.
Name string
The resource name.
Properties Pulumi.AzureNative.IoTHub.Outputs.IotHubPropertiesResponse
IotHub properties
Sku Pulumi.AzureNative.IoTHub.Outputs.IotHubSkuInfoResponse
IotHub SKU info
SystemData Pulumi.AzureNative.IoTHub.Outputs.SystemDataResponse
The system meta data relating to this resource.
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.
Identity Pulumi.AzureNative.IoTHub.Outputs.ArmIdentityResponse
The managed identities for the IotHub.
Tags Dictionary<string, string>
The resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
The resource identifier.
Location string
The resource location.
Name string
The resource name.
Properties IotHubPropertiesResponse
IotHub properties
Sku IotHubSkuInfoResponse
IotHub SKU info
SystemData SystemDataResponse
The system meta data relating to this resource.
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.
Identity ArmIdentityResponse
The managed identities for the IotHub.
Tags map[string]string
The resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
The resource identifier.
location String
The resource location.
name String
The resource name.
properties IotHubPropertiesResponse
IotHub properties
sku IotHubSkuInfoResponse
IotHub SKU info
systemData SystemDataResponse
The system meta data relating to this resource.
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.
identity ArmIdentityResponse
The managed identities for the IotHub.
tags Map<String,String>
The resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
The resource identifier.
location string
The resource location.
name string
The resource name.
properties IotHubPropertiesResponse
IotHub properties
sku IotHubSkuInfoResponse
IotHub SKU info
systemData SystemDataResponse
The system meta data relating to this resource.
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.
identity ArmIdentityResponse
The managed identities for the IotHub.
tags {[key: string]: string}
The resource tags.
azure_api_version str
The Azure API version of the resource.
id str
The resource identifier.
location str
The resource location.
name str
The resource name.
properties IotHubPropertiesResponse
IotHub properties
sku IotHubSkuInfoResponse
IotHub SKU info
system_data SystemDataResponse
The system meta data relating to this resource.
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.
identity ArmIdentityResponse
The managed identities for the IotHub.
tags Mapping[str, str]
The resource tags.
azureApiVersion String
The Azure API version of the resource.
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
systemData Property Map
The system meta data relating to this resource.
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.
identity Property Map
The managed identities for the IotHub.
tags Map<String>
The resource tags.

Supporting Types

ArmIdentityResponse

PrincipalId This property is required. string
Principal Id
TenantId This property is required. string
Tenant Id
Type string
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.IoTHub.Inputs.ArmUserIdentityResponse>
PrincipalId This property is required. string
Principal Id
TenantId This property is required. string
Tenant Id
Type string
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
UserAssignedIdentities map[string]ArmUserIdentityResponse
principalId This property is required. String
Principal Id
tenantId This property is required. String
Tenant Id
type String
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities Map<String,ArmUserIdentityResponse>
principalId This property is required. string
Principal Id
tenantId This property is required. string
Tenant Id
type string
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities {[key: string]: ArmUserIdentityResponse}
principal_id This property is required. str
Principal Id
tenant_id This property is required. str
Tenant Id
type str
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
user_assigned_identities Mapping[str, ArmUserIdentityResponse]
principalId This property is required. String
Principal Id
tenantId This property is required. String
Tenant Id
type String
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities Map<Property Map>

ArmUserIdentityResponse

ClientId This property is required. string
PrincipalId This property is required. string
ClientId This property is required. string
PrincipalId This property is required. string
clientId This property is required. String
principalId This property is required. String
clientId This property is required. string
principalId This property is required. string
client_id This property is required. str
principal_id This property is required. str
clientId This property is required. String
principalId This property is required. String

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.IoTHub.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 This property is required. List<string>
The list of endpoints for which the enrichment is applied to the message.
Key This property is required. string
The key or name for the enrichment property.
Value This property is required. string
The value for the enrichment property.
EndpointNames This property is required. []string
The list of endpoints for which the enrichment is applied to the message.
Key This property is required. string
The key or name for the enrichment property.
Value This property is required. string
The value for the enrichment property.
endpointNames This property is required. List<String>
The list of endpoints for which the enrichment is applied to the message.
key This property is required. String
The key or name for the enrichment property.
value This property is required. String
The value for the enrichment property.
endpointNames This property is required. string[]
The list of endpoints for which the enrichment is applied to the message.
key This property is required. string
The key or name for the enrichment property.
value This property is required. string
The value for the enrichment property.
endpoint_names This property is required. Sequence[str]
The list of endpoints for which the enrichment is applied to the message.
key This property is required. str
The key or name for the enrichment property.
value This property is required. str
The value for the enrichment property.
endpointNames This property is required. List<String>
The list of endpoints for which the enrichment is applied to the message.
key This property is required. String
The key or name for the enrichment property.
value This property is required. String
The value for the enrichment property.

EventHubPropertiesResponse

Endpoint This property is required. string
The Event Hub-compatible endpoint.
PartitionIds This property is required. List<string>
The partition ids in the Event Hub-compatible endpoint.
Path This property is required. 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 This property is required. string
The Event Hub-compatible endpoint.
PartitionIds This property is required. []string
The partition ids in the Event Hub-compatible endpoint.
Path This property is required. 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 This property is required. String
The Event Hub-compatible endpoint.
partitionIds This property is required. List<String>
The partition ids in the Event Hub-compatible endpoint.
path This property is required. 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 This property is required. string
The Event Hub-compatible endpoint.
partitionIds This property is required. string[]
The partition ids in the Event Hub-compatible endpoint.
path This property is required. 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 This property is required. str
The Event Hub-compatible endpoint.
partition_ids This property is required. Sequence[str]
The partition ids in the Event Hub-compatible endpoint.
path This property is required. 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 This property is required. String
The Event Hub-compatible endpoint.
partitionIds This property is required. List<String>
The partition ids in the Event Hub-compatible endpoint.
path This property is required. 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 This property is required. List<string>
The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
IsEnabled This property is required. bool
Used to specify whether the fallback route is enabled.
Source This property is required. 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 This property is required. []string
The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
IsEnabled This property is required. bool
Used to specify whether the fallback route is enabled.
Source This property is required. 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 This property is required. List<String>
The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
isEnabled This property is required. Boolean
Used to specify whether the fallback route is enabled.
source This property is required. 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 This property is required. string[]
The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
isEnabled This property is required. boolean
Used to specify whether the fallback route is enabled.
source This property is required. 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 This property is required. 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 This property is required. bool
Used to specify whether the fallback route is enabled.
source This property is required. 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 This property is required. List<String>
The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
isEnabled This property is required. Boolean
Used to specify whether the fallback route is enabled.
source This property is required. 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 This property is required. string
The name of the host.
Locations This property is required. List<Pulumi.AzureNative.IoTHub.Inputs.IotHubLocationDescriptionResponse>
Primary and secondary location for iot hub
ProvisioningState This property is required. string
The provisioning state.
State This property is required. string
The hub state.
AllowedFqdnList List<string>
List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
AuthorizationPolicies List<Pulumi.AzureNative.IoTHub.Inputs.SharedAccessSignatureAuthorizationRuleResponse>
The shared access policies you can use to secure a connection to the IoT hub.
CloudToDevice Pulumi.AzureNative.IoTHub.Inputs.CloudToDevicePropertiesResponse
The IoT hub cloud-to-device messaging properties.
Comments string
IoT hub comments.
DisableDeviceSAS bool
If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
DisableLocalAuth bool
If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
DisableModuleSAS bool
If true, all module scoped SAS keys cannot be used for authentication.
EnableDataResidency bool
This property when set to true, will enable data residency, thus, disabling disaster recovery.
EnableFileUploadNotifications bool
If True, file upload notifications are enabled.
EventHubEndpoints Dictionary<string, Pulumi.AzureNative.IoTHub.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.IoTHub.Inputs.IpFilterRuleResponse>
The IP filter rules.
MessagingEndpoints Dictionary<string, Pulumi.AzureNative.IoTHub.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.IoTHub.Inputs.NetworkRuleSetPropertiesResponse
Network Rule Set Properties of IotHub
PrivateEndpointConnections List<Pulumi.AzureNative.IoTHub.Inputs.PrivateEndpointConnectionResponse>
Private endpoint connections created on this IotHub
PublicNetworkAccess string
Whether requests from Public Network are allowed
RestrictOutboundNetworkAccess bool
If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
Routing Pulumi.AzureNative.IoTHub.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.IoTHub.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 This property is required. string
The name of the host.
Locations This property is required. []IotHubLocationDescriptionResponse
Primary and secondary location for iot hub
ProvisioningState This property is required. string
The provisioning state.
State This property is required. string
The hub state.
AllowedFqdnList []string
List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
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.
DisableDeviceSAS bool
If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
DisableLocalAuth bool
If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
DisableModuleSAS bool
If true, all module scoped SAS keys cannot be used for authentication.
EnableDataResidency bool
This property when set to true, will enable data residency, thus, disabling disaster recovery.
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
RestrictOutboundNetworkAccess bool
If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
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 This property is required. String
The name of the host.
locations This property is required. List<IotHubLocationDescriptionResponse>
Primary and secondary location for iot hub
provisioningState This property is required. String
The provisioning state.
state This property is required. String
The hub state.
allowedFqdnList List<String>
List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
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.
disableDeviceSAS Boolean
If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
disableLocalAuth Boolean
If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
disableModuleSAS Boolean
If true, all module scoped SAS keys cannot be used for authentication.
enableDataResidency Boolean
This property when set to true, will enable data residency, thus, disabling disaster recovery.
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
restrictOutboundNetworkAccess Boolean
If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
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 This property is required. string
The name of the host.
locations This property is required. IotHubLocationDescriptionResponse[]
Primary and secondary location for iot hub
provisioningState This property is required. string
The provisioning state.
state This property is required. string
The hub state.
allowedFqdnList string[]
List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
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.
disableDeviceSAS boolean
If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
disableLocalAuth boolean
If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
disableModuleSAS boolean
If true, all module scoped SAS keys cannot be used for authentication.
enableDataResidency boolean
This property when set to true, will enable data residency, thus, disabling disaster recovery.
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
restrictOutboundNetworkAccess boolean
If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
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 This property is required. str
The name of the host.
locations This property is required. Sequence[IotHubLocationDescriptionResponse]
Primary and secondary location for iot hub
provisioning_state This property is required. str
The provisioning state.
state This property is required. str
The hub state.
allowed_fqdn_list Sequence[str]
List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
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.
disable_device_sas bool
If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
disable_local_auth bool
If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
disable_module_sas bool
If true, all module scoped SAS keys cannot be used for authentication.
enable_data_residency bool
This property when set to true, will enable data residency, thus, disabling disaster recovery.
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
restrict_outbound_network_access bool
If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
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 This property is required. String
The name of the host.
locations This property is required. List<Property Map>
Primary and secondary location for iot hub
provisioningState This property is required. String
The provisioning state.
state This property is required. String
The hub state.
allowedFqdnList List<String>
List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
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.
disableDeviceSAS Boolean
If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
disableLocalAuth Boolean
If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
disableModuleSAS Boolean
If true, all module scoped SAS keys cannot be used for authentication.
enableDataResidency Boolean
This property when set to true, will enable data residency, thus, disabling disaster recovery.
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
restrictOutboundNetworkAccess Boolean
If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
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 This property is required. string
The name of the SKU.
Tier This property is required. 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 This property is required. string
The name of the SKU.
Tier This property is required. 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 This property is required. String
The name of the SKU.
tier This property is required. 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 This property is required. string
The name of the SKU.
tier This property is required. 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 This property is required. str
The name of the SKU.
tier This property is required. 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 This property is required. String
The name of the SKU.
tier This property is required. 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 This property is required. string
The desired action for requests captured by this rule.
FilterName This property is required. string
The name of the IP filter rule.
IpMask This property is required. string
A string that contains the IP address range in CIDR notation for the rule.
Action This property is required. string
The desired action for requests captured by this rule.
FilterName This property is required. string
The name of the IP filter rule.
IpMask This property is required. string
A string that contains the IP address range in CIDR notation for the rule.
action This property is required. String
The desired action for requests captured by this rule.
filterName This property is required. String
The name of the IP filter rule.
ipMask This property is required. String
A string that contains the IP address range in CIDR notation for the rule.
action This property is required. string
The desired action for requests captured by this rule.
filterName This property is required. string
The name of the IP filter rule.
ipMask This property is required. string
A string that contains the IP address range in CIDR notation for the rule.
action This property is required. str
The desired action for requests captured by this rule.
filter_name This property is required. str
The name of the IP filter rule.
ip_mask This property is required. str
A string that contains the IP address range in CIDR notation for the rule.
action This property is required. String
The desired action for requests captured by this rule.
filterName This property is required. String
The name of the IP filter rule.
ipMask This property is required. String
A string that contains the IP address range in CIDR notation for the rule.

ManagedIdentityResponse

UserAssignedIdentity string
The user assigned identity.
UserAssignedIdentity string
The user assigned identity.
userAssignedIdentity String
The user assigned identity.
userAssignedIdentity string
The user assigned identity.
user_assigned_identity str
The user assigned identity.
userAssignedIdentity String
The user assigned identity.

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 This property is required. string
Name of the IP filter rule.
IpMask This property is required. string
A string that contains the IP address range in CIDR notation for the rule.
Action string
IP Filter Action
FilterName This property is required. string
Name of the IP filter rule.
IpMask This property is required. string
A string that contains the IP address range in CIDR notation for the rule.
Action string
IP Filter Action
filterName This property is required. String
Name of the IP filter rule.
ipMask This property is required. String
A string that contains the IP address range in CIDR notation for the rule.
action String
IP Filter Action
filterName This property is required. string
Name of the IP filter rule.
ipMask This property is required. string
A string that contains the IP address range in CIDR notation for the rule.
action string
IP Filter Action
filter_name This property is required. str
Name of the IP filter rule.
ip_mask This property is required. str
A string that contains the IP address range in CIDR notation for the rule.
action str
IP Filter Action
filterName This property is required. String
Name of the IP filter rule.
ipMask This property is required. String
A string that contains the IP address range in CIDR notation for the rule.
action String
IP Filter Action

NetworkRuleSetPropertiesResponse

ApplyToBuiltInEventHubEndpoint This property is required. bool
If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
IpRules This property is required. List<Pulumi.AzureNative.IoTHub.Inputs.NetworkRuleSetIpRuleResponse>
List of IP Rules
DefaultAction string
Default Action for Network Rule Set
ApplyToBuiltInEventHubEndpoint This property is required. bool
If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
IpRules This property is required. []NetworkRuleSetIpRuleResponse
List of IP Rules
DefaultAction string
Default Action for Network Rule Set
applyToBuiltInEventHubEndpoint This property is required. Boolean
If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
ipRules This property is required. List<NetworkRuleSetIpRuleResponse>
List of IP Rules
defaultAction String
Default Action for Network Rule Set
applyToBuiltInEventHubEndpoint This property is required. boolean
If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
ipRules This property is required. NetworkRuleSetIpRuleResponse[]
List of IP Rules
defaultAction string
Default Action for Network Rule Set
apply_to_built_in_event_hub_endpoint This property is required. bool
If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
ip_rules This property is required. Sequence[NetworkRuleSetIpRuleResponse]
List of IP Rules
default_action str
Default Action for Network Rule Set
applyToBuiltInEventHubEndpoint This property is required. Boolean
If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
ipRules This property is required. List<Property Map>
List of IP Rules
defaultAction String
Default Action for Network Rule Set

PrivateEndpointConnectionPropertiesResponse

PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.IoTHub.Inputs.PrivateLinkServiceConnectionStateResponse
The current state of a private endpoint connection
PrivateEndpoint Pulumi.AzureNative.IoTHub.Inputs.PrivateEndpointResponse
The private endpoint property of a private endpoint connection
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
The current state of a private endpoint connection
PrivateEndpoint PrivateEndpointResponse
The private endpoint property of a private endpoint connection
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
The current state of a private endpoint connection
privateEndpoint PrivateEndpointResponse
The private endpoint property of a private endpoint connection
privateLinkServiceConnectionState This property is required. 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 This property is required. PrivateLinkServiceConnectionStateResponse
The current state of a private endpoint connection
private_endpoint PrivateEndpointResponse
The private endpoint property of a private endpoint connection
privateLinkServiceConnectionState This property is required. Property Map
The current state of a private endpoint connection
privateEndpoint Property Map
The private endpoint property of a private endpoint connection

PrivateEndpointConnectionResponse

Id This property is required. string
The resource identifier.
Name This property is required. string
The resource name.
Properties This property is required. Pulumi.AzureNative.IoTHub.Inputs.PrivateEndpointConnectionPropertiesResponse
The properties of a private endpoint connection
Type This property is required. string
The resource type.
Id This property is required. string
The resource identifier.
Name This property is required. string
The resource name.
Properties This property is required. PrivateEndpointConnectionPropertiesResponse
The properties of a private endpoint connection
Type This property is required. string
The resource type.
id This property is required. String
The resource identifier.
name This property is required. String
The resource name.
properties This property is required. PrivateEndpointConnectionPropertiesResponse
The properties of a private endpoint connection
type This property is required. String
The resource type.
id This property is required. string
The resource identifier.
name This property is required. string
The resource name.
properties This property is required. PrivateEndpointConnectionPropertiesResponse
The properties of a private endpoint connection
type This property is required. string
The resource type.
id This property is required. str
The resource identifier.
name This property is required. str
The resource name.
properties This property is required. PrivateEndpointConnectionPropertiesResponse
The properties of a private endpoint connection
type This property is required. str
The resource type.
id This property is required. String
The resource identifier.
name This property is required. String
The resource name.
properties This property is required. Property Map
The properties of a private endpoint connection
type This property is required. String
The resource type.

PrivateEndpointResponse

Id This property is required. string
The resource identifier.
Id This property is required. string
The resource identifier.
id This property is required. String
The resource identifier.
id This property is required. string
The resource identifier.
id This property is required. str
The resource identifier.
id This property is required. String
The resource identifier.

PrivateLinkServiceConnectionStateResponse

Description This property is required. string
The description for the current state of a private endpoint connection
Status This property is required. string
The status of a private endpoint connection
ActionsRequired string
Actions required for a private endpoint connection
Description This property is required. string
The description for the current state of a private endpoint connection
Status This property is required. string
The status of a private endpoint connection
ActionsRequired string
Actions required for a private endpoint connection
description This property is required. String
The description for the current state of a private endpoint connection
status This property is required. String
The status of a private endpoint connection
actionsRequired String
Actions required for a private endpoint connection
description This property is required. string
The description for the current state of a private endpoint connection
status This property is required. string
The status of a private endpoint connection
actionsRequired string
Actions required for a private endpoint connection
description This property is required. str
The description for the current state of a private endpoint connection
status This property is required. str
The status of a private endpoint connection
actions_required str
Actions required for a private endpoint connection
description This property is required. String
The description for the current state of a private endpoint connection
status This property is required. String
The status of a private endpoint connection
actionsRequired String
Actions required for a private endpoint connection

RoutePropertiesResponse

EndpointNames This property is required. List<string>
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
IsEnabled This property is required. bool
Used to specify whether a route is enabled.
Name This property is required. 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 This property is required. 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 This property is required. []string
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
IsEnabled This property is required. bool
Used to specify whether a route is enabled.
Name This property is required. 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 This property is required. 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 This property is required. List<String>
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
isEnabled This property is required. Boolean
Used to specify whether a route is enabled.
name This property is required. 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 This property is required. 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 This property is required. string[]
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
isEnabled This property is required. boolean
Used to specify whether a route is enabled.
name This property is required. 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 This property is required. 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 This property is required. Sequence[str]
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
is_enabled This property is required. bool
Used to specify whether a route is enabled.
name This property is required. 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 This property is required. 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 This property is required. List<String>
The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
isEnabled This property is required. Boolean
Used to specify whether a route is enabled.
name This property is required. 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 This property is required. 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

RoutingCosmosDBSqlApiPropertiesResponse

ContainerName This property is required. string
The name of the cosmos DB sql container in the cosmos DB database.
DatabaseName This property is required. string
The name of the cosmos DB database in the cosmos DB account.
EndpointUri This property is required. string
The url of the cosmos DB account. It must include the protocol https://
Id This property is required. string
Id of the cosmos DB sql container endpoint
Name This property is required. 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 cosmos DB sql container endpoint
Identity Pulumi.AzureNative.IoTHub.Inputs.ManagedIdentityResponse
Managed identity properties of routing cosmos DB container endpoint.
PartitionKeyName string
The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter.
PartitionKeyTemplate string
The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.
PrimaryKey string
The primary key of the cosmos DB account.
ResourceGroup string
The name of the resource group of the cosmos DB account.
SecondaryKey string
The secondary key of the cosmos DB account.
SubscriptionId string
The subscription identifier of the cosmos DB account.
ContainerName This property is required. string
The name of the cosmos DB sql container in the cosmos DB database.
DatabaseName This property is required. string
The name of the cosmos DB database in the cosmos DB account.
EndpointUri This property is required. string
The url of the cosmos DB account. It must include the protocol https://
Id This property is required. string
Id of the cosmos DB sql container endpoint
Name This property is required. 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 cosmos DB sql container endpoint
Identity ManagedIdentityResponse
Managed identity properties of routing cosmos DB container endpoint.
PartitionKeyName string
The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter.
PartitionKeyTemplate string
The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.
PrimaryKey string
The primary key of the cosmos DB account.
ResourceGroup string
The name of the resource group of the cosmos DB account.
SecondaryKey string
The secondary key of the cosmos DB account.
SubscriptionId string
The subscription identifier of the cosmos DB account.
containerName This property is required. String
The name of the cosmos DB sql container in the cosmos DB database.
databaseName This property is required. String
The name of the cosmos DB database in the cosmos DB account.
endpointUri This property is required. String
The url of the cosmos DB account. It must include the protocol https://
id This property is required. String
Id of the cosmos DB sql container endpoint
name This property is required. 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 cosmos DB sql container endpoint
identity ManagedIdentityResponse
Managed identity properties of routing cosmos DB container endpoint.
partitionKeyName String
The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter.
partitionKeyTemplate String
The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.
primaryKey String
The primary key of the cosmos DB account.
resourceGroup String
The name of the resource group of the cosmos DB account.
secondaryKey String
The secondary key of the cosmos DB account.
subscriptionId String
The subscription identifier of the cosmos DB account.
containerName This property is required. string
The name of the cosmos DB sql container in the cosmos DB database.
databaseName This property is required. string
The name of the cosmos DB database in the cosmos DB account.
endpointUri This property is required. string
The url of the cosmos DB account. It must include the protocol https://
id This property is required. string
Id of the cosmos DB sql container endpoint
name This property is required. 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 cosmos DB sql container endpoint
identity ManagedIdentityResponse
Managed identity properties of routing cosmos DB container endpoint.
partitionKeyName string
The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter.
partitionKeyTemplate string
The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.
primaryKey string
The primary key of the cosmos DB account.
resourceGroup string
The name of the resource group of the cosmos DB account.
secondaryKey string
The secondary key of the cosmos DB account.
subscriptionId string
The subscription identifier of the cosmos DB account.
container_name This property is required. str
The name of the cosmos DB sql container in the cosmos DB database.
database_name This property is required. str
The name of the cosmos DB database in the cosmos DB account.
endpoint_uri This property is required. str
The url of the cosmos DB account. It must include the protocol https://
id This property is required. str
Id of the cosmos DB sql container endpoint
name This property is required. 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 cosmos DB sql container endpoint
identity ManagedIdentityResponse
Managed identity properties of routing cosmos DB container endpoint.
partition_key_name str
The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter.
partition_key_template str
The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.
primary_key str
The primary key of the cosmos DB account.
resource_group str
The name of the resource group of the cosmos DB account.
secondary_key str
The secondary key of the cosmos DB account.
subscription_id str
The subscription identifier of the cosmos DB account.
containerName This property is required. String
The name of the cosmos DB sql container in the cosmos DB database.
databaseName This property is required. String
The name of the cosmos DB database in the cosmos DB account.
endpointUri This property is required. String
The url of the cosmos DB account. It must include the protocol https://
id This property is required. String
Id of the cosmos DB sql container endpoint
name This property is required. 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 cosmos DB sql container endpoint
identity Property Map
Managed identity properties of routing cosmos DB container endpoint.
partitionKeyName String
The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter.
partitionKeyTemplate String
The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.
primaryKey String
The primary key of the cosmos DB account.
resourceGroup String
The name of the resource group of the cosmos DB account.
secondaryKey String
The secondary key of the cosmos DB account.
subscriptionId String
The subscription identifier of the cosmos DB account.

RoutingEndpointsResponse

CosmosDBSqlContainers List<Pulumi.AzureNative.IoTHub.Inputs.RoutingCosmosDBSqlApiPropertiesResponse>
The list of Cosmos DB container endpoints that IoT hub routes messages to, based on the routing rules.
EventHubs List<Pulumi.AzureNative.IoTHub.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.IoTHub.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.IoTHub.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.IoTHub.Inputs.RoutingStorageContainerPropertiesResponse>
The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
CosmosDBSqlContainers []RoutingCosmosDBSqlApiPropertiesResponse
The list of Cosmos DB 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.
cosmosDBSqlContainers List<RoutingCosmosDBSqlApiPropertiesResponse>
The list of Cosmos DB 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.
cosmosDBSqlContainers RoutingCosmosDBSqlApiPropertiesResponse[]
The list of Cosmos DB 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.
cosmos_db_sql_containers Sequence[RoutingCosmosDBSqlApiPropertiesResponse]
The list of Cosmos DB 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.
cosmosDBSqlContainers List<Property Map>
The list of Cosmos DB 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 This property is required. 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
Identity Pulumi.AzureNative.IoTHub.Inputs.ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
Identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity Property Map
Managed identity properties of routing 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.IoTHub.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.IoTHub.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.IoTHub.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 present in the template, the fallback route is disabled by default.
Routes List<Pulumi.AzureNative.IoTHub.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 present in the template, the fallback route is disabled by default.
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 present in the template, the fallback route is disabled by default.
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 present in the template, the fallback route is disabled by default.
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 present in the template, the fallback route is disabled by default.
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 present in the template, the fallback route is disabled by default.
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 This property is required. 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
Identity Pulumi.AzureNative.IoTHub.Inputs.ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
Identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity Property Map
Managed identity properties of routing 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 This property is required. 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
Identity Pulumi.AzureNative.IoTHub.Inputs.ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
Identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing 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 This property is required. 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
identity Property Map
Managed identity properties of routing 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 This property is required. string
The name of storage container in the storage account.
Name This property is required. 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
Identity Pulumi.AzureNative.IoTHub.Inputs.ManagedIdentityResponse
Managed identity properties of routing storage endpoint.
MaxChunkSizeInBytes int
Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
ResourceGroup string
The name of the resource group of the storage account.
SubscriptionId string
The subscription identifier of the storage account.
ContainerName This property is required. string
The name of storage container in the storage account.
Name This property is required. 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
Identity ManagedIdentityResponse
Managed identity properties of routing storage endpoint.
MaxChunkSizeInBytes int
Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
ResourceGroup string
The name of the resource group of the storage account.
SubscriptionId string
The subscription identifier of the storage account.
containerName This property is required. String
The name of storage container in the storage account.
name This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing storage endpoint.
maxChunkSizeInBytes Integer
Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
resourceGroup String
The name of the resource group of the storage account.
subscriptionId String
The subscription identifier of the storage account.
containerName This property is required. string
The name of storage container in the storage account.
name This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing storage endpoint.
maxChunkSizeInBytes number
Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
resourceGroup string
The name of the resource group of the storage account.
subscriptionId string
The subscription identifier of the storage account.
container_name This property is required. str
The name of storage container in the storage account.
name This property is required. 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
identity ManagedIdentityResponse
Managed identity properties of routing storage endpoint.
max_chunk_size_in_bytes int
Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
resource_group str
The name of the resource group of the storage account.
subscription_id str
The subscription identifier of the storage account.
containerName This property is required. String
The name of storage container in the storage account.
name This property is required. 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
identity Property Map
Managed identity properties of routing storage endpoint.
maxChunkSizeInBytes Number
Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
resourceGroup String
The name of the resource group of the storage account.
subscriptionId String
The subscription identifier of the storage account.

SharedAccessSignatureAuthorizationRuleResponse

KeyName This property is required. string
The name of the shared access policy.
Rights This property is required. string
The permissions assigned to the shared access policy.
PrimaryKey string
The primary key.
SecondaryKey string
The secondary key.
KeyName This property is required. string
The name of the shared access policy.
Rights This property is required. string
The permissions assigned to the shared access policy.
PrimaryKey string
The primary key.
SecondaryKey string
The secondary key.
keyName This property is required. String
The name of the shared access policy.
rights This property is required. String
The permissions assigned to the shared access policy.
primaryKey String
The primary key.
secondaryKey String
The secondary key.
keyName This property is required. string
The name of the shared access policy.
rights This property is required. string
The permissions assigned to the shared access policy.
primaryKey string
The primary key.
secondaryKey string
The secondary key.
key_name This property is required. str
The name of the shared access policy.
rights This property is required. str
The permissions assigned to the shared access policy.
primary_key str
The primary key.
secondary_key str
The secondary key.
keyName This property is required. String
The name of the shared access policy.
rights This property is required. String
The permissions assigned to the shared access policy.
primaryKey String
The primary key.
secondaryKey String
The secondary key.

StorageEndpointPropertiesResponse

ConnectionString This property is required. string
The connection string for the Azure Storage account to which files are uploaded.
ContainerName This property is required. 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.
Identity Pulumi.AzureNative.IoTHub.Inputs.ManagedIdentityResponse
Managed identity properties of storage endpoint for file upload.
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 This property is required. string
The connection string for the Azure Storage account to which files are uploaded.
ContainerName This property is required. 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.
Identity ManagedIdentityResponse
Managed identity properties of storage endpoint for file upload.
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 This property is required. String
The connection string for the Azure Storage account to which files are uploaded.
containerName This property is required. 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.
identity ManagedIdentityResponse
Managed identity properties of storage endpoint for file upload.
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 This property is required. string
The connection string for the Azure Storage account to which files are uploaded.
containerName This property is required. 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.
identity ManagedIdentityResponse
Managed identity properties of storage endpoint for file upload.
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 This property is required. str
The connection string for the Azure Storage account to which files are uploaded.
container_name This property is required. 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.
identity ManagedIdentityResponse
Managed identity properties of storage endpoint for file upload.
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 This property is required. String
The connection string for the Azure Storage account to which files are uploaded.
containerName This property is required. 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.
identity Property Map
Managed identity properties of storage endpoint for file upload.
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.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi