This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi
azure-native.devices.getIotHubResource
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi
Get the non-security related metadata of an IoT hub. Azure REST API version: 2022-04-30-preview.
Other available API versions: 2017-07-01, 2022-11-15-preview, 2023-06-30, 2023-06-30-preview.
Using getIotHubResource
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getIotHubResource(args: GetIotHubResourceArgs, opts?: InvokeOptions): Promise<GetIotHubResourceResult>
function getIotHubResourceOutput(args: GetIotHubResourceOutputArgs, opts?: InvokeOptions): Output<GetIotHubResourceResult>
def get_iot_hub_resource(resource_group_name: Optional[str] = None,
resource_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetIotHubResourceResult
def get_iot_hub_resource_output(resource_group_name: Optional[pulumi.Input[str]] = None,
resource_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetIotHubResourceResult]
func LookupIotHubResource(ctx *Context, args *LookupIotHubResourceArgs, opts ...InvokeOption) (*LookupIotHubResourceResult, error)
func LookupIotHubResourceOutput(ctx *Context, args *LookupIotHubResourceOutputArgs, opts ...InvokeOption) LookupIotHubResourceResultOutput
> Note: This function is named LookupIotHubResource
in the Go SDK.
public static class GetIotHubResource
{
public static Task<GetIotHubResourceResult> InvokeAsync(GetIotHubResourceArgs args, InvokeOptions? opts = null)
public static Output<GetIotHubResourceResult> Invoke(GetIotHubResourceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetIotHubResourceResult> getIotHubResource(GetIotHubResourceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:devices:getIotHubResource
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName - The name of the resource group that contains the IoT hub.
- Resource
Name string - The name of the IoT hub.
- Resource
Group stringName - The name of the resource group that contains the IoT hub.
- Resource
Name string - The name of the IoT hub.
- resource
Group StringName - The name of the resource group that contains the IoT hub.
- resource
Name String - The name of the IoT hub.
- resource
Group stringName - The name of the resource group that contains the IoT hub.
- resource
Name string - The name of the IoT hub.
- resource_
group_ strname - The name of the resource group that contains the IoT hub.
- resource_
name str - The name of the IoT hub.
- resource
Group StringName - The name of the resource group that contains the IoT hub.
- resource
Name String - The name of the IoT hub.
getIotHubResource Result
The following output properties are available:
- Id string
- The resource identifier.
- Location string
- The resource location.
- Name string
- The resource name.
- Properties
Pulumi.
Azure Native. Devices. Outputs. Iot Hub Properties Response - IotHub properties
- Sku
Pulumi.
Azure Native. Devices. Outputs. Iot Hub Sku Info Response - IotHub SKU info
- System
Data Pulumi.Azure Native. Devices. Outputs. System Data Response - 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.
Azure Native. Devices. Outputs. Arm Identity Response - The managed identities for the IotHub.
- Dictionary<string, string>
- The resource tags.
- Id string
- The resource identifier.
- Location string
- The resource location.
- Name string
- The resource name.
- Properties
Iot
Hub Properties Response - IotHub properties
- Sku
Iot
Hub Sku Info Response - IotHub SKU info
- System
Data SystemData Response - 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
Arm
Identity Response - The managed identities for the IotHub.
- map[string]string
- The resource tags.
- id String
- The resource identifier.
- location String
- The resource location.
- name String
- The resource name.
- properties
Iot
Hub Properties Response - IotHub properties
- sku
Iot
Hub Sku Info Response - IotHub SKU info
- system
Data SystemData Response - 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
Arm
Identity Response - The managed identities for the IotHub.
- Map<String,String>
- The resource tags.
- id string
- The resource identifier.
- location string
- The resource location.
- name string
- The resource name.
- properties
Iot
Hub Properties Response - IotHub properties
- sku
Iot
Hub Sku Info Response - IotHub SKU info
- system
Data SystemData Response - 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
Arm
Identity Response - The managed identities for the IotHub.
- {[key: string]: string}
- The resource tags.
- id str
- The resource identifier.
- location str
- The resource location.
- name str
- The resource name.
- properties
Iot
Hub Properties Response - IotHub properties
- sku
Iot
Hub Sku Info Response - IotHub SKU info
- system_
data SystemData Response - 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
Arm
Identity Response - The managed identities for the IotHub.
- Mapping[str, str]
- The resource tags.
- id String
- The resource identifier.
- location String
- The resource location.
- name String
- The resource name.
- properties Property Map
- IotHub properties
- sku Property Map
- IotHub SKU info
- system
Data 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.
- Map<String>
- The resource tags.
Supporting Types
ArmIdentityResponse
- Principal
Id string - Principal Id
- Tenant
Id 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.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Devices. Inputs. Arm User Identity Response>
- Principal
Id string - Principal Id
- Tenant
Id 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.
- User
Assigned map[string]ArmIdentities User Identity Response
- principal
Id String - Principal Id
- tenant
Id 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.
- user
Assigned Map<String,ArmIdentities User Identity Response>
- principal
Id string - Principal Id
- tenant
Id 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.
- user
Assigned {[key: string]: ArmIdentities User Identity Response}
- principal_
id str - Principal Id
- tenant_
id 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_ Mapping[str, Armidentities User Identity Response]
- principal
Id String - Principal Id
- tenant
Id 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.
- user
Assigned Map<Property Map>Identities
ArmUserIdentityResponse
- Client
Id string - Principal
Id string
- Client
Id string - Principal
Id string
- client
Id String - principal
Id String
- client
Id string - principal
Id string
- client_
id str - principal_
id str
- client
Id String - principal
Id String
CloudToDevicePropertiesResponse
- Default
Ttl stringAs Iso8601 - 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.
Azure Native. Devices. Inputs. Feedback Properties Response - The properties of the feedback queue for cloud-to-device messages.
- Max
Delivery intCount - 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 stringAs Iso8601 - 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
Feedback
Properties Response - The properties of the feedback queue for cloud-to-device messages.
- Max
Delivery intCount - 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 StringAs Iso8601 - 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
Feedback
Properties Response - The properties of the feedback queue for cloud-to-device messages.
- max
Delivery IntegerCount - 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 stringAs Iso8601 - 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
Feedback
Properties Response - The properties of the feedback queue for cloud-to-device messages.
- max
Delivery numberCount - 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_ stras_ iso8601 - 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
Feedback
Properties Response - The properties of the feedback queue for cloud-to-device messages.
- max_
delivery_ intcount - 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 StringAs Iso8601 - 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.
- max
Delivery NumberCount - 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.
EncryptionPropertiesDescriptionResponse
- Key
Source string - The source of the key.
- Key
Vault List<Pulumi.Properties Azure Native. Devices. Inputs. Key Vault Key Properties Response> - The properties of the KeyVault key.
- Key
Source string - The source of the key.
- Key
Vault []KeyProperties Vault Key Properties Response - The properties of the KeyVault key.
- key
Source String - The source of the key.
- key
Vault List<KeyProperties Vault Key Properties Response> - The properties of the KeyVault key.
- key
Source string - The source of the key.
- key
Vault KeyProperties Vault Key Properties Response[] - The properties of the KeyVault key.
- key_
source str - The source of the key.
- key_
vault_ Sequence[Keyproperties Vault Key Properties Response] - The properties of the KeyVault key.
- key
Source String - The source of the key.
- key
Vault List<Property Map>Properties - The properties of the KeyVault key.
EnrichmentPropertiesResponse
- Endpoint
Names List<string> - The list of endpoints for which the enrichment is applied to the message.
- Key string
- The key or name for the enrichment property.
- Value string
- The value for the enrichment property.
- Endpoint
Names []string - The list of endpoints for which the enrichment is applied to the message.
- Key string
- The key or name for the enrichment property.
- Value string
- The value for the enrichment property.
- endpoint
Names List<String> - The list of endpoints for which the enrichment is applied to the message.
- key String
- The key or name for the enrichment property.
- value String
- The value for the enrichment property.
- endpoint
Names string[] - The list of endpoints for which the enrichment is applied to the message.
- key string
- The key or name for the enrichment property.
- value string
- The value for the enrichment property.
- endpoint_
names Sequence[str] - The list of endpoints for which the enrichment is applied to the message.
- key str
- The key or name for the enrichment property.
- value str
- The value for the enrichment property.
- endpoint
Names List<String> - The list of endpoints for which the enrichment is applied to the message.
- key String
- The key or name for the enrichment property.
- value String
- The value for the enrichment property.
EventHubPropertiesResponse
- Endpoint string
- The Event Hub-compatible endpoint.
- Partition
Ids List<string> - The partition ids in the Event Hub-compatible endpoint.
- Path string
- 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 doubleIn Days - The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
- Endpoint string
- The Event Hub-compatible endpoint.
- Partition
Ids []string - The partition ids in the Event Hub-compatible endpoint.
- Path string
- 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 float64In Days - The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
- endpoint String
- The Event Hub-compatible endpoint.
- partition
Ids List<String> - The partition ids in the Event Hub-compatible endpoint.
- path String
- The Event Hub-compatible name.
- partition
Count 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.
- retention
Time DoubleIn Days - The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
- endpoint string
- The Event Hub-compatible endpoint.
- partition
Ids string[] - The partition ids in the Event Hub-compatible endpoint.
- path string
- The Event Hub-compatible name.
- partition
Count 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.
- retention
Time numberIn Days - The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
- endpoint str
- The Event Hub-compatible endpoint.
- partition_
ids Sequence[str] - The partition ids in the Event Hub-compatible endpoint.
- path str
- The Event Hub-compatible name.
- partition_
count int - The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
- retention_
time_ floatin_ days - The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
- endpoint String
- The Event Hub-compatible endpoint.
- partition
Ids List<String> - The partition ids in the Event Hub-compatible endpoint.
- path String
- The Event Hub-compatible name.
- partition
Count 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.
- retention
Time NumberIn Days - 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
- Endpoint
Names List<string> - The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
- Is
Enabled bool - Used to specify whether the fallback route is enabled.
- Source 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 []string - The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
- Is
Enabled bool - Used to specify whether the fallback route is enabled.
- Source 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 List<String> - The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
- is
Enabled Boolean - Used to specify whether the fallback route is enabled.
- source String
- The source to which the routing rule is to be applied to. For example, DeviceMessages
- condition String
- The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
- name String
- The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
- endpoint
Names string[] - The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
- is
Enabled boolean - Used to specify whether the fallback route is enabled.
- source string
- The source to which the routing rule is to be applied to. For example, DeviceMessages
- condition string
- The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
- name string
- The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
- endpoint_
names Sequence[str] - The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
- is_
enabled bool - Used to specify whether the fallback route is enabled.
- source str
- The source to which the routing rule is to be applied to. For example, DeviceMessages
- condition str
- The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
- name str
- The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
- endpoint
Names List<String> - The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
- is
Enabled Boolean - Used to specify whether the fallback route is enabled.
- source String
- The source to which the routing rule is to be applied to. For example, DeviceMessages
- condition String
- The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
- name String
- The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
FeedbackPropertiesResponse
- Lock
Duration stringAs Iso8601 - 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 intCount - 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 stringIso8601 - 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 stringAs Iso8601 - 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 intCount - 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 stringIso8601 - 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 StringAs Iso8601 - 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 IntegerCount - 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 StringIso8601 - 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 stringAs Iso8601 - 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 numberCount - 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 stringIso8601 - 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_ stras_ iso8601 - 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_ intcount - 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_ striso8601 - 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 StringAs Iso8601 - 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 NumberCount - 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 StringIso8601 - 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 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
- Host
Name string - The name of the host.
- Locations
List<Pulumi.
Azure Native. Devices. Inputs. Iot Hub Location Description Response> - Primary and secondary location for iot hub
- Provisioning
State string - The provisioning state.
- State string
- The hub state.
- Allowed
Fqdn List<string>List - List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
- List<Pulumi.
Azure Native. Devices. Inputs. Shared Access Signature Authorization Rule Response> - The shared access policies you can use to secure a connection to the IoT hub.
- Cloud
To Pulumi.Device Azure Native. Devices. Inputs. Cloud To Device Properties Response - The IoT hub cloud-to-device messaging properties.
- Comments string
- IoT hub comments.
- Device
Streams Pulumi.Azure Native. Devices. Inputs. Iot Hub Properties Response Device Streams - The device streams properties of iothub.
- Disable
Device boolSAS - If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
- Disable
Local boolAuth - If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
- Disable
Module boolSAS - If true, all module scoped SAS keys cannot be used for authentication.
- Enable
Data boolResidency - This property when set to true, will enable data residency, thus, disabling disaster recovery.
- Enable
File boolUpload Notifications - If True, file upload notifications are enabled.
- Encryption
Pulumi.
Azure Native. Devices. Inputs. Encryption Properties Description Response - The encryption properties for the IoT hub.
- Event
Hub Dictionary<string, Pulumi.Endpoints Azure Native. Devices. Inputs. Event Hub Properties Response> - 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.
- Ip
Filter List<Pulumi.Rules Azure Native. Devices. Inputs. Ip Filter Rule Response> - The IP filter rules.
- Messaging
Endpoints Dictionary<string, Pulumi.Azure Native. Devices. Inputs. Messaging Endpoint Properties Response> - The messaging endpoint properties for the file upload notification queue.
- Min
Tls stringVersion - 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 Pulumi.Sets Azure Native. Devices. Inputs. Network Rule Set Properties Response - Network Rule Set Properties of IotHub
- Private
Endpoint List<Pulumi.Connections Azure Native. Devices. Inputs. Private Endpoint Connection Response> - Private endpoint connections created on this IotHub
- Public
Network stringAccess - Whether requests from Public Network are allowed
- Restrict
Outbound boolNetwork Access - If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
- Root
Certificate Pulumi.Azure Native. Devices. Inputs. Root Certificate Properties Response - This property store root certificate related information
- Routing
Pulumi.
Azure Native. Devices. Inputs. Routing Properties Response - The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
- Storage
Endpoints Dictionary<string, Pulumi.Azure Native. Devices. Inputs. Storage Endpoint Properties Response> - 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 string - The name of the host.
- Locations
[]Iot
Hub Location Description Response - Primary and secondary location for iot hub
- Provisioning
State string - The provisioning state.
- State string
- The hub state.
- Allowed
Fqdn []stringList - List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
- []Shared
Access Signature Authorization Rule Response - The shared access policies you can use to secure a connection to the IoT hub.
- Cloud
To CloudDevice To Device Properties Response - The IoT hub cloud-to-device messaging properties.
- Comments string
- IoT hub comments.
- Device
Streams IotHub Properties Response Device Streams - The device streams properties of iothub.
- Disable
Device boolSAS - If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
- Disable
Local boolAuth - If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
- Disable
Module boolSAS - If true, all module scoped SAS keys cannot be used for authentication.
- Enable
Data boolResidency - This property when set to true, will enable data residency, thus, disabling disaster recovery.
- Enable
File boolUpload Notifications - If True, file upload notifications are enabled.
- Encryption
Encryption
Properties Description Response - The encryption properties for the IoT hub.
- Event
Hub map[string]EventEndpoints Hub Properties Response - 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.
- Ip
Filter []IpRules Filter Rule Response - The IP filter rules.
- Messaging
Endpoints map[string]MessagingEndpoint Properties Response - The messaging endpoint properties for the file upload notification queue.
- Min
Tls stringVersion - 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 NetworkSets Rule Set Properties Response - Network Rule Set Properties of IotHub
- Private
Endpoint []PrivateConnections Endpoint Connection Response - Private endpoint connections created on this IotHub
- Public
Network stringAccess - Whether requests from Public Network are allowed
- Restrict
Outbound boolNetwork Access - If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
- Root
Certificate RootCertificate Properties Response - This property store root certificate related information
- Routing
Routing
Properties Response - The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
- Storage
Endpoints map[string]StorageEndpoint Properties Response - 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 String - The name of the host.
- locations
List<Iot
Hub Location Description Response> - Primary and secondary location for iot hub
- provisioning
State String - The provisioning state.
- state String
- The hub state.
- allowed
Fqdn List<String>List - List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
- List<Shared
Access Signature Authorization Rule Response> - The shared access policies you can use to secure a connection to the IoT hub.
- cloud
To CloudDevice To Device Properties Response - The IoT hub cloud-to-device messaging properties.
- comments String
- IoT hub comments.
- device
Streams IotHub Properties Response Device Streams - The device streams properties of iothub.
- disable
Device BooleanSAS - If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
- disable
Local BooleanAuth - If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
- disable
Module BooleanSAS - If true, all module scoped SAS keys cannot be used for authentication.
- enable
Data BooleanResidency - This property when set to true, will enable data residency, thus, disabling disaster recovery.
- enable
File BooleanUpload Notifications - If True, file upload notifications are enabled.
- encryption
Encryption
Properties Description Response - The encryption properties for the IoT hub.
- event
Hub Map<String,EventEndpoints Hub Properties Response> - 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.
- ip
Filter List<IpRules Filter Rule Response> - The IP filter rules.
- messaging
Endpoints Map<String,MessagingEndpoint Properties Response> - The messaging endpoint properties for the file upload notification queue.
- min
Tls StringVersion - 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 NetworkSets Rule Set Properties Response - Network Rule Set Properties of IotHub
- private
Endpoint List<PrivateConnections Endpoint Connection Response> - Private endpoint connections created on this IotHub
- public
Network StringAccess - Whether requests from Public Network are allowed
- restrict
Outbound BooleanNetwork Access - If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
- root
Certificate RootCertificate Properties Response - This property store root certificate related information
- routing
Routing
Properties Response - The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
- storage
Endpoints Map<String,StorageEndpoint Properties Response> - 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 string - The name of the host.
- locations
Iot
Hub Location Description Response[] - Primary and secondary location for iot hub
- provisioning
State string - The provisioning state.
- state string
- The hub state.
- allowed
Fqdn string[]List - List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
- Shared
Access Signature Authorization Rule Response[] - The shared access policies you can use to secure a connection to the IoT hub.
- cloud
To CloudDevice To Device Properties Response - The IoT hub cloud-to-device messaging properties.
- comments string
- IoT hub comments.
- device
Streams IotHub Properties Response Device Streams - The device streams properties of iothub.
- disable
Device booleanSAS - If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
- disable
Local booleanAuth - If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
- disable
Module booleanSAS - If true, all module scoped SAS keys cannot be used for authentication.
- enable
Data booleanResidency - This property when set to true, will enable data residency, thus, disabling disaster recovery.
- enable
File booleanUpload Notifications - If True, file upload notifications are enabled.
- encryption
Encryption
Properties Description Response - The encryption properties for the IoT hub.
- event
Hub {[key: string]: EventEndpoints Hub Properties Response} - 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.
- ip
Filter IpRules Filter Rule Response[] - The IP filter rules.
- messaging
Endpoints {[key: string]: MessagingEndpoint Properties Response} - The messaging endpoint properties for the file upload notification queue.
- min
Tls stringVersion - 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 NetworkSets Rule Set Properties Response - Network Rule Set Properties of IotHub
- private
Endpoint PrivateConnections Endpoint Connection Response[] - Private endpoint connections created on this IotHub
- public
Network stringAccess - Whether requests from Public Network are allowed
- restrict
Outbound booleanNetwork Access - If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
- root
Certificate RootCertificate Properties Response - This property store root certificate related information
- routing
Routing
Properties Response - The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
- storage
Endpoints {[key: string]: StorageEndpoint Properties Response} - The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.
- host_
name str - The name of the host.
- locations
Sequence[Iot
Hub Location Description Response] - Primary and secondary location for iot hub
- provisioning_
state str - The provisioning state.
- state str
- The hub state.
- allowed_
fqdn_ Sequence[str]list - List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
- Sequence[Shared
Access Signature Authorization Rule Response] - The shared access policies you can use to secure a connection to the IoT hub.
- cloud_
to_ Clouddevice To Device Properties Response - The IoT hub cloud-to-device messaging properties.
- comments str
- IoT hub comments.
- device_
streams IotHub Properties Response Device Streams - The device streams properties of iothub.
- disable_
device_ boolsas - If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
- disable_
local_ boolauth - If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
- disable_
module_ boolsas - If true, all module scoped SAS keys cannot be used for authentication.
- enable_
data_ boolresidency - This property when set to true, will enable data residency, thus, disabling disaster recovery.
- enable_
file_ boolupload_ notifications - If True, file upload notifications are enabled.
- encryption
Encryption
Properties Description Response - The encryption properties for the IoT hub.
- event_
hub_ Mapping[str, Eventendpoints Hub Properties Response] - 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_ Sequence[Iprules Filter Rule Response] - The IP filter rules.
- messaging_
endpoints Mapping[str, MessagingEndpoint Properties Response] - The messaging endpoint properties for the file upload notification queue.
- min_
tls_ strversion - 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_ Networksets Rule Set Properties Response - Network Rule Set Properties of IotHub
- private_
endpoint_ Sequence[Privateconnections Endpoint Connection Response] - Private endpoint connections created on this IotHub
- public_
network_ straccess - Whether requests from Public Network are allowed
- restrict_
outbound_ boolnetwork_ access - If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
- root_
certificate RootCertificate Properties Response - This property store root certificate related information
- routing
Routing
Properties Response - The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
- storage_
endpoints Mapping[str, StorageEndpoint Properties Response] - 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 String - The name of the host.
- locations List<Property Map>
- Primary and secondary location for iot hub
- provisioning
State String - The provisioning state.
- state String
- The hub state.
- allowed
Fqdn List<String>List - List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
- List<Property Map>
- The shared access policies you can use to secure a connection to the IoT hub.
- cloud
To Property MapDevice - The IoT hub cloud-to-device messaging properties.
- comments String
- IoT hub comments.
- device
Streams Property Map - The device streams properties of iothub.
- disable
Device BooleanSAS - If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
- disable
Local BooleanAuth - If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
- disable
Module BooleanSAS - If true, all module scoped SAS keys cannot be used for authentication.
- enable
Data BooleanResidency - This property when set to true, will enable data residency, thus, disabling disaster recovery.
- enable
File BooleanUpload Notifications - If True, file upload notifications are enabled.
- encryption Property Map
- The encryption properties for the IoT hub.
- event
Hub Map<Property Map>Endpoints - 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.
- ip
Filter List<Property Map>Rules - The IP filter rules.
- messaging
Endpoints Map<Property Map> - The messaging endpoint properties for the file upload notification queue.
- min
Tls StringVersion - 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 Property MapSets - Network Rule Set Properties of IotHub
- private
Endpoint List<Property Map>Connections - Private endpoint connections created on this IotHub
- public
Network StringAccess - Whether requests from Public Network are allowed
- restrict
Outbound BooleanNetwork Access - If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
- root
Certificate Property Map - This property store root certificate related information
- routing Property Map
- The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
- storage
Endpoints 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.
IotHubPropertiesResponseDeviceStreams
- Streaming
Endpoints List<string> - List of Device Streams Endpoints.
- Streaming
Endpoints []string - List of Device Streams Endpoints.
- streaming
Endpoints List<String> - List of Device Streams Endpoints.
- streaming
Endpoints string[] - List of Device Streams Endpoints.
- streaming_
endpoints Sequence[str] - List of Device Streams Endpoints.
- streaming
Endpoints List<String> - List of Device Streams Endpoints.
IotHubSkuInfoResponse
IpFilterRuleResponse
- Action string
- The desired action for requests captured by this rule.
- Filter
Name string - The name of the IP filter rule.
- Ip
Mask string - A string that contains the IP address range in CIDR notation for the rule.
- Action string
- The desired action for requests captured by this rule.
- Filter
Name string - The name of the IP filter rule.
- Ip
Mask string - A string that contains the IP address range in CIDR notation for the rule.
- action String
- The desired action for requests captured by this rule.
- filter
Name String - The name of the IP filter rule.
- ip
Mask String - A string that contains the IP address range in CIDR notation for the rule.
- action string
- The desired action for requests captured by this rule.
- filter
Name string - The name of the IP filter rule.
- ip
Mask string - A string that contains the IP address range in CIDR notation for the rule.
- action str
- The desired action for requests captured by this rule.
- filter_
name str - The name of the IP filter rule.
- ip_
mask str - A string that contains the IP address range in CIDR notation for the rule.
- action String
- The desired action for requests captured by this rule.
- filter
Name String - The name of the IP filter rule.
- ip
Mask String - A string that contains the IP address range in CIDR notation for the rule.
KeyVaultKeyPropertiesResponse
- Identity
Pulumi.
Azure Native. Devices. Inputs. Managed Identity Response - Managed identity properties of KeyVault Key.
- Key
Identifier string - The identifier of the key.
- Identity
Managed
Identity Response - Managed identity properties of KeyVault Key.
- Key
Identifier string - The identifier of the key.
- identity
Managed
Identity Response - Managed identity properties of KeyVault Key.
- key
Identifier String - The identifier of the key.
- identity
Managed
Identity Response - Managed identity properties of KeyVault Key.
- key
Identifier string - The identifier of the key.
- identity
Managed
Identity Response - Managed identity properties of KeyVault Key.
- key_
identifier str - The identifier of the key.
- identity Property Map
- Managed identity properties of KeyVault Key.
- key
Identifier String - The identifier of the key.
ManagedIdentityResponse
- User
Assigned stringIdentity - The user assigned identity.
- User
Assigned stringIdentity - The user assigned identity.
- user
Assigned StringIdentity - The user assigned identity.
- user
Assigned stringIdentity - The user assigned identity.
- user_
assigned_ stridentity - The user assigned identity.
- user
Assigned StringIdentity - The user assigned identity.
MessagingEndpointPropertiesResponse
- Lock
Duration stringAs Iso8601 - The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
- Max
Delivery intCount - 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 stringIso8601 - 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 stringAs Iso8601 - The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
- Max
Delivery intCount - 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 stringIso8601 - 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 StringAs Iso8601 - The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
- max
Delivery IntegerCount - 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 StringIso8601 - 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 stringAs Iso8601 - The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
- max
Delivery numberCount - 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 stringIso8601 - 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_ stras_ iso8601 - The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
- max_
delivery_ intcount - 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_ striso8601 - 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 StringAs Iso8601 - The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
- max
Delivery NumberCount - 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 StringIso8601 - 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
- Filter
Name string - Name of the IP filter rule.
- Ip
Mask string - A string that contains the IP address range in CIDR notation for the rule.
- Action string
- IP Filter Action
- Filter
Name string - Name of the IP filter rule.
- Ip
Mask string - A string that contains the IP address range in CIDR notation for the rule.
- Action string
- IP Filter Action
- filter
Name String - Name of the IP filter rule.
- ip
Mask String - A string that contains the IP address range in CIDR notation for the rule.
- action String
- IP Filter Action
- filter
Name string - Name of the IP filter rule.
- ip
Mask string - A string that contains the IP address range in CIDR notation for the rule.
- action string
- IP Filter Action
- filter_
name str - Name of the IP filter rule.
- ip_
mask str - A string that contains the IP address range in CIDR notation for the rule.
- action str
- IP Filter Action
- filter
Name String - Name of the IP filter rule.
- ip
Mask String - A string that contains the IP address range in CIDR notation for the rule.
- action String
- IP Filter Action
NetworkRuleSetPropertiesResponse
- Apply
To boolBuilt In Event Hub Endpoint - If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
- Ip
Rules List<Pulumi.Azure Native. Devices. Inputs. Network Rule Set Ip Rule Response> - List of IP Rules
- Default
Action string - Default Action for Network Rule Set
- Apply
To boolBuilt In Event Hub Endpoint - If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
- Ip
Rules []NetworkRule Set Ip Rule Response - List of IP Rules
- Default
Action string - Default Action for Network Rule Set
- apply
To BooleanBuilt In Event Hub Endpoint - If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
- ip
Rules List<NetworkRule Set Ip Rule Response> - List of IP Rules
- default
Action String - Default Action for Network Rule Set
- apply
To booleanBuilt In Event Hub Endpoint - If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
- ip
Rules NetworkRule Set Ip Rule Response[] - List of IP Rules
- default
Action string - Default Action for Network Rule Set
- apply_
to_ boolbuilt_ in_ event_ hub_ endpoint - If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
- ip_
rules Sequence[NetworkRule Set Ip Rule Response] - List of IP Rules
- default_
action str - Default Action for Network Rule Set
- apply
To BooleanBuilt In Event Hub Endpoint - If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
- ip
Rules List<Property Map> - List of IP Rules
- default
Action String - Default Action for Network Rule Set
PrivateEndpointConnectionPropertiesResponse
- Private
Link Pulumi.Service Connection State Azure Native. Devices. Inputs. Private Link Service Connection State Response - The current state of a private endpoint connection
- Private
Endpoint Pulumi.Azure Native. Devices. Inputs. Private Endpoint Response - The private endpoint property of a private endpoint connection
- Private
Link PrivateService Connection State Link Service Connection State Response - The current state of a private endpoint connection
- Private
Endpoint PrivateEndpoint Response - The private endpoint property of a private endpoint connection
- private
Link PrivateService Connection State Link Service Connection State Response - The current state of a private endpoint connection
- private
Endpoint PrivateEndpoint Response - The private endpoint property of a private endpoint connection
- private
Link PrivateService Connection State Link Service Connection State Response - The current state of a private endpoint connection
- private
Endpoint PrivateEndpoint Response - The private endpoint property of a private endpoint connection
- private_
link_ Privateservice_ connection_ state Link Service Connection State Response - The current state of a private endpoint connection
- private_
endpoint PrivateEndpoint Response - The private endpoint property of a private endpoint connection
- private
Link Property MapService Connection State - The current state of a private endpoint connection
- private
Endpoint Property Map - The private endpoint property of a private endpoint connection
PrivateEndpointConnectionResponse
- Id string
- The resource identifier.
- Name string
- The resource name.
- Properties
Pulumi.
Azure Native. Devices. Inputs. Private Endpoint Connection Properties Response - The properties of a private endpoint connection
- Type string
- The resource type.
- System
Data Pulumi.Azure Native. Devices. Inputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Id string
- The resource identifier.
- Name string
- The resource name.
- Properties
Private
Endpoint Connection Properties Response - The properties of a private endpoint connection
- Type string
- The resource type.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- id String
- The resource identifier.
- name String
- The resource name.
- properties
Private
Endpoint Connection Properties Response - The properties of a private endpoint connection
- type String
- The resource type.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- id string
- The resource identifier.
- name string
- The resource name.
- properties
Private
Endpoint Connection Properties Response - The properties of a private endpoint connection
- type string
- The resource type.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- id str
- The resource identifier.
- name str
- The resource name.
- properties
Private
Endpoint Connection Properties Response - The properties of a private endpoint connection
- type str
- The resource type.
- system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- id String
- The resource identifier.
- name String
- The resource name.
- properties Property Map
- The properties of a private endpoint connection
- type String
- The resource type.
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
PrivateEndpointResponse
- Id string
- The resource identifier.
- Id string
- The resource identifier.
- id String
- The resource identifier.
- id string
- The resource identifier.
- id str
- The resource identifier.
- id String
- The resource identifier.
PrivateLinkServiceConnectionStateResponse
- Description string
- The description for the current state of a private endpoint connection
- Status string
- The status of a private endpoint connection
- Actions
Required string - Actions required for a private endpoint connection
- Description string
- The description for the current state of a private endpoint connection
- Status string
- The status of a private endpoint connection
- Actions
Required string - Actions required for a private endpoint connection
- description String
- The description for the current state of a private endpoint connection
- status String
- The status of a private endpoint connection
- actions
Required String - Actions required for a private endpoint connection
- description string
- The description for the current state of a private endpoint connection
- status string
- The status of a private endpoint connection
- actions
Required string - Actions required for a private endpoint connection
- description str
- The description for the current state of a private endpoint connection
- status str
- The status of a private endpoint connection
- actions_
required str - Actions required for a private endpoint connection
- description String
- The description for the current state of a private endpoint connection
- status String
- The status of a private endpoint connection
- actions
Required String - Actions required for a private endpoint connection
RootCertificatePropertiesResponse
- Last
Updated stringTime Utc - the last update time to root certificate flag.
- Enable
Root boolCertificate V2 - This property when set to true, hub will use G2 cert; while it's set to false, hub uses Baltimore Cert.
- Last
Updated stringTime Utc - the last update time to root certificate flag.
- Enable
Root boolCertificate V2 - This property when set to true, hub will use G2 cert; while it's set to false, hub uses Baltimore Cert.
- last
Updated StringTime Utc - the last update time to root certificate flag.
- enable
Root BooleanCertificate V2 - This property when set to true, hub will use G2 cert; while it's set to false, hub uses Baltimore Cert.
- last
Updated stringTime Utc - the last update time to root certificate flag.
- enable
Root booleanCertificate V2 - This property when set to true, hub will use G2 cert; while it's set to false, hub uses Baltimore Cert.
- last_
updated_ strtime_ utc - the last update time to root certificate flag.
- enable_
root_ boolcertificate_ v2 - This property when set to true, hub will use G2 cert; while it's set to false, hub uses Baltimore Cert.
- last
Updated StringTime Utc - the last update time to root certificate flag.
- enable
Root BooleanCertificate V2 - This property when set to true, hub will use G2 cert; while it's set to false, hub uses Baltimore Cert.
RoutePropertiesResponse
- Endpoint
Names List<string> - The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
- Is
Enabled bool - Used to specify whether a route is enabled.
- Name string
- The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
- Source string
- The source that the routing rule is to be applied to, such as DeviceMessages.
- Condition string
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
- Endpoint
Names []string - The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
- Is
Enabled bool - Used to specify whether a route is enabled.
- Name string
- The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
- Source string
- The source that the routing rule is to be applied to, such as DeviceMessages.
- Condition string
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
- endpoint
Names List<String> - The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
- is
Enabled Boolean - Used to specify whether a route is enabled.
- name String
- The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
- source String
- The source that the routing rule is to be applied to, such as DeviceMessages.
- condition String
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
- endpoint
Names string[] - The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
- is
Enabled boolean - Used to specify whether a route is enabled.
- name string
- The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
- source string
- The source that the routing rule is to be applied to, such as DeviceMessages.
- condition string
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
- endpoint_
names Sequence[str] - The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
- is_
enabled bool - Used to specify whether a route is enabled.
- name str
- The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
- source str
- The source that the routing rule is to be applied to, such as DeviceMessages.
- condition str
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
- endpoint
Names List<String> - The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
- is
Enabled Boolean - Used to specify whether a route is enabled.
- name String
- The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
- source String
- The source that the routing rule is to be applied to, such as DeviceMessages.
- condition String
- The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
RoutingCosmosDBSqlApiPropertiesResponse
- Collection
Name string - The name of the cosmos DB sql collection in the cosmos DB database.
- Database
Name string - The name of the cosmos DB database in the cosmos DB account.
- Endpoint
Uri string - The url of the cosmos DB account. It must include the protocol https://
- Name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- Authentication
Type string - Method used to authenticate against the cosmos DB sql collection endpoint
- Id string
- Id of the cosmos DB sql collection endpoint
- Identity
Pulumi.
Azure Native. Devices. Inputs. Managed Identity Response - Managed identity properties of routing cosmos DB collection endpoint.
- Partition
Key stringName - The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.
- Partition
Key stringTemplate - The template for generating a synthetic partition key value for use with this cosmos DB sql collection. 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 string - The primary key of the cosmos DB account.
- Resource
Group string - The name of the resource group of the cosmos DB account.
- Secondary
Key string - The secondary key of the cosmos DB account.
- Subscription
Id string - The subscription identifier of the cosmos DB account.
- Collection
Name string - The name of the cosmos DB sql collection in the cosmos DB database.
- Database
Name string - The name of the cosmos DB database in the cosmos DB account.
- Endpoint
Uri string - The url of the cosmos DB account. It must include the protocol https://
- Name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- Authentication
Type string - Method used to authenticate against the cosmos DB sql collection endpoint
- Id string
- Id of the cosmos DB sql collection endpoint
- Identity
Managed
Identity Response - Managed identity properties of routing cosmos DB collection endpoint.
- Partition
Key stringName - The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.
- Partition
Key stringTemplate - The template for generating a synthetic partition key value for use with this cosmos DB sql collection. 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 string - The primary key of the cosmos DB account.
- Resource
Group string - The name of the resource group of the cosmos DB account.
- Secondary
Key string - The secondary key of the cosmos DB account.
- Subscription
Id string - The subscription identifier of the cosmos DB account.
- collection
Name String - The name of the cosmos DB sql collection in the cosmos DB database.
- database
Name String - The name of the cosmos DB database in the cosmos DB account.
- endpoint
Uri String - The url of the cosmos DB account. It must include the protocol https://
- name String
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication
Type String - Method used to authenticate against the cosmos DB sql collection endpoint
- id String
- Id of the cosmos DB sql collection endpoint
- identity
Managed
Identity Response - Managed identity properties of routing cosmos DB collection endpoint.
- partition
Key StringName - The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.
- partition
Key StringTemplate - The template for generating a synthetic partition key value for use with this cosmos DB sql collection. 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 String - The primary key of the cosmos DB account.
- resource
Group String - The name of the resource group of the cosmos DB account.
- secondary
Key String - The secondary key of the cosmos DB account.
- subscription
Id String - The subscription identifier of the cosmos DB account.
- collection
Name string - The name of the cosmos DB sql collection in the cosmos DB database.
- database
Name string - The name of the cosmos DB database in the cosmos DB account.
- endpoint
Uri string - The url of the cosmos DB account. It must include the protocol https://
- name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication
Type string - Method used to authenticate against the cosmos DB sql collection endpoint
- id string
- Id of the cosmos DB sql collection endpoint
- identity
Managed
Identity Response - Managed identity properties of routing cosmos DB collection endpoint.
- partition
Key stringName - The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.
- partition
Key stringTemplate - The template for generating a synthetic partition key value for use with this cosmos DB sql collection. 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 string - The primary key of the cosmos DB account.
- resource
Group string - The name of the resource group of the cosmos DB account.
- secondary
Key string - The secondary key of the cosmos DB account.
- subscription
Id string - The subscription identifier of the cosmos DB account.
- collection_
name str - The name of the cosmos DB sql collection in the cosmos DB database.
- database_
name str - The name of the cosmos DB database in the cosmos DB account.
- endpoint_
uri str - The url of the cosmos DB account. It must include the protocol https://
- name str
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication_
type str - Method used to authenticate against the cosmos DB sql collection endpoint
- id str
- Id of the cosmos DB sql collection endpoint
- identity
Managed
Identity Response - Managed identity properties of routing cosmos DB collection endpoint.
- partition_
key_ strname - The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.
- partition_
key_ strtemplate - The template for generating a synthetic partition key value for use with this cosmos DB sql collection. 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.
- collection
Name String - The name of the cosmos DB sql collection in the cosmos DB database.
- database
Name String - The name of the cosmos DB database in the cosmos DB account.
- endpoint
Uri String - The url of the cosmos DB account. It must include the protocol https://
- name String
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication
Type String - Method used to authenticate against the cosmos DB sql collection endpoint
- id String
- Id of the cosmos DB sql collection endpoint
- identity Property Map
- Managed identity properties of routing cosmos DB collection endpoint.
- partition
Key StringName - The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.
- partition
Key StringTemplate - The template for generating a synthetic partition key value for use with this cosmos DB sql collection. 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 String - The primary key of the cosmos DB account.
- resource
Group String - The name of the resource group of the cosmos DB account.
- secondary
Key String - The secondary key of the cosmos DB account.
- subscription
Id String - The subscription identifier of the cosmos DB account.
RoutingEndpointsResponse
- Cosmos
DBSql List<Pulumi.Collections Azure Native. Devices. Inputs. Routing Cosmos DBSql Api Properties Response> - The list of Cosmos DB collection endpoints that IoT hub routes messages to, based on the routing rules.
- Event
Hubs List<Pulumi.Azure Native. Devices. Inputs. Routing Event Hub Properties Response> - 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 List<Pulumi.Queues Azure Native. Devices. Inputs. Routing Service Bus Queue Endpoint Properties Response> - The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
- Service
Bus List<Pulumi.Topics Azure Native. Devices. Inputs. Routing Service Bus Topic Endpoint Properties Response> - The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
- Storage
Containers List<Pulumi.Azure Native. Devices. Inputs. Routing Storage Container Properties Response> - The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
- Cosmos
DBSql []RoutingCollections Cosmos DBSql Api Properties Response - The list of Cosmos DB collection endpoints that IoT hub routes messages to, based on the routing rules.
- Event
Hubs []RoutingEvent Hub Properties Response - 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 []RoutingQueues Service Bus Queue Endpoint Properties Response - The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
- Service
Bus []RoutingTopics Service Bus Topic Endpoint Properties Response - The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
- Storage
Containers []RoutingStorage Container Properties Response - The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
- cosmos
DBSql List<RoutingCollections Cosmos DBSql Api Properties Response> - The list of Cosmos DB collection endpoints that IoT hub routes messages to, based on the routing rules.
- event
Hubs List<RoutingEvent Hub Properties Response> - 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 List<RoutingQueues Service Bus Queue Endpoint Properties Response> - The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
- service
Bus List<RoutingTopics Service Bus Topic Endpoint Properties Response> - The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
- storage
Containers List<RoutingStorage Container Properties Response> - The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
- cosmos
DBSql RoutingCollections Cosmos DBSql Api Properties Response[] - The list of Cosmos DB collection endpoints that IoT hub routes messages to, based on the routing rules.
- event
Hubs RoutingEvent Hub Properties Response[] - 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 RoutingQueues Service Bus Queue Endpoint Properties Response[] - The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
- service
Bus RoutingTopics Service Bus Topic Endpoint Properties Response[] - The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
- storage
Containers RoutingStorage Container Properties Response[] - The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
- cosmos_
db_ Sequence[Routingsql_ collections Cosmos DBSql Api Properties Response] - The list of Cosmos DB collection endpoints that IoT hub routes messages to, based on the routing rules.
- event_
hubs Sequence[RoutingEvent Hub Properties Response] - 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_ Sequence[Routingqueues Service Bus Queue Endpoint Properties Response] - The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
- service_
bus_ Sequence[Routingtopics Service Bus Topic Endpoint Properties Response] - The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
- storage_
containers Sequence[RoutingStorage Container Properties Response] - The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
- cosmos
DBSql List<Property Map>Collections - The list of Cosmos DB collection endpoints that IoT hub routes messages to, based on the routing rules.
- event
Hubs 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.
- service
Bus List<Property Map>Queues - The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
- service
Bus List<Property Map>Topics - The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
- storage
Containers List<Property Map> - The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
RoutingEventHubPropertiesResponse
- Name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- Authentication
Type string - Method used to authenticate against the event hub endpoint
- Connection
String string - The connection string of the event hub endpoint.
- Endpoint
Uri string - The url of the event hub endpoint. It must include the protocol sb://
- Entity
Path string - Event hub name on the event hub namespace
- Id string
- Id of the event hub endpoint
- Identity
Pulumi.
Azure Native. Devices. Inputs. Managed Identity Response - Managed identity properties of routing event hub endpoint.
- Resource
Group string - The name of the resource group of the event hub endpoint.
- Subscription
Id string - The subscription identifier of the event hub endpoint.
- Name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- Authentication
Type string - Method used to authenticate against the event hub endpoint
- Connection
String string - The connection string of the event hub endpoint.
- Endpoint
Uri string - The url of the event hub endpoint. It must include the protocol sb://
- Entity
Path string - Event hub name on the event hub namespace
- Id string
- Id of the event hub endpoint
- Identity
Managed
Identity Response - Managed identity properties of routing event hub endpoint.
- Resource
Group string - The name of the resource group of the event hub endpoint.
- Subscription
Id string - The subscription identifier of the event hub endpoint.
- name String
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication
Type String - Method used to authenticate against the event hub endpoint
- connection
String String - The connection string of the event hub endpoint.
- endpoint
Uri String - The url of the event hub endpoint. It must include the protocol sb://
- entity
Path String - Event hub name on the event hub namespace
- id String
- Id of the event hub endpoint
- identity
Managed
Identity Response - Managed identity properties of routing event hub endpoint.
- resource
Group String - The name of the resource group of the event hub endpoint.
- subscription
Id String - The subscription identifier of the event hub endpoint.
- name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication
Type string - Method used to authenticate against the event hub endpoint
- connection
String string - The connection string of the event hub endpoint.
- endpoint
Uri string - The url of the event hub endpoint. It must include the protocol sb://
- entity
Path string - Event hub name on the event hub namespace
- id string
- Id of the event hub endpoint
- identity
Managed
Identity Response - Managed identity properties of routing event hub endpoint.
- resource
Group string - The name of the resource group of the event hub endpoint.
- subscription
Id string - The subscription identifier of the event hub endpoint.
- name str
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication_
type str - Method used to authenticate against the event hub endpoint
- connection_
string str - The connection string of the event hub endpoint.
- endpoint_
uri str - The url of the event hub endpoint. It must include the protocol sb://
- entity_
path str - Event hub name on the event hub namespace
- id str
- Id of the event hub endpoint
- identity
Managed
Identity Response - 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 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.
- authentication
Type String - Method used to authenticate against the event hub endpoint
- connection
String String - The connection string of the event hub endpoint.
- endpoint
Uri String - The url of the event hub endpoint. It must include the protocol sb://
- entity
Path 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.
- resource
Group String - The name of the resource group of the event hub endpoint.
- subscription
Id String - The subscription identifier of the event hub endpoint.
RoutingPropertiesResponse
- Endpoints
Pulumi.
Azure Native. Devices. Inputs. Routing Endpoints Response - 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.
Azure Native. Devices. Inputs. Enrichment Properties Response> - 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 Pulumi.Azure Native. Devices. Inputs. Fallback Route Properties Response - The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
- Routes
List<Pulumi.
Azure Native. Devices. Inputs. Route Properties Response> - 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
Routing
Endpoints Response - 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
[]Enrichment
Properties Response - 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 FallbackRoute Properties Response - The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
- Routes
[]Route
Properties Response - 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
Routing
Endpoints Response - 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<Enrichment
Properties Response> - 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 FallbackRoute Properties Response - The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
- routes
List<Route
Properties Response> - 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
Routing
Endpoints Response - 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
Enrichment
Properties Response[] - 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 FallbackRoute Properties Response - The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
- routes
Route
Properties Response[] - 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
Routing
Endpoints Response - 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[Enrichment
Properties Response] - 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 FallbackRoute Properties Response - The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
- routes
Sequence[Route
Properties Response] - 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
- fallback
Route Property Map - The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
- routes List<Property Map>
- The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
RoutingServiceBusQueueEndpointPropertiesResponse
- Name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
- Authentication
Type string - Method used to authenticate against the service bus queue endpoint
- Connection
String string - The connection string of the service bus queue endpoint.
- Endpoint
Uri string - The url of the service bus queue endpoint. It must include the protocol sb://
- Entity
Path string - Queue name on the service bus namespace
- Id string
- Id of the service bus queue endpoint
- Identity
Pulumi.
Azure Native. Devices. Inputs. Managed Identity Response - Managed identity properties of routing service bus queue endpoint.
- Resource
Group string - The name of the resource group of the service bus queue endpoint.
- Subscription
Id string - The subscription identifier of the service bus queue endpoint.
- Name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
- Authentication
Type string - Method used to authenticate against the service bus queue endpoint
- Connection
String string - The connection string of the service bus queue endpoint.
- Endpoint
Uri string - The url of the service bus queue endpoint. It must include the protocol sb://
- Entity
Path string - Queue name on the service bus namespace
- Id string
- Id of the service bus queue endpoint
- Identity
Managed
Identity Response - Managed identity properties of routing service bus queue endpoint.
- Resource
Group string - The name of the resource group of the service bus queue endpoint.
- Subscription
Id string - The subscription identifier of the service bus queue endpoint.
- name String
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
- authentication
Type String - Method used to authenticate against the service bus queue endpoint
- connection
String String - The connection string of the service bus queue endpoint.
- endpoint
Uri String - The url of the service bus queue endpoint. It must include the protocol sb://
- entity
Path String - Queue name on the service bus namespace
- id String
- Id of the service bus queue endpoint
- identity
Managed
Identity Response - Managed identity properties of routing service bus queue endpoint.
- resource
Group String - The name of the resource group of the service bus queue endpoint.
- subscription
Id String - The subscription identifier of the service bus queue endpoint.
- name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
- authentication
Type string - Method used to authenticate against the service bus queue endpoint
- connection
String string - The connection string of the service bus queue endpoint.
- endpoint
Uri string - The url of the service bus queue endpoint. It must include the protocol sb://
- entity
Path string - Queue name on the service bus namespace
- id string
- Id of the service bus queue endpoint
- identity
Managed
Identity Response - Managed identity properties of routing service bus queue endpoint.
- resource
Group string - The name of the resource group of the service bus queue endpoint.
- subscription
Id string - The subscription identifier of the service bus queue endpoint.
- name str
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
- authentication_
type str - Method used to authenticate against the service bus queue endpoint
- connection_
string str - The connection string of the service bus queue endpoint.
- endpoint_
uri str - The url of the service bus queue endpoint. It must include the protocol sb://
- entity_
path str - Queue name on the service bus namespace
- id str
- Id of the service bus queue endpoint
- identity
Managed
Identity Response - 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 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.
- authentication
Type String - Method used to authenticate against the service bus queue endpoint
- connection
String String - The connection string of the service bus queue endpoint.
- endpoint
Uri String - The url of the service bus queue endpoint. It must include the protocol sb://
- entity
Path 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.
- resource
Group String - The name of the resource group of the service bus queue endpoint.
- subscription
Id String - The subscription identifier of the service bus queue endpoint.
RoutingServiceBusTopicEndpointPropertiesResponse
- Name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.
- Authentication
Type string - Method used to authenticate against the service bus topic endpoint
- Connection
String string - The connection string of the service bus topic endpoint.
- Endpoint
Uri string - The url of the service bus topic endpoint. It must include the protocol sb://
- Entity
Path string - Queue name on the service bus topic
- Id string
- Id of the service bus topic endpoint
- Identity
Pulumi.
Azure Native. Devices. Inputs. Managed Identity Response - Managed identity properties of routing service bus topic endpoint.
- Resource
Group string - The name of the resource group of the service bus topic endpoint.
- Subscription
Id string - The subscription identifier of the service bus topic endpoint.
- Name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.
- Authentication
Type string - Method used to authenticate against the service bus topic endpoint
- Connection
String string - The connection string of the service bus topic endpoint.
- Endpoint
Uri string - The url of the service bus topic endpoint. It must include the protocol sb://
- Entity
Path string - Queue name on the service bus topic
- Id string
- Id of the service bus topic endpoint
- Identity
Managed
Identity Response - Managed identity properties of routing service bus topic endpoint.
- Resource
Group string - The name of the resource group of the service bus topic endpoint.
- Subscription
Id string - The subscription identifier of the service bus topic endpoint.
- name String
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.
- authentication
Type String - Method used to authenticate against the service bus topic endpoint
- connection
String String - The connection string of the service bus topic endpoint.
- endpoint
Uri String - The url of the service bus topic endpoint. It must include the protocol sb://
- entity
Path String - Queue name on the service bus topic
- id String
- Id of the service bus topic endpoint
- identity
Managed
Identity Response - Managed identity properties of routing service bus topic endpoint.
- resource
Group String - The name of the resource group of the service bus topic endpoint.
- subscription
Id String - The subscription identifier of the service bus topic endpoint.
- name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.
- authentication
Type string - Method used to authenticate against the service bus topic endpoint
- connection
String string - The connection string of the service bus topic endpoint.
- endpoint
Uri string - The url of the service bus topic endpoint. It must include the protocol sb://
- entity
Path string - Queue name on the service bus topic
- id string
- Id of the service bus topic endpoint
- identity
Managed
Identity Response - Managed identity properties of routing service bus topic endpoint.
- resource
Group string - The name of the resource group of the service bus topic endpoint.
- subscription
Id string - The subscription identifier of the service bus topic endpoint.
- name str
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.
- authentication_
type str - Method used to authenticate against the service bus topic endpoint
- connection_
string str - The connection string of the service bus topic endpoint.
- endpoint_
uri str - The url of the service bus topic endpoint. It must include the protocol sb://
- entity_
path str - Queue name on the service bus topic
- id str
- Id of the service bus topic endpoint
- identity
Managed
Identity Response - 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 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.
- authentication
Type String - Method used to authenticate against the service bus topic endpoint
- connection
String String - The connection string of the service bus topic endpoint.
- endpoint
Uri String - The url of the service bus topic endpoint. It must include the protocol sb://
- entity
Path 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.
- resource
Group String - The name of the resource group of the service bus topic endpoint.
- subscription
Id String - The subscription identifier of the service bus topic endpoint.
RoutingStorageContainerPropertiesResponse
- Container
Name string - The name of storage container in the storage account.
- Name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- Authentication
Type string - Method used to authenticate against the storage endpoint
- Batch
Frequency intIn Seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
- Connection
String 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'.
- Endpoint
Uri string - The url of the storage endpoint. It must include the protocol https://
- File
Name stringFormat - 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.
Azure Native. Devices. Inputs. Managed Identity Response - Managed identity properties of routing storage endpoint.
- Max
Chunk intSize In Bytes - 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 string - The name of the resource group of the storage account.
- Subscription
Id string - The subscription identifier of the storage account.
- Container
Name string - The name of storage container in the storage account.
- Name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- Authentication
Type string - Method used to authenticate against the storage endpoint
- Batch
Frequency intIn Seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
- Connection
String 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'.
- Endpoint
Uri string - The url of the storage endpoint. It must include the protocol https://
- File
Name stringFormat - 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
Managed
Identity Response - Managed identity properties of routing storage endpoint.
- Max
Chunk intSize In Bytes - 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 string - The name of the resource group of the storage account.
- Subscription
Id string - The subscription identifier of the storage account.
- container
Name String - The name of storage container in the storage account.
- name String
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication
Type String - Method used to authenticate against the storage endpoint
- batch
Frequency IntegerIn Seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
- connection
String 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'.
- endpoint
Uri String - The url of the storage endpoint. It must include the protocol https://
- file
Name StringFormat - 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
Managed
Identity Response - Managed identity properties of routing storage endpoint.
- max
Chunk IntegerSize In Bytes - 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 String - The name of the resource group of the storage account.
- subscription
Id String - The subscription identifier of the storage account.
- container
Name string - The name of storage container in the storage account.
- name string
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication
Type string - Method used to authenticate against the storage endpoint
- batch
Frequency numberIn Seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
- connection
String 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'.
- endpoint
Uri string - The url of the storage endpoint. It must include the protocol https://
- file
Name stringFormat - 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
Managed
Identity Response - Managed identity properties of routing storage endpoint.
- max
Chunk numberSize In Bytes - 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 string - The name of the resource group of the storage account.
- subscription
Id string - The subscription identifier of the storage account.
- container_
name str - The name of storage container in the storage account.
- name str
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication_
type str - Method used to authenticate against the storage endpoint
- batch_
frequency_ intin_ seconds - 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_ strformat - 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
Managed
Identity Response - Managed identity properties of routing storage endpoint.
- max_
chunk_ intsize_ in_ bytes - 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.
- container
Name String - The name of storage container in the storage account.
- name String
- The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
- authentication
Type String - Method used to authenticate against the storage endpoint
- batch
Frequency NumberIn Seconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
- connection
String 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'.
- endpoint
Uri String - The url of the storage endpoint. It must include the protocol https://
- file
Name StringFormat - 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.
- max
Chunk NumberSize In Bytes - 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 String - The name of the resource group of the storage account.
- subscription
Id String - The subscription identifier of the storage account.
SharedAccessSignatureAuthorizationRuleResponse
- Key
Name string - The name of the shared access policy.
- Rights string
- The permissions assigned to the shared access policy.
- Primary
Key string - The primary key.
- Secondary
Key string - The secondary key.
- Key
Name string - The name of the shared access policy.
- Rights string
- The permissions assigned to the shared access policy.
- Primary
Key string - The primary key.
- Secondary
Key string - The secondary key.
- key
Name String - The name of the shared access policy.
- rights String
- The permissions assigned to the shared access policy.
- primary
Key String - The primary key.
- secondary
Key String - The secondary key.
- key
Name string - The name of the shared access policy.
- rights string
- The permissions assigned to the shared access policy.
- primary
Key string - The primary key.
- secondary
Key string - The secondary key.
- key_
name str - The name of the shared access policy.
- rights str
- The permissions assigned to the shared access policy.
- primary_
key str - The primary key.
- secondary_
key str - The secondary key.
- key
Name String - The name of the shared access policy.
- rights String
- The permissions assigned to the shared access policy.
- primary
Key String - The primary key.
- secondary
Key String - The secondary key.
StorageEndpointPropertiesResponse
- Connection
String string - The connection string for the Azure Storage account to which files are uploaded.
- Container
Name string - 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 string - Specifies authentication type being used for connecting to the storage account.
- Identity
Pulumi.
Azure Native. Devices. Inputs. Managed Identity Response - Managed identity properties of storage endpoint for file upload.
- Sas
Ttl stringAs Iso8601 - 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 string - The connection string for the Azure Storage account to which files are uploaded.
- Container
Name string - 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 string - Specifies authentication type being used for connecting to the storage account.
- Identity
Managed
Identity Response - Managed identity properties of storage endpoint for file upload.
- Sas
Ttl stringAs Iso8601 - 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 String - The connection string for the Azure Storage account to which files are uploaded.
- container
Name String - 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 String - Specifies authentication type being used for connecting to the storage account.
- identity
Managed
Identity Response - Managed identity properties of storage endpoint for file upload.
- sas
Ttl StringAs Iso8601 - 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 string - The connection string for the Azure Storage account to which files are uploaded.
- container
Name string - 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 string - Specifies authentication type being used for connecting to the storage account.
- identity
Managed
Identity Response - Managed identity properties of storage endpoint for file upload.
- sas
Ttl stringAs Iso8601 - The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.
- connection_
string str - The connection string for the Azure Storage account to which files are uploaded.
- container_
name str - The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.
- authentication_
type str - Specifies authentication type being used for connecting to the storage account.
- identity
Managed
Identity Response - Managed identity properties of storage endpoint for file upload.
- sas_
ttl_ stras_ iso8601 - 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 String - The connection string for the Azure Storage account to which files are uploaded.
- container
Name String - 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 String - Specifies authentication type being used for connecting to the storage account.
- identity Property Map
- Managed identity properties of storage endpoint for file upload.
- sas
Ttl StringAs Iso8601 - 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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 v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi