devices.azure.com/v1api20210702
APIVersion
| Value | Description |
|---|---|
| “2021-07-02” |
IotHub
Generator information: - Generated from: /iothub/resource-manager/Microsoft.Devices/stable/2021-07-02/iothub.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
Used by: IotHubList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | IotHub_Spec Optional |
|
| status | IotHub_STATUS Optional |
IotHub_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| identity | The managed identities for the IotHub. | ArmIdentity Optional |
| location | The resource location. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | IotHubOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| properties | IotHub properties | IotHubProperties Optional |
| sku | IotHub SKU info | IotHubSkuInfo Required |
| tags | The resource tags. | map[string]string Optional |
IotHub_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| etag | 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. | string Optional |
| id | The resource identifier. | string Optional |
| identity | The managed identities for the IotHub. | ArmIdentity_STATUS Optional |
| location | The resource location. | string Optional |
| name | The resource name. | string Optional |
| properties | IotHub properties | IotHubProperties_STATUS Optional |
| sku | IotHub SKU info | IotHubSkuInfo_STATUS Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| tags | The resource tags. | map[string]string Optional |
| type | The resource type. | string Optional |
IotHubList
Generator information: - Generated from: /iothub/resource-manager/Microsoft.Devices/stable/2021-07-02/iothub.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | IotHub[] Optional |
IotHub_Spec
Used by: IotHub.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| identity | The managed identities for the IotHub. | ArmIdentity Optional |
| location | The resource location. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | IotHubOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| properties | IotHub properties | IotHubProperties Optional |
| sku | IotHub SKU info | IotHubSkuInfo Required |
| tags | The resource tags. | map[string]string Optional |
IotHub_STATUS
Used by: IotHub.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| etag | 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. | string Optional |
| id | The resource identifier. | string Optional |
| identity | The managed identities for the IotHub. | ArmIdentity_STATUS Optional |
| location | The resource location. | string Optional |
| name | The resource name. | string Optional |
| properties | IotHub properties | IotHubProperties_STATUS Optional |
| sku | IotHub SKU info | IotHubSkuInfo_STATUS Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| tags | The resource tags. | map[string]string Optional |
| type | The resource type. | string Optional |
ArmIdentity
Used by: IotHub_Spec.
| Property | Description | Type |
|---|---|---|
| type | 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. | ArmIdentity_Type Optional |
| userAssignedIdentities | UserAssignedIdentityDetails[] Optional |
ArmIdentity_STATUS
Used by: IotHub_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | Principal Id | string Optional |
| tenantId | Tenant Id | string Optional |
| type | 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. | ArmIdentity_Type_STATUS Optional |
| userAssignedIdentities | map[string]ArmUserIdentity_STATUS Optional |
IotHubOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: IotHub_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | IotHubOperatorSecrets Optional |
IotHubProperties
The properties of an IoT hub.
Used by: IotHub_Spec.
| Property | Description | Type |
|---|---|---|
| allowedFqdnList | List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub. | string[] Optional |
| authorizationPolicies | The shared access policies you can use to secure a connection to the IoT hub. | SharedAccessSignatureAuthorizationRule[] Optional |
| cloudToDevice | The IoT hub cloud-to-device messaging properties. | CloudToDeviceProperties Optional |
| comments | IoT hub comments. | string Optional |
| disableDeviceSAS | If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication. | bool Optional |
| disableLocalAuth | If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication. | bool Optional |
| disableModuleSAS | If true, all module scoped SAS keys cannot be used for authentication. | bool Optional |
| enableDataResidency | This property when set to true, will enable data residency, thus, disabling disaster recovery. | bool Optional |
| enableFileUploadNotifications | If True, file upload notifications are enabled. | bool Optional |
| eventHubEndpoints | 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. | map[string]EventHubProperties Optional |
| features | The capabilities and features enabled for the IoT hub. | IotHubProperties_Features Optional |
| ipFilterRules | The IP filter rules. | IpFilterRule[] Optional |
| messagingEndpoints | The messaging endpoint properties for the file upload notification queue. | map[string]MessagingEndpointProperties Optional |
| minTlsVersion | 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. | string Optional |
| networkRuleSets | Network Rule Set Properties of IotHub | NetworkRuleSetProperties Optional |
| publicNetworkAccess | Whether requests from Public Network are allowed | IotHubProperties_PublicNetworkAccess Optional |
| restrictOutboundNetworkAccess | If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList. | bool Optional |
| routing | The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties Optional |
| storageEndpoints | 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. | map[string]StorageEndpointProperties Optional |
IotHubProperties_STATUS
The properties of an IoT hub.
Used by: IotHub_STATUS.
| Property | Description | Type |
|---|---|---|
| allowedFqdnList | List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub. | string[] Optional |
| authorizationPolicies | The shared access policies you can use to secure a connection to the IoT hub. | SharedAccessSignatureAuthorizationRule_STATUS[] Optional |
| cloudToDevice | The IoT hub cloud-to-device messaging properties. | CloudToDeviceProperties_STATUS Optional |
| comments | IoT hub comments. | string Optional |
| disableDeviceSAS | If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication. | bool Optional |
| disableLocalAuth | If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication. | bool Optional |
| disableModuleSAS | If true, all module scoped SAS keys cannot be used for authentication. | bool Optional |
| enableDataResidency | This property when set to true, will enable data residency, thus, disabling disaster recovery. | bool Optional |
| enableFileUploadNotifications | If True, file upload notifications are enabled. | bool Optional |
| eventHubEndpoints | 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. | map[string]EventHubProperties_STATUS Optional |
| features | The capabilities and features enabled for the IoT hub. | IotHubProperties_Features_STATUS Optional |
| hostName | The name of the host. | string Optional |
| ipFilterRules | The IP filter rules. | IpFilterRule_STATUS[] Optional |
| locations | Primary and secondary location for iot hub | IotHubLocationDescription_STATUS[] Optional |
| messagingEndpoints | The messaging endpoint properties for the file upload notification queue. | map[string]MessagingEndpointProperties_STATUS Optional |
| minTlsVersion | 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. | string Optional |
| networkRuleSets | Network Rule Set Properties of IotHub | NetworkRuleSetProperties_STATUS Optional |
| privateEndpointConnections | Private endpoint connections created on this IotHub | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | The provisioning state. | string Optional |
| publicNetworkAccess | Whether requests from Public Network are allowed | IotHubProperties_PublicNetworkAccess_STATUS Optional |
| restrictOutboundNetworkAccess | If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList. | bool Optional |
| routing | The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties_STATUS Optional |
| state | The hub state. | string Optional |
| storageEndpoints | 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. | map[string]StorageEndpointProperties_STATUS Optional |
IotHubSkuInfo
Information about the SKU of the IoT hub.
Used by: IotHub_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. | int Optional |
| name | The name of the SKU. | IotHubSkuInfo_Name Required |
IotHubSkuInfo_STATUS
Information about the SKU of the IoT hub.
Used by: IotHub_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. | int Optional |
| name | The name of the SKU. | IotHubSkuInfo_Name_STATUS Optional |
| tier | The billing tier for the IoT hub. | IotHubSkuInfo_Tier_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: IotHub_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
ArmIdentity_Type
Used by: ArmIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
ArmIdentity_Type_STATUS
Used by: ArmIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
ArmUserIdentity_STATUS
Used by: ArmIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | string Optional |
|
| principalId | string Optional |
CloudToDeviceProperties
The IoT hub cloud-to-device messaging properties.
Used by: IotHubProperties.
| Property | Description | Type |
|---|---|---|
| defaultTtlAsIso8601 | 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. | string Optional |
| feedback | The properties of the feedback queue for cloud-to-device messages. | FeedbackProperties Optional |
| maxDeliveryCount | 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. | int Optional |
CloudToDeviceProperties_STATUS
The IoT hub cloud-to-device messaging properties.
Used by: IotHubProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| defaultTtlAsIso8601 | 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. | string Optional |
| feedback | The properties of the feedback queue for cloud-to-device messages. | FeedbackProperties_STATUS Optional |
| maxDeliveryCount | 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. | int Optional |
EventHubProperties
The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
Used by: IotHubProperties.
| Property | Description | Type |
|---|---|---|
| partitionCount | 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. | int Optional |
| retentionTimeInDays | 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 | int Optional |
EventHubProperties_STATUS
The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
Used by: IotHubProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| endpoint | The Event Hub-compatible endpoint. | string Optional |
| partitionCount | 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. | int Optional |
| partitionIds | The partition ids in the Event Hub-compatible endpoint. | string[] Optional |
| path | The Event Hub-compatible name. | string Optional |
| retentionTimeInDays | 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 | int Optional |
IotHubLocationDescription_STATUS
Public representation of one of the locations where a resource is provisioned.
Used by: IotHubProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| location | The name of the Azure region | string Optional |
| role | 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. | IotHubLocationDescription_Role_STATUS Optional |
IotHubOperatorSecrets
Used by: IotHubOperatorSpec.
| Property | Description | Type |
|---|---|---|
| devicePrimaryKey | indicates where the DevicePrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| deviceSecondaryKey | indicates where the DeviceSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| iotHubOwnerPrimaryKey | indicates where the IotHubOwnerPrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| iotHubOwnerSecondaryKey | indicates where the IotHubOwnerSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| registryReadPrimaryKey | indicates where the RegistryReadPrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| registryReadSecondaryKey | indicates where the RegistryReadSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| registryReadWritePrimaryKey | indicates where the RegistryReadWritePrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| registryReadWriteSecondaryKey | indicates where the RegistryReadWriteSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| servicePrimaryKey | indicates where the ServicePrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| serviceSecondaryKey | indicates where the ServiceSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
IotHubProperties_Features
Used by: IotHubProperties.
| Value | Description |
|---|---|
| “DeviceManagement” | |
| “None” |
IotHubProperties_Features_STATUS
Used by: IotHubProperties_STATUS.
| Value | Description |
|---|---|
| “DeviceManagement” | |
| “None” |
IotHubProperties_PublicNetworkAccess
Used by: IotHubProperties.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
IotHubProperties_PublicNetworkAccess_STATUS
Used by: IotHubProperties_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
IotHubSkuInfo_Name
Used by: IotHubSkuInfo.
| Value | Description |
|---|---|
| “B1” | |
| “B2” | |
| “B3” | |
| “F1” | |
| “S1” | |
| “S2” | |
| “S3” |
IotHubSkuInfo_Name_STATUS
Used by: IotHubSkuInfo_STATUS.
| Value | Description |
|---|---|
| “B1” | |
| “B2” | |
| “B3” | |
| “F1” | |
| “S1” | |
| “S2” | |
| “S3” |
IotHubSkuInfo_Tier_STATUS
Used by: IotHubSkuInfo_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Free” | |
| “Standard” |
IpFilterRule
The IP filter rules for the IoT hub.
Used by: IotHubProperties.
| Property | Description | Type |
|---|---|---|
| action | The desired action for requests captured by this rule. | IpFilterRule_Action Required |
| filterName | The name of the IP filter rule. | string Required |
| ipMask | A string that contains the IP address range in CIDR notation for the rule. | string Required |
IpFilterRule_STATUS
The IP filter rules for the IoT hub.
Used by: IotHubProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| action | The desired action for requests captured by this rule. | IpFilterRule_Action_STATUS Optional |
| filterName | The name of the IP filter rule. | string Optional |
| ipMask | A string that contains the IP address range in CIDR notation for the rule. | string Optional |
MessagingEndpointProperties
The properties of the messaging endpoints used by this IoT hub.
Used by: IotHubProperties.
| Property | Description | Type |
|---|---|---|
| lockDurationAsIso8601 | The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. | string Optional |
| maxDeliveryCount | 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. | int Optional |
| ttlAsIso8601 | 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. | string Optional |
MessagingEndpointProperties_STATUS
The properties of the messaging endpoints used by this IoT hub.
Used by: IotHubProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| lockDurationAsIso8601 | The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. | string Optional |
| maxDeliveryCount | 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. | int Optional |
| ttlAsIso8601 | 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. | string Optional |
NetworkRuleSetProperties
Network Rule Set Properties of IotHub
Used by: IotHubProperties.
| Property | Description | Type |
|---|---|---|
| applyToBuiltInEventHubEndpoint | If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub | bool Required |
| defaultAction | Default Action for Network Rule Set | NetworkRuleSetProperties_DefaultAction Optional |
| ipRules | List of IP Rules | NetworkRuleSetIpRule[] Required |
NetworkRuleSetProperties_STATUS
Network Rule Set Properties of IotHub
Used by: IotHubProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| applyToBuiltInEventHubEndpoint | If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub | bool Optional |
| defaultAction | Default Action for Network Rule Set | NetworkRuleSetProperties_DefaultAction_STATUS Optional |
| ipRules | List of IP Rules | NetworkRuleSetIpRule_STATUS[] Optional |
PrivateEndpointConnection_STATUS
The private endpoint connection of an IotHub
Used by: IotHubProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| id | The resource identifier. | string Optional |
RoutingProperties
The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Used by: IotHubProperties.
| Property | Description | Type |
|---|---|---|
| endpoints | 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. | RoutingEndpoints Optional |
| enrichments | 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 | EnrichmentProperties[] Optional |
| fallbackRoute | The properties of the route that is used as a fall-back route when none of the conditions specified in the ‘routes’ section are met. This is an optional parameter. When this property is not present in the template, the fallback route is disabled by default. | FallbackRouteProperties Optional |
| routes | 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. | RouteProperties[] Optional |
RoutingProperties_STATUS
The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Used by: IotHubProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| endpoints | 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. | RoutingEndpoints_STATUS Optional |
| enrichments | 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 | EnrichmentProperties_STATUS[] Optional |
| fallbackRoute | The properties of the route that is used as a fall-back route when none of the conditions specified in the ‘routes’ section are met. This is an optional parameter. When this property is not present in the template, the fallback route is disabled by default. | FallbackRouteProperties_STATUS Optional |
| routes | 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. | RouteProperties_STATUS[] Optional |
SharedAccessSignatureAuthorizationRule
The properties of an IoT hub shared access policy.
Used by: IotHubProperties.
| Property | Description | Type |
|---|---|---|
| keyName | The name of the shared access policy. | string Required |
| rights | The permissions assigned to the shared access policy. | SharedAccessSignatureAuthorizationRule_Rights Required |
SharedAccessSignatureAuthorizationRule_STATUS
The properties of an IoT hub shared access policy.
Used by: IotHubProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| keyName | The name of the shared access policy. | string Optional |
| rights | The permissions assigned to the shared access policy. | SharedAccessSignatureAuthorizationRule_Rights_STATUS Optional |
StorageEndpointProperties
The properties of the Azure Storage endpoint for file upload.
Used by: IotHubProperties.
| Property | Description | Type |
|---|---|---|
| authenticationType | Specifies authentication type being used for connecting to the storage account. | StorageEndpointProperties_AuthenticationType Optional |
| connectionString | The connection string for the Azure Storage account to which files are uploaded. | genruntime.SecretReference Required |
| containerName | The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. | string Required |
| identity | Managed identity properties of storage endpoint for file upload. | ManagedIdentity Optional |
| sasTtlAsIso8601 | 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. | string Optional |
StorageEndpointProperties_STATUS
The properties of the Azure Storage endpoint for file upload.
Used by: IotHubProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| authenticationType | Specifies authentication type being used for connecting to the storage account. | StorageEndpointProperties_AuthenticationType_STATUS Optional |
| containerName | The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. | string Optional |
| identity | Managed identity properties of storage endpoint for file upload. | ManagedIdentity_STATUS Optional |
| sasTtlAsIso8601 | 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. | string Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ArmIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
EnrichmentProperties
The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.
Used by: RoutingProperties.
| Property | Description | Type |
|---|---|---|
| endpointNames | The list of endpoints for which the enrichment is applied to the message. | string[] Required |
| key | The key or name for the enrichment property. | string Required |
| value | The value for the enrichment property. | string Required |
EnrichmentProperties_STATUS
The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.
Used by: RoutingProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| endpointNames | The list of endpoints for which the enrichment is applied to the message. | string[] Optional |
| key | The key or name for the enrichment property. | string Optional |
| value | The value for the enrichment property. | string Optional |
FallbackRouteProperties
The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.
Used by: RoutingProperties.
| Property | Description | Type |
|---|---|---|
| condition | 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 | string Optional |
| endpointNames | The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. | string[] Required |
| isEnabled | Used to specify whether the fallback route is enabled. | bool Required |
| name | 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. | string Optional |
| source | The source to which the routing rule is to be applied to. For example, DeviceMessages | FallbackRouteProperties_Source Required |
FallbackRouteProperties_STATUS
The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.
Used by: RoutingProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| condition | 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 | string Optional |
| endpointNames | The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. | string[] Optional |
| isEnabled | Used to specify whether the fallback route is enabled. | bool Optional |
| name | 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. | string Optional |
| source | The source to which the routing rule is to be applied to. For example, DeviceMessages | FallbackRouteProperties_Source_STATUS Optional |
FeedbackProperties
The properties of the feedback queue for cloud-to-device messages.
Used by: CloudToDeviceProperties.
| Property | Description | Type |
|---|---|---|
| lockDurationAsIso8601 | The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string Optional |
| maxDeliveryCount | 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. | int Optional |
| ttlAsIso8601 | 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. | string Optional |
FeedbackProperties_STATUS
The properties of the feedback queue for cloud-to-device messages.
Used by: CloudToDeviceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| lockDurationAsIso8601 | The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | string Optional |
| maxDeliveryCount | 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. | int Optional |
| ttlAsIso8601 | 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. | string Optional |
IotHubLocationDescription_Role_STATUS
Used by: IotHubLocationDescription_STATUS.
| Value | Description |
|---|---|
| “primary” | |
| “secondary” |
IpFilterRule_Action
Used by: IpFilterRule.
| Value | Description |
|---|---|
| “Accept” | |
| “Reject” |
IpFilterRule_Action_STATUS
Used by: IpFilterRule_STATUS.
| Value | Description |
|---|---|
| “Accept” | |
| “Reject” |
ManagedIdentity
The properties of the Managed identity.
Used by: RoutingEventHubProperties, RoutingServiceBusQueueEndpointProperties, RoutingServiceBusTopicEndpointProperties, RoutingStorageContainerProperties, and StorageEndpointProperties.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentity | The user assigned identity. | string Optional |
ManagedIdentity_STATUS
The properties of the Managed identity.
Used by: RoutingEventHubProperties_STATUS, RoutingServiceBusQueueEndpointProperties_STATUS, RoutingServiceBusTopicEndpointProperties_STATUS, RoutingStorageContainerProperties_STATUS, and StorageEndpointProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentity | The user assigned identity. | string Optional |
NetworkRuleSetIpRule
IP Rule to be applied as part of Network Rule Set
Used by: NetworkRuleSetProperties.
| Property | Description | Type |
|---|---|---|
| action | IP Filter Action | NetworkRuleSetIpRule_Action Optional |
| filterName | Name of the IP filter rule. | string Required |
| ipMask | A string that contains the IP address range in CIDR notation for the rule. | string Required |
NetworkRuleSetIpRule_STATUS
IP Rule to be applied as part of Network Rule Set
Used by: NetworkRuleSetProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| action | IP Filter Action | NetworkRuleSetIpRule_Action_STATUS Optional |
| filterName | Name of the IP filter rule. | string Optional |
| ipMask | A string that contains the IP address range in CIDR notation for the rule. | string Optional |
NetworkRuleSetProperties_DefaultAction
Used by: NetworkRuleSetProperties.
| Value | Description |
|---|---|
| “Allow” | |
| “Deny” |
NetworkRuleSetProperties_DefaultAction_STATUS
Used by: NetworkRuleSetProperties_STATUS.
| Value | Description |
|---|---|
| “Allow” | |
| “Deny” |
RouteProperties
The properties of a routing rule that your IoT hub uses to route messages to endpoints.
Used by: RoutingProperties.
| Property | Description | Type |
|---|---|---|
| condition | 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 | string Optional |
| endpointNames | The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. | string[] Required |
| isEnabled | Used to specify whether a route is enabled. | bool Required |
| name | 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. | string Required |
| source | The source that the routing rule is to be applied to, such as DeviceMessages. | RouteProperties_Source Required |
RouteProperties_STATUS
The properties of a routing rule that your IoT hub uses to route messages to endpoints.
Used by: RoutingProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| condition | 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 | string Optional |
| endpointNames | The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. | string[] Optional |
| isEnabled | Used to specify whether a route is enabled. | bool Optional |
| name | 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. | string Optional |
| source | The source that the routing rule is to be applied to, such as DeviceMessages. | RouteProperties_Source_STATUS Optional |
RoutingEndpoints
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.
Used by: RoutingProperties.
| Property | Description | Type |
|---|---|---|
| eventHubs | 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. | RoutingEventHubProperties[] Optional |
| serviceBusQueues | The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. | RoutingServiceBusQueueEndpointProperties[] Optional |
| serviceBusTopics | The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. | RoutingServiceBusTopicEndpointProperties[] Optional |
| storageContainers | The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. | RoutingStorageContainerProperties[] Optional |
RoutingEndpoints_STATUS
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.
Used by: RoutingProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| eventHubs | 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. | RoutingEventHubProperties_STATUS[] Optional |
| serviceBusQueues | The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. | RoutingServiceBusQueueEndpointProperties_STATUS[] Optional |
| serviceBusTopics | The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. | RoutingServiceBusTopicEndpointProperties_STATUS[] Optional |
| storageContainers | The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. | RoutingStorageContainerProperties_STATUS[] Optional |
SharedAccessSignatureAuthorizationRule_Rights
Used by: SharedAccessSignatureAuthorizationRule.
| Value | Description |
|---|---|
| “DeviceConnect” | |
| “RegistryRead” | |
| “RegistryRead, DeviceConnect” | |
| “RegistryRead, RegistryWrite” | |
| “RegistryRead, RegistryWrite, DeviceConnect” | |
| “RegistryRead, RegistryWrite, ServiceConnect” | |
| “RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect” | |
| “RegistryRead, ServiceConnect” | |
| “RegistryRead, ServiceConnect, DeviceConnect” | |
| “RegistryWrite” | |
| “RegistryWrite, DeviceConnect” | |
| “RegistryWrite, ServiceConnect” | |
| “RegistryWrite, ServiceConnect, DeviceConnect” | |
| “ServiceConnect” | |
| “ServiceConnect, DeviceConnect” |
SharedAccessSignatureAuthorizationRule_Rights_STATUS
Used by: SharedAccessSignatureAuthorizationRule_STATUS.
| Value | Description |
|---|---|
| “DeviceConnect” | |
| “RegistryRead” | |
| “RegistryRead, DeviceConnect” | |
| “RegistryRead, RegistryWrite” | |
| “RegistryRead, RegistryWrite, DeviceConnect” | |
| “RegistryRead, RegistryWrite, ServiceConnect” | |
| “RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect” | |
| “RegistryRead, ServiceConnect” | |
| “RegistryRead, ServiceConnect, DeviceConnect” | |
| “RegistryWrite” | |
| “RegistryWrite, DeviceConnect” | |
| “RegistryWrite, ServiceConnect” | |
| “RegistryWrite, ServiceConnect, DeviceConnect” | |
| “ServiceConnect” | |
| “ServiceConnect, DeviceConnect” |
StorageEndpointProperties_AuthenticationType
Used by: StorageEndpointProperties.
| Value | Description |
|---|---|
| “identityBased” | |
| “keyBased” |
StorageEndpointProperties_AuthenticationType_STATUS
Used by: StorageEndpointProperties_STATUS.
| Value | Description |
|---|---|
| “identityBased” | |
| “keyBased” |
FallbackRouteProperties_Source
Used by: FallbackRouteProperties.
| Value | Description |
|---|---|
| “DeviceMessages” |
FallbackRouteProperties_Source_STATUS
Used by: FallbackRouteProperties_STATUS.
| Value | Description |
|---|---|
| “DeviceMessages” |
NetworkRuleSetIpRule_Action
Used by: NetworkRuleSetIpRule.
| Value | Description |
|---|---|
| “Allow” |
NetworkRuleSetIpRule_Action_STATUS
Used by: NetworkRuleSetIpRule_STATUS.
| Value | Description |
|---|---|
| “Allow” |
RouteProperties_Source
Used by: RouteProperties.
| Value | Description |
|---|---|
| “DeviceConnectionStateEvents” | |
| “DeviceJobLifecycleEvents” | |
| “DeviceLifecycleEvents” | |
| “DeviceMessages” | |
| “Invalid” | |
| “TwinChangeEvents” |
RouteProperties_Source_STATUS
Used by: RouteProperties_STATUS.
| Value | Description |
|---|---|
| “DeviceConnectionStateEvents” | |
| “DeviceJobLifecycleEvents” | |
| “DeviceLifecycleEvents” | |
| “DeviceMessages” | |
| “Invalid” | |
| “TwinChangeEvents” |
RoutingEventHubProperties
The properties related to an event hub endpoint.
Used by: RoutingEndpoints.
| Property | Description | Type |
|---|---|---|
| authenticationType | Method used to authenticate against the event hub endpoint | RoutingEventHubProperties_AuthenticationType Optional |
| connectionString | The connection string of the event hub endpoint. | genruntime.SecretReference Optional |
| endpointUri | The url of the event hub endpoint. It must include the protocol sb:// | string Optional |
| entityPath | Event hub name on the event hub namespace | string Optional |
| identity | Managed identity properties of routing event hub endpoint. | ManagedIdentity Optional |
| name | 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. | string Required |
| reference | Id of the event hub endpoint | genruntime.ResourceReference Optional |
| resourceGroup | The name of the resource group of the event hub endpoint. | string Optional |
| subscriptionId | The subscription identifier of the event hub endpoint. | string Optional |
RoutingEventHubProperties_STATUS
The properties related to an event hub endpoint.
Used by: RoutingEndpoints_STATUS.
| Property | Description | Type |
|---|---|---|
| authenticationType | Method used to authenticate against the event hub endpoint | RoutingEventHubProperties_AuthenticationType_STATUS Optional |
| endpointUri | The url of the event hub endpoint. It must include the protocol sb:// | string Optional |
| entityPath | Event hub name on the event hub namespace | string Optional |
| id | Id of the event hub endpoint | string Optional |
| identity | Managed identity properties of routing event hub endpoint. | ManagedIdentity_STATUS Optional |
| name | 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. | string Optional |
| resourceGroup | The name of the resource group of the event hub endpoint. | string Optional |
| subscriptionId | The subscription identifier of the event hub endpoint. | string Optional |
RoutingServiceBusQueueEndpointProperties
The properties related to service bus queue endpoint types.
Used by: RoutingEndpoints.
| Property | Description | Type |
|---|---|---|
| authenticationType | Method used to authenticate against the service bus queue endpoint | RoutingServiceBusQueueEndpointProperties_AuthenticationType Optional |
| connectionString | The connection string of the service bus queue endpoint. | genruntime.SecretReference Optional |
| endpointUri | The url of the service bus queue endpoint. It must include the protocol sb:// | string Optional |
| entityPath | Queue name on the service bus namespace | string Optional |
| identity | Managed identity properties of routing service bus queue endpoint. | ManagedIdentity Optional |
| name | 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. | string Required |
| reference | Id of the service bus queue endpoint | genruntime.ResourceReference Optional |
| resourceGroup | The name of the resource group of the service bus queue endpoint. | string Optional |
| subscriptionId | The subscription identifier of the service bus queue endpoint. | string Optional |
RoutingServiceBusQueueEndpointProperties_STATUS
The properties related to service bus queue endpoint types.
Used by: RoutingEndpoints_STATUS.
| Property | Description | Type |
|---|---|---|
| authenticationType | Method used to authenticate against the service bus queue endpoint | RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS Optional |
| endpointUri | The url of the service bus queue endpoint. It must include the protocol sb:// | string Optional |
| entityPath | Queue name on the service bus namespace | string Optional |
| id | Id of the service bus queue endpoint | string Optional |
| identity | Managed identity properties of routing service bus queue endpoint. | ManagedIdentity_STATUS Optional |
| name | 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. | string Optional |
| resourceGroup | The name of the resource group of the service bus queue endpoint. | string Optional |
| subscriptionId | The subscription identifier of the service bus queue endpoint. | string Optional |
RoutingServiceBusTopicEndpointProperties
The properties related to service bus topic endpoint types.
Used by: RoutingEndpoints.
| Property | Description | Type |
|---|---|---|
| authenticationType | Method used to authenticate against the service bus topic endpoint | RoutingServiceBusTopicEndpointProperties_AuthenticationType Optional |
| connectionString | The connection string of the service bus topic endpoint. | genruntime.SecretReference Optional |
| endpointUri | The url of the service bus topic endpoint. It must include the protocol sb:// | string Optional |
| entityPath | Queue name on the service bus topic | string Optional |
| identity | Managed identity properties of routing service bus topic endpoint. | ManagedIdentity Optional |
| name | 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. | string Required |
| reference | Id of the service bus topic endpoint | genruntime.ResourceReference Optional |
| resourceGroup | The name of the resource group of the service bus topic endpoint. | string Optional |
| subscriptionId | The subscription identifier of the service bus topic endpoint. | string Optional |
RoutingServiceBusTopicEndpointProperties_STATUS
The properties related to service bus topic endpoint types.
Used by: RoutingEndpoints_STATUS.
| Property | Description | Type |
|---|---|---|
| authenticationType | Method used to authenticate against the service bus topic endpoint | RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS Optional |
| endpointUri | The url of the service bus topic endpoint. It must include the protocol sb:// | string Optional |
| entityPath | Queue name on the service bus topic | string Optional |
| id | Id of the service bus topic endpoint | string Optional |
| identity | Managed identity properties of routing service bus topic endpoint. | ManagedIdentity_STATUS Optional |
| name | 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. | string Optional |
| resourceGroup | The name of the resource group of the service bus topic endpoint. | string Optional |
| subscriptionId | The subscription identifier of the service bus topic endpoint. | string Optional |
RoutingStorageContainerProperties
The properties related to a storage container endpoint.
Used by: RoutingEndpoints.
| Property | Description | Type |
|---|---|---|
| authenticationType | Method used to authenticate against the storage endpoint | RoutingStorageContainerProperties_AuthenticationType Optional |
| batchFrequencyInSeconds | Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. | int Optional |
| connectionString | The connection string of the storage account. | genruntime.SecretReference Optional |
| containerName | The name of storage container in the storage account. | string Required |
| encoding | Encoding that is used to serialize messages to blobs. Supported values are ‘avro’, ‘avrodeflate’, and ‘JSON’. Default value is ‘avro’. | RoutingStorageContainerProperties_Encoding Optional |
| endpointUri | The url of the storage endpoint. It must include the protocol https:// | string Optional |
| fileNameFormat | File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. | string Optional |
| identity | Managed identity properties of routing storage endpoint. | ManagedIdentity Optional |
| maxChunkSizeInBytes | Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). | int Optional |
| name | 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. | string Required |
| reference | Id of the storage container endpoint | genruntime.ResourceReference Optional |
| resourceGroup | The name of the resource group of the storage account. | string Optional |
| subscriptionId | The subscription identifier of the storage account. | string Optional |
RoutingStorageContainerProperties_STATUS
The properties related to a storage container endpoint.
Used by: RoutingEndpoints_STATUS.
| Property | Description | Type |
|---|---|---|
| authenticationType | Method used to authenticate against the storage endpoint | RoutingStorageContainerProperties_AuthenticationType_STATUS Optional |
| batchFrequencyInSeconds | Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. | int Optional |
| containerName | The name of storage container in the storage account. | string Optional |
| encoding | Encoding that is used to serialize messages to blobs. Supported values are ‘avro’, ‘avrodeflate’, and ‘JSON’. Default value is ‘avro’. | RoutingStorageContainerProperties_Encoding_STATUS Optional |
| endpointUri | The url of the storage endpoint. It must include the protocol https:// | string Optional |
| fileNameFormat | File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. | string Optional |
| id | Id of the storage container endpoint | string Optional |
| identity | Managed identity properties of routing storage endpoint. | ManagedIdentity_STATUS Optional |
| maxChunkSizeInBytes | Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). | int Optional |
| name | 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. | string Optional |
| resourceGroup | The name of the resource group of the storage account. | string Optional |
| subscriptionId | The subscription identifier of the storage account. | string Optional |
RoutingEventHubProperties_AuthenticationType
Used by: RoutingEventHubProperties.
| Value | Description |
|---|---|
| “identityBased” | |
| “keyBased” |
RoutingEventHubProperties_AuthenticationType_STATUS
Used by: RoutingEventHubProperties_STATUS.
| Value | Description |
|---|---|
| “identityBased” | |
| “keyBased” |
RoutingServiceBusQueueEndpointProperties_AuthenticationType
Used by: RoutingServiceBusQueueEndpointProperties.
| Value | Description |
|---|---|
| “identityBased” | |
| “keyBased” |
RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS
Used by: RoutingServiceBusQueueEndpointProperties_STATUS.
| Value | Description |
|---|---|
| “identityBased” | |
| “keyBased” |
RoutingServiceBusTopicEndpointProperties_AuthenticationType
Used by: RoutingServiceBusTopicEndpointProperties.
| Value | Description |
|---|---|
| “identityBased” | |
| “keyBased” |
RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS
Used by: RoutingServiceBusTopicEndpointProperties_STATUS.
| Value | Description |
|---|---|
| “identityBased” | |
| “keyBased” |
RoutingStorageContainerProperties_AuthenticationType
Used by: RoutingStorageContainerProperties.
| Value | Description |
|---|---|
| “identityBased” | |
| “keyBased” |
RoutingStorageContainerProperties_AuthenticationType_STATUS
Used by: RoutingStorageContainerProperties_STATUS.
| Value | Description |
|---|---|
| “identityBased” | |
| “keyBased” |
RoutingStorageContainerProperties_Encoding
Used by: RoutingStorageContainerProperties.
| Value | Description |
|---|---|
| “Avro” | |
| “AvroDeflate” | |
| “JSON” |
RoutingStorageContainerProperties_Encoding_STATUS
Used by: RoutingStorageContainerProperties_STATUS.
| Value | Description |
|---|---|
| “Avro” | |
| “AvroDeflate” | |
| “JSON” |