devices.azure.com/v1api20210702

Package v1api20210702 contains API Schema definitions for the devices v1api20210702 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2021-07-02"

ArmIdentity

(Appears on:IotHub_Spec)

Field	Description
`type` ArmIdentity_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.
`userAssignedIdentities` []UserAssignedIdentityDetails

ArmIdentity_STATUS

(Appears on:IotHub_STATUS)

Field	Description
`principalId` string	PrincipalId: Principal Id
`tenantId` string	TenantId: Tenant Id
`type` ArmIdentity_Type_STATUS	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.
`userAssignedIdentities` map[string]./api/devices/v1api20210702.ArmUserIdentity_STATUS

ArmIdentity_Type (`string` alias)

(Appears on:ArmIdentity)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"

ArmIdentity_Type_STATUS (`string` alias)

(Appears on:ArmIdentity_STATUS)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"

ArmUserIdentity_STATUS

(Appears on:ArmIdentity_STATUS)

Field	Description
`clientId` string
`principalId` string

CloudToDeviceProperties

(Appears on:IotHubProperties)

The IoT hub cloud-to-device messaging properties.

Field	Description
`defaultTtlAsIso8601` string	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.
`feedback` FeedbackProperties	Feedback: The properties of the feedback queue for cloud-to-device messages.
`maxDeliveryCount` int	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.

CloudToDeviceProperties_STATUS

(Appears on:IotHubProperties_STATUS)

The IoT hub cloud-to-device messaging properties.

Field	Description
`defaultTtlAsIso8601` string	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.
`feedback` FeedbackProperties_STATUS	Feedback: The properties of the feedback queue for cloud-to-device messages.
`maxDeliveryCount` int	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.

EnrichmentProperties

(Appears on:RoutingProperties)

The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.

Field	Description
`endpointNames` []string	EndpointNames: The list of endpoints for which the enrichment is applied to the message.
`key` string	Key: The key or name for the enrichment property.
`value` string	Value: The value for the enrichment property.

EnrichmentProperties_STATUS

(Appears on:RoutingProperties_STATUS)

The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.

Field	Description
`endpointNames` []string	EndpointNames: The list of endpoints for which the enrichment is applied to the message.
`key` string	Key: The key or name for the enrichment property.
`value` string	Value: The value for the enrichment property.

EventHubProperties

(Appears on:IotHubProperties)

The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.

Field	Description
`partitionCount` int	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.
`retentionTimeInDays` int	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

EventHubProperties_STATUS

(Appears on:IotHubProperties_STATUS)

The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.

Field	Description
`endpoint` string	Endpoint: The Event Hub-compatible endpoint.
`partitionCount` int	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.
`partitionIds` []string	PartitionIds: The partition ids in the Event Hub-compatible endpoint.
`path` string	Path: The Event Hub-compatible name.
`retentionTimeInDays` int	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

FallbackRouteProperties

(Appears on:RoutingProperties)

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

Field	Description
`condition` string	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
`endpointNames` []string	EndpointNames: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
`isEnabled` bool	IsEnabled: Used to specify whether the fallback route is enabled.
`name` string	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.
`source` FallbackRouteProperties_Source	Source: The source to which the routing rule is to be applied to. For example, DeviceMessages

FallbackRouteProperties_STATUS

(Appears on:RoutingProperties_STATUS)

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

Field	Description
`condition` string	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
`endpointNames` []string	EndpointNames: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
`isEnabled` bool	IsEnabled: Used to specify whether the fallback route is enabled.
`name` string	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.
`source` FallbackRouteProperties_Source_STATUS	Source: The source to which the routing rule is to be applied to. For example, DeviceMessages

FallbackRouteProperties_Source (`string` alias)

(Appears on:FallbackRouteProperties)

Value	Description
"DeviceMessages"

FallbackRouteProperties_Source_STATUS (`string` alias)

(Appears on:FallbackRouteProperties_STATUS)

Value	Description
"DeviceMessages"

FeedbackProperties

(Appears on:CloudToDeviceProperties)

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

Field	Description
`lockDurationAsIso8601` string	LockDurationAsIso8601: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`maxDeliveryCount` int	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.
`ttlAsIso8601` string	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.

FeedbackProperties_STATUS

(Appears on:CloudToDeviceProperties_STATUS)

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

Field	Description
`lockDurationAsIso8601` string	LockDurationAsIso8601: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
`maxDeliveryCount` int	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.
`ttlAsIso8601` string	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.

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}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
IotHub_Spec

`azureName` string	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.
`identity` ArmIdentity	Identity: The managed identities for the IotHub.
`location` string	Location: The resource location.
`operatorSpec` IotHubOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`properties` IotHubProperties	Properties: IotHub properties
`sku` IotHubSkuInfo	Sku: IotHub SKU info
`tags` map[string]string	Tags: The resource tags.

status
IotHub_STATUS

IotHubLocationDescription_Role_STATUS (`string` alias)

(Appears on:IotHubLocationDescription_STATUS)

Value	Description
"primary"
"secondary"

IotHubLocationDescription_STATUS

(Appears on:IotHubProperties_STATUS)

Public representation of one of the locations where a resource is provisioned.

Field	Description
`location` string	Location: The name of the Azure region
`role` IotHubLocationDescription_Role_STATUS	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.

IotHubOperatorSecrets

(Appears on:IotHubOperatorSpec)

Field	Description
`devicePrimaryKey` genruntime.SecretDestination	DevicePrimaryKey: indicates where the DevicePrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`deviceSecondaryKey` genruntime.SecretDestination	DeviceSecondaryKey: indicates where the DeviceSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`iotHubOwnerPrimaryKey` genruntime.SecretDestination	IotHubOwnerPrimaryKey: indicates where the IotHubOwnerPrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`iotHubOwnerSecondaryKey` genruntime.SecretDestination	IotHubOwnerSecondaryKey: indicates where the IotHubOwnerSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`registryReadPrimaryKey` genruntime.SecretDestination	RegistryReadPrimaryKey: indicates where the RegistryReadPrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`registryReadSecondaryKey` genruntime.SecretDestination	RegistryReadSecondaryKey: indicates where the RegistryReadSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`registryReadWritePrimaryKey` genruntime.SecretDestination	RegistryReadWritePrimaryKey: indicates where the RegistryReadWritePrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`registryReadWriteSecondaryKey` genruntime.SecretDestination	RegistryReadWriteSecondaryKey: indicates where the RegistryReadWriteSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`servicePrimaryKey` genruntime.SecretDestination	ServicePrimaryKey: indicates where the ServicePrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`serviceSecondaryKey` genruntime.SecretDestination	ServiceSecondaryKey: indicates where the ServiceSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

IotHubOperatorSpec

(Appears on:IotHub_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).
`secrets` IotHubOperatorSecrets	Secrets: configures where to place Azure generated secrets.

IotHubProperties

(Appears on:IotHub_Spec)

The properties of an IoT hub.

Field	Description
`allowedFqdnList` []string	AllowedFqdnList: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
`authorizationPolicies` []SharedAccessSignatureAuthorizationRule	AuthorizationPolicies: The shared access policies you can use to secure a connection to the IoT hub.
`cloudToDevice` CloudToDeviceProperties	CloudToDevice: The IoT hub cloud-to-device messaging properties.
`comments` string	Comments: IoT hub comments.
`disableDeviceSAS` bool	DisableDeviceSAS: If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
`disableLocalAuth` bool	DisableLocalAuth: If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
`disableModuleSAS` bool	DisableModuleSAS: If true, all module scoped SAS keys cannot be used for authentication.
`enableDataResidency` bool	EnableDataResidency: This property when set to true, will enable data residency, thus, disabling disaster recovery.
`enableFileUploadNotifications` bool	EnableFileUploadNotifications: If True, file upload notifications are enabled.
`eventHubEndpoints` map[string]./api/devices/v1api20210702.EventHubProperties	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.
`features` IotHubProperties_Features	Features: The capabilities and features enabled for the IoT hub.
`ipFilterRules` []IpFilterRule	IpFilterRules: The IP filter rules.
`messagingEndpoints` map[string]./api/devices/v1api20210702.MessagingEndpointProperties	MessagingEndpoints: The messaging endpoint properties for the file upload notification queue.
`minTlsVersion` string	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.
`networkRuleSets` NetworkRuleSetProperties	NetworkRuleSets: Network Rule Set Properties of IotHub
`publicNetworkAccess` IotHubProperties_PublicNetworkAccess	PublicNetworkAccess: Whether requests from Public Network are allowed
`restrictOutboundNetworkAccess` bool	RestrictOutboundNetworkAccess: If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
`routing` RoutingProperties	Routing: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
`storageEndpoints` map[string]./api/devices/v1api20210702.StorageEndpointProperties	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.

IotHubProperties_Features (`string` alias)

(Appears on:IotHubProperties)

Value	Description
"DeviceManagement"
"None"

IotHubProperties_Features_STATUS (`string` alias)

(Appears on:IotHubProperties_STATUS)

Value	Description
"DeviceManagement"
"None"

IotHubProperties_PublicNetworkAccess (`string` alias)

(Appears on:IotHubProperties)

Value	Description
"Disabled"
"Enabled"

IotHubProperties_PublicNetworkAccess_STATUS (`string` alias)

(Appears on:IotHubProperties_STATUS)

Value	Description
"Disabled"
"Enabled"

IotHubProperties_STATUS

(Appears on:IotHub_STATUS)

The properties of an IoT hub.

Field	Description
`allowedFqdnList` []string	AllowedFqdnList: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
`authorizationPolicies` []SharedAccessSignatureAuthorizationRule_STATUS	AuthorizationPolicies: The shared access policies you can use to secure a connection to the IoT hub.
`cloudToDevice` CloudToDeviceProperties_STATUS	CloudToDevice: The IoT hub cloud-to-device messaging properties.
`comments` string	Comments: IoT hub comments.
`disableDeviceSAS` bool	DisableDeviceSAS: If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
`disableLocalAuth` bool	DisableLocalAuth: If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
`disableModuleSAS` bool	DisableModuleSAS: If true, all module scoped SAS keys cannot be used for authentication.
`enableDataResidency` bool	EnableDataResidency: This property when set to true, will enable data residency, thus, disabling disaster recovery.
`enableFileUploadNotifications` bool	EnableFileUploadNotifications: If True, file upload notifications are enabled.
`eventHubEndpoints` map[string]./api/devices/v1api20210702.EventHubProperties_STATUS	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.
`features` IotHubProperties_Features_STATUS	Features: The capabilities and features enabled for the IoT hub.
`hostName` string	HostName: The name of the host.
`ipFilterRules` []IpFilterRule_STATUS	IpFilterRules: The IP filter rules.
`locations` []IotHubLocationDescription_STATUS	Locations: Primary and secondary location for iot hub
`messagingEndpoints` map[string]./api/devices/v1api20210702.MessagingEndpointProperties_STATUS	MessagingEndpoints: The messaging endpoint properties for the file upload notification queue.
`minTlsVersion` string	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.
`networkRuleSets` NetworkRuleSetProperties_STATUS	NetworkRuleSets: Network Rule Set Properties of IotHub
`privateEndpointConnections` []PrivateEndpointConnection_STATUS	PrivateEndpointConnections: Private endpoint connections created on this IotHub
`provisioningState` string	ProvisioningState: The provisioning state.
`publicNetworkAccess` IotHubProperties_PublicNetworkAccess_STATUS	PublicNetworkAccess: Whether requests from Public Network are allowed
`restrictOutboundNetworkAccess` bool	RestrictOutboundNetworkAccess: If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
`routing` RoutingProperties_STATUS	Routing: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
`state` string	State: The hub state.
`storageEndpoints` map[string]./api/devices/v1api20210702.StorageEndpointProperties_STATUS	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.

IotHubSkuInfo

(Appears on:IotHub_Spec)

Information about the SKU of the IoT hub.

Field	Description
`capacity` int	Capacity: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name` IotHubSkuInfo_Name	Name: The name of the SKU.

IotHubSkuInfo_Name (`string` alias)

(Appears on:IotHubSkuInfo)

Value	Description
"B1"
"B2"
"B3"
"F1"
"S1"
"S2"
"S3"

IotHubSkuInfo_Name_STATUS (`string` alias)

(Appears on:IotHubSkuInfo_STATUS)

Value	Description
"B1"
"B2"
"B3"
"F1"
"S1"
"S2"
"S3"

IotHubSkuInfo_STATUS

(Appears on:IotHub_STATUS)

Information about the SKU of the IoT hub.

Field	Description
`capacity` int	Capacity: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
`name` IotHubSkuInfo_Name_STATUS	Name: The name of the SKU.
`tier` IotHubSkuInfo_Tier_STATUS	Tier: The billing tier for the IoT hub.

IotHubSkuInfo_Tier_STATUS (`string` alias)

(Appears on:IotHubSkuInfo_STATUS)

Value	Description
"Basic"
"Free"
"Standard"

IotHub_STATUS

(Appears on:IotHub)

Field	Description
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`etag` string	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.
`id` string	Id: The resource identifier.
`identity` ArmIdentity_STATUS	Identity: The managed identities for the IotHub.
`location` string	Location: The resource location.
`name` string	Name: The resource name.
`properties` IotHubProperties_STATUS	Properties: IotHub properties
`sku` IotHubSkuInfo_STATUS	Sku: IotHub SKU info
`systemData` SystemData_STATUS	SystemData: The system meta data relating to this resource.
`tags` map[string]string	Tags: The resource tags.
`type` string	Type: The resource type.

IotHub_Spec

(Appears on:IotHub)

Field	Description
`azureName` string	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.
`identity` ArmIdentity	Identity: The managed identities for the IotHub.
`location` string	Location: The resource location.
`operatorSpec` IotHubOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`properties` IotHubProperties	Properties: IotHub properties
`sku` IotHubSkuInfo	Sku: IotHub SKU info
`tags` map[string]string	Tags: The resource tags.

IpFilterRule

(Appears on:IotHubProperties)

The IP filter rules for the IoT hub.

Field	Description
`action` IpFilterRule_Action	Action: The desired action for requests captured by this rule.
`filterName` string	FilterName: The name of the IP filter rule.
`ipMask` string	IpMask: A string that contains the IP address range in CIDR notation for the rule.

IpFilterRule_Action (`string` alias)

(Appears on:IpFilterRule)

Value	Description
"Accept"
"Reject"

IpFilterRule_Action_STATUS (`string` alias)

(Appears on:IpFilterRule_STATUS)

Value	Description
"Accept"
"Reject"

IpFilterRule_STATUS

(Appears on:IotHubProperties_STATUS)

The IP filter rules for the IoT hub.

Field	Description
`action` IpFilterRule_Action_STATUS	Action: The desired action for requests captured by this rule.
`filterName` string	FilterName: The name of the IP filter rule.
`ipMask` string	IpMask: A string that contains the IP address range in CIDR notation for the rule.

ManagedIdentity

(Appears on:RoutingEventHubProperties, RoutingServiceBusQueueEndpointProperties, RoutingServiceBusTopicEndpointProperties, RoutingStorageContainerProperties, StorageEndpointProperties)

The properties of the Managed identity.

Field	Description
`userAssignedIdentity` string	UserAssignedIdentity: The user assigned identity.

ManagedIdentity_STATUS

(Appears on:RoutingEventHubProperties_STATUS, RoutingServiceBusQueueEndpointProperties_STATUS, RoutingServiceBusTopicEndpointProperties_STATUS, RoutingStorageContainerProperties_STATUS, StorageEndpointProperties_STATUS)

The properties of the Managed identity.

Field	Description
`userAssignedIdentity` string	UserAssignedIdentity: The user assigned identity.

MessagingEndpointProperties

(Appears on:IotHubProperties)

The properties of the messaging endpoints used by this IoT hub.

Field	Description
`lockDurationAsIso8601` string	LockDurationAsIso8601: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
`maxDeliveryCount` int	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.
`ttlAsIso8601` string	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.

MessagingEndpointProperties_STATUS

(Appears on:IotHubProperties_STATUS)

The properties of the messaging endpoints used by this IoT hub.

Field	Description
`lockDurationAsIso8601` string	LockDurationAsIso8601: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
`maxDeliveryCount` int	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.
`ttlAsIso8601` string	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.

NetworkRuleSetIpRule

(Appears on:NetworkRuleSetProperties)

IP Rule to be applied as part of Network Rule Set

Field	Description
`action` NetworkRuleSetIpRule_Action	Action: IP Filter Action
`filterName` string	FilterName: Name of the IP filter rule.
`ipMask` string	IpMask: A string that contains the IP address range in CIDR notation for the rule.

NetworkRuleSetIpRule_Action (`string` alias)

(Appears on:NetworkRuleSetIpRule)

Value	Description
"Allow"

NetworkRuleSetIpRule_Action_STATUS (`string` alias)

(Appears on:NetworkRuleSetIpRule_STATUS)

Value	Description
"Allow"

NetworkRuleSetIpRule_STATUS

(Appears on:NetworkRuleSetProperties_STATUS)

IP Rule to be applied as part of Network Rule Set

Field	Description
`action` NetworkRuleSetIpRule_Action_STATUS	Action: IP Filter Action
`filterName` string	FilterName: Name of the IP filter rule.
`ipMask` string	IpMask: A string that contains the IP address range in CIDR notation for the rule.

NetworkRuleSetProperties

(Appears on:IotHubProperties)

Network Rule Set Properties of IotHub

Field	Description
`applyToBuiltInEventHubEndpoint` bool	ApplyToBuiltInEventHubEndpoint: If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
`defaultAction` NetworkRuleSetProperties_DefaultAction	DefaultAction: Default Action for Network Rule Set
`ipRules` []NetworkRuleSetIpRule	IpRules: List of IP Rules

NetworkRuleSetProperties_DefaultAction (`string` alias)

(Appears on:NetworkRuleSetProperties)

Value	Description
"Allow"
"Deny"

NetworkRuleSetProperties_DefaultAction_STATUS (`string` alias)

(Appears on:NetworkRuleSetProperties_STATUS)

Value	Description
"Allow"
"Deny"

NetworkRuleSetProperties_STATUS

(Appears on:IotHubProperties_STATUS)

Network Rule Set Properties of IotHub

Field	Description
`applyToBuiltInEventHubEndpoint` bool	ApplyToBuiltInEventHubEndpoint: If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
`defaultAction` NetworkRuleSetProperties_DefaultAction_STATUS	DefaultAction: Default Action for Network Rule Set
`ipRules` []NetworkRuleSetIpRule_STATUS	IpRules: List of IP Rules

PrivateEndpointConnection_STATUS

(Appears on:IotHubProperties_STATUS)

The private endpoint connection of an IotHub

Field	Description
`id` string	Id: The resource identifier.

RouteProperties

(Appears on:RoutingProperties)

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Field	Description
`condition` string	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
`endpointNames` []string	EndpointNames: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`isEnabled` bool	IsEnabled: Used to specify whether a route is enabled.
`name` string	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.
`source` RouteProperties_Source	Source: The source that the routing rule is to be applied to, such as DeviceMessages.

RouteProperties_STATUS

(Appears on:RoutingProperties_STATUS)

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Field	Description
`condition` string	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
`endpointNames` []string	EndpointNames: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
`isEnabled` bool	IsEnabled: Used to specify whether a route is enabled.
`name` string	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.
`source` RouteProperties_Source_STATUS	Source: The source that the routing rule is to be applied to, such as DeviceMessages.

RouteProperties_Source (`string` alias)

(Appears on:RouteProperties)

Value	Description
"DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"Invalid"
"TwinChangeEvents"

RouteProperties_Source_STATUS (`string` alias)

(Appears on:RouteProperties_STATUS)

Value	Description
"DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"Invalid"
"TwinChangeEvents"

RoutingEndpoints

(Appears on:RoutingProperties)

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.

Field	Description
`eventHubs` []RoutingEventHubProperties	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.
`serviceBusQueues` []RoutingServiceBusQueueEndpointProperties	ServiceBusQueues: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
`serviceBusTopics` []RoutingServiceBusTopicEndpointProperties	ServiceBusTopics: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
`storageContainers` []RoutingStorageContainerProperties	StorageContainers: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.

RoutingEndpoints_STATUS

(Appears on:RoutingProperties_STATUS)

Field	Description
`eventHubs` []RoutingEventHubProperties_STATUS	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.
`serviceBusQueues` []RoutingServiceBusQueueEndpointProperties_STATUS	ServiceBusQueues: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
`serviceBusTopics` []RoutingServiceBusTopicEndpointProperties_STATUS	ServiceBusTopics: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
`storageContainers` []RoutingStorageContainerProperties_STATUS	StorageContainers: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.

RoutingEventHubProperties

(Appears on:RoutingEndpoints)

The properties related to an event hub endpoint.

Field	Description
`authenticationType` RoutingEventHubProperties_AuthenticationType	AuthenticationType: Method used to authenticate against the event hub endpoint
`connectionString` genruntime.SecretReference	ConnectionString: The connection string of the event hub endpoint.
`endpointUri` string	EndpointUri: The url of the event hub endpoint. It must include the protocol sb://
`entityPath` string	EntityPath: Event hub name on the event hub namespace
`identity` ManagedIdentity	Identity: Managed identity properties of routing event hub endpoint.
`name` string	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.
`reference` genruntime.ResourceReference	Reference: Id of the event hub endpoint
`resourceGroup` string	ResourceGroup: The name of the resource group of the event hub endpoint.
`subscriptionId` string	SubscriptionId: The subscription identifier of the event hub endpoint.

RoutingEventHubProperties_AuthenticationType (`string` alias)

(Appears on:RoutingEventHubProperties)

Value	Description
"identityBased"
"keyBased"

RoutingEventHubProperties_AuthenticationType_STATUS (`string` alias)

(Appears on:RoutingEventHubProperties_STATUS)

Value	Description
"identityBased"
"keyBased"

RoutingEventHubProperties_STATUS

(Appears on:RoutingEndpoints_STATUS)

The properties related to an event hub endpoint.

Field	Description
`authenticationType` RoutingEventHubProperties_AuthenticationType_STATUS	AuthenticationType: Method used to authenticate against the event hub endpoint
`endpointUri` string	EndpointUri: The url of the event hub endpoint. It must include the protocol sb://
`entityPath` string	EntityPath: Event hub name on the event hub namespace
`id` string	Id: Id of the event hub endpoint
`identity` ManagedIdentity_STATUS	Identity: Managed identity properties of routing event hub endpoint.
`name` string	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.
`resourceGroup` string	ResourceGroup: The name of the resource group of the event hub endpoint.
`subscriptionId` string	SubscriptionId: The subscription identifier of the event hub endpoint.

RoutingProperties

(Appears on:IotHubProperties)

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

Field	Description
`endpoints` RoutingEndpoints	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.
`enrichments` []EnrichmentProperties	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
`fallbackRoute` FallbackRouteProperties	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.
`routes` []RouteProperties	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.

RoutingProperties_STATUS

(Appears on:IotHubProperties_STATUS)

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

Field	Description
`endpoints` RoutingEndpoints_STATUS	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.
`enrichments` []EnrichmentProperties_STATUS	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
`fallbackRoute` FallbackRouteProperties_STATUS	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.
`routes` []RouteProperties_STATUS	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.

RoutingServiceBusQueueEndpointProperties

(Appears on:RoutingEndpoints)

The properties related to service bus queue endpoint types.

Field	Description
`authenticationType` RoutingServiceBusQueueEndpointProperties_AuthenticationType	AuthenticationType: Method used to authenticate against the service bus queue endpoint
`connectionString` genruntime.SecretReference	ConnectionString: The connection string of the service bus queue endpoint.
`endpointUri` string	EndpointUri: The url of the service bus queue endpoint. It must include the protocol sb://
`entityPath` string	EntityPath: Queue name on the service bus namespace
`identity` ManagedIdentity	Identity: Managed identity properties of routing service bus queue endpoint.
`name` string	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.
`reference` genruntime.ResourceReference	Reference: Id of the service bus queue endpoint
`resourceGroup` string	ResourceGroup: The name of the resource group of the service bus queue endpoint.
`subscriptionId` string	SubscriptionId: The subscription identifier of the service bus queue endpoint.

RoutingServiceBusQueueEndpointProperties_AuthenticationType (`string` alias)

(Appears on:RoutingServiceBusQueueEndpointProperties)

Value	Description
"identityBased"
"keyBased"

RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS (`string` alias)

(Appears on:RoutingServiceBusQueueEndpointProperties_STATUS)

Value	Description
"identityBased"
"keyBased"

RoutingServiceBusQueueEndpointProperties_STATUS

(Appears on:RoutingEndpoints_STATUS)

The properties related to service bus queue endpoint types.

Field	Description
`authenticationType` RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS	AuthenticationType: Method used to authenticate against the service bus queue endpoint
`endpointUri` string	EndpointUri: The url of the service bus queue endpoint. It must include the protocol sb://
`entityPath` string	EntityPath: Queue name on the service bus namespace
`id` string	Id: Id of the service bus queue endpoint
`identity` ManagedIdentity_STATUS	Identity: Managed identity properties of routing service bus queue endpoint.
`name` string	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.
`resourceGroup` string	ResourceGroup: The name of the resource group of the service bus queue endpoint.
`subscriptionId` string	SubscriptionId: The subscription identifier of the service bus queue endpoint.

RoutingServiceBusTopicEndpointProperties

(Appears on:RoutingEndpoints)

The properties related to service bus topic endpoint types.

Field	Description
`authenticationType` RoutingServiceBusTopicEndpointProperties_AuthenticationType	AuthenticationType: Method used to authenticate against the service bus topic endpoint
`connectionString` genruntime.SecretReference	ConnectionString: The connection string of the service bus topic endpoint.
`endpointUri` string	EndpointUri: The url of the service bus topic endpoint. It must include the protocol sb://
`entityPath` string	EntityPath: Queue name on the service bus topic
`identity` ManagedIdentity	Identity: Managed identity properties of routing service bus topic endpoint.
`name` string	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.
`reference` genruntime.ResourceReference	Reference: Id of the service bus topic endpoint
`resourceGroup` string	ResourceGroup: The name of the resource group of the service bus topic endpoint.
`subscriptionId` string	SubscriptionId: The subscription identifier of the service bus topic endpoint.

RoutingServiceBusTopicEndpointProperties_AuthenticationType (`string` alias)

(Appears on:RoutingServiceBusTopicEndpointProperties)

Value	Description
"identityBased"
"keyBased"

RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS (`string` alias)

(Appears on:RoutingServiceBusTopicEndpointProperties_STATUS)

Value	Description
"identityBased"
"keyBased"

RoutingServiceBusTopicEndpointProperties_STATUS

(Appears on:RoutingEndpoints_STATUS)

The properties related to service bus topic endpoint types.

Field	Description
`authenticationType` RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS	AuthenticationType: Method used to authenticate against the service bus topic endpoint
`endpointUri` string	EndpointUri: The url of the service bus topic endpoint. It must include the protocol sb://
`entityPath` string	EntityPath: Queue name on the service bus topic
`id` string	Id: Id of the service bus topic endpoint
`identity` ManagedIdentity_STATUS	Identity: Managed identity properties of routing service bus topic endpoint.
`name` string	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.
`resourceGroup` string	ResourceGroup: The name of the resource group of the service bus topic endpoint.
`subscriptionId` string	SubscriptionId: The subscription identifier of the service bus topic endpoint.

RoutingStorageContainerProperties

(Appears on:RoutingEndpoints)

The properties related to a storage container endpoint.

Field	Description
`authenticationType` RoutingStorageContainerProperties_AuthenticationType	AuthenticationType: Method used to authenticate against the storage endpoint
`batchFrequencyInSeconds` int	BatchFrequencyInSeconds: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
`connectionString` genruntime.SecretReference	ConnectionString: The connection string of the storage account.
`containerName` string	ContainerName: The name of storage container in the storage account.
`encoding` RoutingStorageContainerProperties_Encoding	Encoding: Encoding that is used to serialize messages to blobs. Supported values are ‘avro’, ‘avrodeflate’, and ‘JSON’. Default value is ‘avro’.
`endpointUri` string	EndpointUri: The url of the storage endpoint. It must include the protocol https://
`fileNameFormat` string	FileNameFormat: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
`identity` ManagedIdentity	Identity: Managed identity properties of routing storage endpoint.
`maxChunkSizeInBytes` int	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).
`name` string	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.
`reference` genruntime.ResourceReference	Reference: Id of the storage container endpoint
`resourceGroup` string	ResourceGroup: The name of the resource group of the storage account.
`subscriptionId` string	SubscriptionId: The subscription identifier of the storage account.

RoutingStorageContainerProperties_AuthenticationType (`string` alias)

(Appears on:RoutingStorageContainerProperties)

Value	Description
"identityBased"
"keyBased"

RoutingStorageContainerProperties_AuthenticationType_STATUS (`string` alias)

(Appears on:RoutingStorageContainerProperties_STATUS)

Value	Description
"identityBased"
"keyBased"

RoutingStorageContainerProperties_Encoding (`string` alias)

(Appears on:RoutingStorageContainerProperties)

Value	Description
"Avro"
"AvroDeflate"
"JSON"

RoutingStorageContainerProperties_Encoding_STATUS (`string` alias)

(Appears on:RoutingStorageContainerProperties_STATUS)

Value	Description
"Avro"
"AvroDeflate"
"JSON"

RoutingStorageContainerProperties_STATUS

(Appears on:RoutingEndpoints_STATUS)

The properties related to a storage container endpoint.

Field	Description
`authenticationType` RoutingStorageContainerProperties_AuthenticationType_STATUS	AuthenticationType: Method used to authenticate against the storage endpoint
`batchFrequencyInSeconds` int	BatchFrequencyInSeconds: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
`containerName` string	ContainerName: The name of storage container in the storage account.
`encoding` RoutingStorageContainerProperties_Encoding_STATUS	Encoding: Encoding that is used to serialize messages to blobs. Supported values are ‘avro’, ‘avrodeflate’, and ‘JSON’. Default value is ‘avro’.
`endpointUri` string	EndpointUri: The url of the storage endpoint. It must include the protocol https://
`fileNameFormat` string	FileNameFormat: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
`id` string	Id: Id of the storage container endpoint
`identity` ManagedIdentity_STATUS	Identity: Managed identity properties of routing storage endpoint.
`maxChunkSizeInBytes` int	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).
`name` string	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.
`resourceGroup` string	ResourceGroup: The name of the resource group of the storage account.
`subscriptionId` string	SubscriptionId: The subscription identifier of the storage account.

SharedAccessSignatureAuthorizationRule

(Appears on:IotHubProperties)

The properties of an IoT hub shared access policy.

Field	Description
`keyName` string	KeyName: The name of the shared access policy.
`rights` SharedAccessSignatureAuthorizationRule_Rights	Rights: The permissions assigned to the shared access policy.

SharedAccessSignatureAuthorizationRule_Rights (`string` alias)

(Appears on: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 (`string` alias)

(Appears on: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"

SharedAccessSignatureAuthorizationRule_STATUS

(Appears on:IotHubProperties_STATUS)

The properties of an IoT hub shared access policy.

Field	Description
`keyName` string	KeyName: The name of the shared access policy.
`rights` SharedAccessSignatureAuthorizationRule_Rights_STATUS	Rights: The permissions assigned to the shared access policy.

StorageEndpointProperties

(Appears on:IotHubProperties)

The properties of the Azure Storage endpoint for file upload.

Field	Description
`authenticationType` StorageEndpointProperties_AuthenticationType	AuthenticationType: Specifies authentication type being used for connecting to the storage account.
`connectionString` genruntime.SecretReference	ConnectionString: The connection string for the Azure Storage account to which files are uploaded.
`containerName` string	ContainerName: The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.
`identity` ManagedIdentity	Identity: Managed identity properties of storage endpoint for file upload.
`sasTtlAsIso8601` string	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.

StorageEndpointProperties_AuthenticationType (`string` alias)

(Appears on:StorageEndpointProperties)

Value	Description
"identityBased"
"keyBased"

StorageEndpointProperties_AuthenticationType_STATUS (`string` alias)

(Appears on:StorageEndpointProperties_STATUS)

Value	Description
"identityBased"
"keyBased"

StorageEndpointProperties_STATUS

(Appears on:IotHubProperties_STATUS)

The properties of the Azure Storage endpoint for file upload.

Field	Description
`authenticationType` StorageEndpointProperties_AuthenticationType_STATUS	AuthenticationType: Specifies authentication type being used for connecting to the storage account.
`containerName` string	ContainerName: The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.
`identity` ManagedIdentity_STATUS	Identity: Managed identity properties of storage endpoint for file upload.
`sasTtlAsIso8601` string	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.

SystemData_CreatedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_STATUS

(Appears on:IotHub_STATUS)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

UserAssignedIdentityDetails

(Appears on:ArmIdentity)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

devices.azure.com/v1api20210702