Documentation
¶
Overview ¶
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Index ¶
- Constants
- type ArmIdentity
- type ArmIdentity_STATUS
- type ArmIdentity_Type
- type ArmIdentity_Type_STATUS
- type ArmUserIdentity_STATUS
- type CloudToDeviceProperties
- type CloudToDeviceProperties_STATUS
- type EnrichmentProperties
- type EnrichmentProperties_STATUS
- type EventHubProperties
- type EventHubProperties_STATUS
- type FallbackRouteProperties
- type FallbackRouteProperties_STATUS
- type FallbackRouteProperties_Source
- type FallbackRouteProperties_Source_STATUS
- type FeedbackProperties
- type FeedbackProperties_STATUS
- type IotHubLocationDescription_Role_STATUS
- type IotHubLocationDescription_STATUS
- type IotHubProperties
- type IotHubProperties_Features
- type IotHubProperties_Features_STATUS
- type IotHubProperties_PublicNetworkAccess
- type IotHubProperties_PublicNetworkAccess_STATUS
- type IotHubProperties_STATUS
- type IotHubSkuInfo
- type IotHubSkuInfo_Name
- type IotHubSkuInfo_Name_STATUS
- type IotHubSkuInfo_STATUS
- type IotHubSkuInfo_Tier_STATUS
- type IotHub_STATUS
- type IotHub_Spec
- type IpFilterRule
- type IpFilterRule_Action
- type IpFilterRule_Action_STATUS
- type IpFilterRule_STATUS
- type ManagedIdentity
- type ManagedIdentity_STATUS
- type MessagingEndpointProperties
- type MessagingEndpointProperties_STATUS
- type NetworkRuleSetIpRule
- type NetworkRuleSetIpRule_Action
- type NetworkRuleSetIpRule_Action_STATUS
- type NetworkRuleSetIpRule_STATUS
- type NetworkRuleSetProperties
- type NetworkRuleSetProperties_DefaultAction
- type NetworkRuleSetProperties_DefaultAction_STATUS
- type NetworkRuleSetProperties_STATUS
- type PrivateEndpointConnection_STATUS
- type RouteProperties
- type RouteProperties_STATUS
- type RouteProperties_Source
- type RouteProperties_Source_STATUS
- type RoutingEndpoints
- type RoutingEndpoints_STATUS
- type RoutingEventHubProperties
- type RoutingEventHubProperties_AuthenticationType
- type RoutingEventHubProperties_AuthenticationType_STATUS
- type RoutingEventHubProperties_STATUS
- type RoutingProperties
- type RoutingProperties_STATUS
- type RoutingServiceBusQueueEndpointProperties
- type RoutingServiceBusQueueEndpointProperties_AuthenticationType
- type RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS
- type RoutingServiceBusQueueEndpointProperties_STATUS
- type RoutingServiceBusTopicEndpointProperties
- type RoutingServiceBusTopicEndpointProperties_AuthenticationType
- type RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS
- type RoutingServiceBusTopicEndpointProperties_STATUS
- type RoutingStorageContainerProperties
- type RoutingStorageContainerProperties_AuthenticationType
- type RoutingStorageContainerProperties_AuthenticationType_STATUS
- type RoutingStorageContainerProperties_Encoding
- type RoutingStorageContainerProperties_Encoding_STATUS
- type RoutingStorageContainerProperties_STATUS
- type SharedAccessSignatureAuthorizationRule
- type SharedAccessSignatureAuthorizationRule_Rights
- type SharedAccessSignatureAuthorizationRule_Rights_STATUS
- type SharedAccessSignatureAuthorizationRule_STATUS
- type StorageEndpointProperties
- type StorageEndpointProperties_AuthenticationType
- type StorageEndpointProperties_AuthenticationType_STATUS
- type StorageEndpointProperties_STATUS
- type SystemData_CreatedByType_STATUS
- type SystemData_LastModifiedByType_STATUS
- type SystemData_STATUS
- type UserAssignedIdentityDetails
Constants ¶
const ( ArmIdentity_Type_None = ArmIdentity_Type("None") ArmIdentity_Type_SystemAssigned = ArmIdentity_Type("SystemAssigned") ArmIdentity_Type_SystemAssignedUserAssigned = ArmIdentity_Type("SystemAssigned, UserAssigned") ArmIdentity_Type_UserAssigned = ArmIdentity_Type("UserAssigned") )
const ( IotHubProperties_Features_DeviceManagement = IotHubProperties_Features("DeviceManagement") IotHubProperties_Features_None = IotHubProperties_Features("None") )
const ( IotHubProperties_PublicNetworkAccess_Disabled = IotHubProperties_PublicNetworkAccess("Disabled") IotHubProperties_PublicNetworkAccess_Enabled = IotHubProperties_PublicNetworkAccess("Enabled") )
const ( IotHubSkuInfo_Name_B1 = IotHubSkuInfo_Name("B1") IotHubSkuInfo_Name_B2 = IotHubSkuInfo_Name("B2") IotHubSkuInfo_Name_B3 = IotHubSkuInfo_Name("B3") IotHubSkuInfo_Name_F1 = IotHubSkuInfo_Name("F1") IotHubSkuInfo_Name_S1 = IotHubSkuInfo_Name("S1") IotHubSkuInfo_Name_S2 = IotHubSkuInfo_Name("S2") IotHubSkuInfo_Name_S3 = IotHubSkuInfo_Name("S3") )
const ( IpFilterRule_Action_Accept = IpFilterRule_Action("Accept") IpFilterRule_Action_Reject = IpFilterRule_Action("Reject") )
const ( NetworkRuleSetProperties_DefaultAction_Allow = NetworkRuleSetProperties_DefaultAction("Allow") NetworkRuleSetProperties_DefaultAction_Deny = NetworkRuleSetProperties_DefaultAction("Deny") )
const ( )
const ( StorageEndpointProperties_AuthenticationType_IdentityBased = StorageEndpointProperties_AuthenticationType("identityBased") StorageEndpointProperties_AuthenticationType_KeyBased = StorageEndpointProperties_AuthenticationType("keyBased") )
const ( RouteProperties_Source_DeviceConnectionStateEvents = RouteProperties_Source("DeviceConnectionStateEvents") RouteProperties_Source_DeviceJobLifecycleEvents = RouteProperties_Source("DeviceJobLifecycleEvents") RouteProperties_Source_DeviceLifecycleEvents = RouteProperties_Source("DeviceLifecycleEvents") RouteProperties_Source_DeviceMessages = RouteProperties_Source("DeviceMessages") RouteProperties_Source_Invalid = RouteProperties_Source("Invalid") RouteProperties_Source_TwinChangeEvents = RouteProperties_Source("TwinChangeEvents") )
const ( RoutingEventHubProperties_AuthenticationType_IdentityBased = RoutingEventHubProperties_AuthenticationType("identityBased") RoutingEventHubProperties_AuthenticationType_KeyBased = RoutingEventHubProperties_AuthenticationType("keyBased") )
const ( RoutingServiceBusQueueEndpointProperties_AuthenticationType_IdentityBased = RoutingServiceBusQueueEndpointProperties_AuthenticationType("identityBased") RoutingServiceBusQueueEndpointProperties_AuthenticationType_KeyBased = RoutingServiceBusQueueEndpointProperties_AuthenticationType("keyBased") )
const ( RoutingServiceBusTopicEndpointProperties_AuthenticationType_IdentityBased = RoutingServiceBusTopicEndpointProperties_AuthenticationType("identityBased") RoutingServiceBusTopicEndpointProperties_AuthenticationType_KeyBased = RoutingServiceBusTopicEndpointProperties_AuthenticationType("keyBased") )
const ( RoutingStorageContainerProperties_AuthenticationType_IdentityBased = RoutingStorageContainerProperties_AuthenticationType("identityBased") RoutingStorageContainerProperties_AuthenticationType_KeyBased = RoutingStorageContainerProperties_AuthenticationType("keyBased") )
const ( RoutingStorageContainerProperties_Encoding_Avro = RoutingStorageContainerProperties_Encoding("Avro") RoutingStorageContainerProperties_Encoding_AvroDeflate = RoutingStorageContainerProperties_Encoding("AvroDeflate") RoutingStorageContainerProperties_Encoding_JSON = RoutingStorageContainerProperties_Encoding("JSON") )
const ( ArmIdentity_Type_STATUS_None = ArmIdentity_Type_STATUS("None") ArmIdentity_Type_STATUS_SystemAssigned = ArmIdentity_Type_STATUS("SystemAssigned") ArmIdentity_Type_STATUS_SystemAssignedUserAssigned = ArmIdentity_Type_STATUS("SystemAssigned, UserAssigned") ArmIdentity_Type_STATUS_UserAssigned = ArmIdentity_Type_STATUS("UserAssigned") )
const ( IotHubProperties_Features_STATUS_DeviceManagement = IotHubProperties_Features_STATUS("DeviceManagement") IotHubProperties_Features_STATUS_None = IotHubProperties_Features_STATUS("None") )
const ( IotHubProperties_PublicNetworkAccess_STATUS_Disabled = IotHubProperties_PublicNetworkAccess_STATUS("Disabled") IotHubProperties_PublicNetworkAccess_STATUS_Enabled = IotHubProperties_PublicNetworkAccess_STATUS("Enabled") )
const ( IotHubSkuInfo_Name_STATUS_B1 = IotHubSkuInfo_Name_STATUS("B1") IotHubSkuInfo_Name_STATUS_B2 = IotHubSkuInfo_Name_STATUS("B2") IotHubSkuInfo_Name_STATUS_B3 = IotHubSkuInfo_Name_STATUS("B3") IotHubSkuInfo_Name_STATUS_F1 = IotHubSkuInfo_Name_STATUS("F1") IotHubSkuInfo_Name_STATUS_S1 = IotHubSkuInfo_Name_STATUS("S1") IotHubSkuInfo_Name_STATUS_S2 = IotHubSkuInfo_Name_STATUS("S2") IotHubSkuInfo_Name_STATUS_S3 = IotHubSkuInfo_Name_STATUS("S3") )
const ( IotHubSkuInfo_Tier_STATUS_Basic = IotHubSkuInfo_Tier_STATUS("Basic") IotHubSkuInfo_Tier_STATUS_Free = IotHubSkuInfo_Tier_STATUS("Free") IotHubSkuInfo_Tier_STATUS_Standard = IotHubSkuInfo_Tier_STATUS("Standard") )
const ( SystemData_CreatedByType_STATUS_Application = SystemData_CreatedByType_STATUS("Application") SystemData_CreatedByType_STATUS_Key = SystemData_CreatedByType_STATUS("Key") SystemData_CreatedByType_STATUS_ManagedIdentity = SystemData_CreatedByType_STATUS("ManagedIdentity") SystemData_CreatedByType_STATUS_User = SystemData_CreatedByType_STATUS("User") )
const ( SystemData_LastModifiedByType_STATUS_Application = SystemData_LastModifiedByType_STATUS("Application") SystemData_LastModifiedByType_STATUS_Key = SystemData_LastModifiedByType_STATUS("Key") SystemData_LastModifiedByType_STATUS_ManagedIdentity = SystemData_LastModifiedByType_STATUS("ManagedIdentity") SystemData_LastModifiedByType_STATUS_User = SystemData_LastModifiedByType_STATUS("User") )
const ( IotHubLocationDescription_Role_STATUS_Primary = IotHubLocationDescription_Role_STATUS("primary") IotHubLocationDescription_Role_STATUS_Secondary = IotHubLocationDescription_Role_STATUS("secondary") )
const ( IpFilterRule_Action_STATUS_Accept = IpFilterRule_Action_STATUS("Accept") IpFilterRule_Action_STATUS_Reject = IpFilterRule_Action_STATUS("Reject") )
const ( NetworkRuleSetProperties_DefaultAction_STATUS_Allow = NetworkRuleSetProperties_DefaultAction_STATUS("Allow") NetworkRuleSetProperties_DefaultAction_STATUS_Deny = NetworkRuleSetProperties_DefaultAction_STATUS("Deny") )
const ( )
const ( StorageEndpointProperties_AuthenticationType_STATUS_IdentityBased = StorageEndpointProperties_AuthenticationType_STATUS("identityBased") StorageEndpointProperties_AuthenticationType_STATUS_KeyBased = StorageEndpointProperties_AuthenticationType_STATUS("keyBased") )
const ( RouteProperties_Source_STATUS_DeviceConnectionStateEvents = RouteProperties_Source_STATUS("DeviceConnectionStateEvents") RouteProperties_Source_STATUS_DeviceJobLifecycleEvents = RouteProperties_Source_STATUS("DeviceJobLifecycleEvents") RouteProperties_Source_STATUS_DeviceLifecycleEvents = RouteProperties_Source_STATUS("DeviceLifecycleEvents") RouteProperties_Source_STATUS_DeviceMessages = RouteProperties_Source_STATUS("DeviceMessages") RouteProperties_Source_STATUS_Invalid = RouteProperties_Source_STATUS("Invalid") RouteProperties_Source_STATUS_TwinChangeEvents = RouteProperties_Source_STATUS("TwinChangeEvents") )
const ( RoutingEventHubProperties_AuthenticationType_STATUS_IdentityBased = RoutingEventHubProperties_AuthenticationType_STATUS("identityBased") RoutingEventHubProperties_AuthenticationType_STATUS_KeyBased = RoutingEventHubProperties_AuthenticationType_STATUS("keyBased") )
const ( RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS_IdentityBased = RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS("identityBased") RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS_KeyBased = RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS("keyBased") )
const ( RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS_IdentityBased = RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS("identityBased") RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS_KeyBased = RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS("keyBased") )
const ( RoutingStorageContainerProperties_AuthenticationType_STATUS_IdentityBased = RoutingStorageContainerProperties_AuthenticationType_STATUS("identityBased") RoutingStorageContainerProperties_AuthenticationType_STATUS_KeyBased = RoutingStorageContainerProperties_AuthenticationType_STATUS("keyBased") )
const ( RoutingStorageContainerProperties_Encoding_STATUS_Avro = RoutingStorageContainerProperties_Encoding_STATUS("Avro") RoutingStorageContainerProperties_Encoding_STATUS_AvroDeflate = RoutingStorageContainerProperties_Encoding_STATUS("AvroDeflate") RoutingStorageContainerProperties_Encoding_STATUS_JSON = RoutingStorageContainerProperties_Encoding_STATUS("JSON") )
const FallbackRouteProperties_Source_DeviceMessages = FallbackRouteProperties_Source("DeviceMessages")
const FallbackRouteProperties_Source_STATUS_DeviceMessages = FallbackRouteProperties_Source_STATUS("DeviceMessages")
const NetworkRuleSetIpRule_Action_Allow = NetworkRuleSetIpRule_Action("Allow")
const NetworkRuleSetIpRule_Action_STATUS_Allow = NetworkRuleSetIpRule_Action_STATUS("Allow")
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArmIdentity ¶
type ArmIdentity struct {
// 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.
Type *ArmIdentity_Type `json:"type,omitempty"`
UserAssignedIdentities map[string]UserAssignedIdentityDetails `json:"userAssignedIdentities,omitempty"`
}
type ArmIdentity_STATUS ¶
type ArmIdentity_STATUS struct {
// PrincipalId: Principal Id
PrincipalId *string `json:"principalId,omitempty"`
// TenantId: Tenant Id
TenantId *string `json:"tenantId,omitempty"`
// 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.
Type *ArmIdentity_Type_STATUS `json:"type,omitempty"`
UserAssignedIdentities map[string]ArmUserIdentity_STATUS `json:"userAssignedIdentities,omitempty"`
}
type ArmIdentity_Type ¶
type ArmIdentity_Type string
+kubebuilder:validation:Enum={"None","SystemAssigned","SystemAssigned, UserAssigned","UserAssigned"}
type ArmIdentity_Type_STATUS ¶
type ArmIdentity_Type_STATUS string
type ArmUserIdentity_STATUS ¶
type CloudToDeviceProperties ¶
type CloudToDeviceProperties struct {
// 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.
DefaultTtlAsIso8601 *string `json:"defaultTtlAsIso8601,omitempty"`
// Feedback: The properties of the feedback queue for cloud-to-device messages.
Feedback *FeedbackProperties `json:"feedback,omitempty"`
// 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.
MaxDeliveryCount *int `json:"maxDeliveryCount,omitempty"`
}
The IoT hub cloud-to-device messaging properties.
type CloudToDeviceProperties_STATUS ¶
type CloudToDeviceProperties_STATUS struct {
// 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.
DefaultTtlAsIso8601 *string `json:"defaultTtlAsIso8601,omitempty"`
// Feedback: The properties of the feedback queue for cloud-to-device messages.
Feedback *FeedbackProperties_STATUS `json:"feedback,omitempty"`
// 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.
MaxDeliveryCount *int `json:"maxDeliveryCount,omitempty"`
}
The IoT hub cloud-to-device messaging properties.
type EnrichmentProperties ¶
type EnrichmentProperties struct {
// EndpointNames: The list of endpoints for which the enrichment is applied to the message.
EndpointNames []string `json:"endpointNames,omitempty"`
// Key: The key or name for the enrichment property.
Key *string `json:"key,omitempty"`
// Value: The value for the enrichment property.
Value *string `json:"value,omitempty"`
}
The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.
type EnrichmentProperties_STATUS ¶
type EnrichmentProperties_STATUS struct {
// EndpointNames: The list of endpoints for which the enrichment is applied to the message.
EndpointNames []string `json:"endpointNames,omitempty"`
// Key: The key or name for the enrichment property.
Key *string `json:"key,omitempty"`
// Value: The value for the enrichment property.
Value *string `json:"value,omitempty"`
}
The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.
type EventHubProperties ¶
type EventHubProperties struct {
// 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.
PartitionCount *int `json:"partitionCount,omitempty"`
// 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
RetentionTimeInDays *int `json:"retentionTimeInDays,omitempty"`
}
The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
type EventHubProperties_STATUS ¶
type EventHubProperties_STATUS struct {
// Endpoint: The Event Hub-compatible endpoint.
Endpoint *string `json:"endpoint,omitempty"`
// 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.
PartitionCount *int `json:"partitionCount,omitempty"`
// PartitionIds: The partition ids in the Event Hub-compatible endpoint.
PartitionIds []string `json:"partitionIds,omitempty"`
// Path: The Event Hub-compatible name.
Path *string `json:"path,omitempty"`
// 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
RetentionTimeInDays *int `json:"retentionTimeInDays,omitempty"`
}
The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
type FallbackRouteProperties ¶
type FallbackRouteProperties struct {
// 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
Condition *string `json:"condition,omitempty"`
// EndpointNames: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1
// endpoint is allowed.
EndpointNames []string `json:"endpointNames,omitempty"`
// IsEnabled: Used to specify whether the fallback route is enabled.
IsEnabled *bool `json:"isEnabled,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// Source: The source to which the routing rule is to be applied to. For example, DeviceMessages
Source *FallbackRouteProperties_Source `json:"source,omitempty"`
}
The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.
type FallbackRouteProperties_STATUS ¶
type FallbackRouteProperties_STATUS struct {
// 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
Condition *string `json:"condition,omitempty"`
// EndpointNames: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1
// endpoint is allowed.
EndpointNames []string `json:"endpointNames,omitempty"`
// IsEnabled: Used to specify whether the fallback route is enabled.
IsEnabled *bool `json:"isEnabled,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// Source: The source to which the routing rule is to be applied to. For example, DeviceMessages
Source *FallbackRouteProperties_Source_STATUS `json:"source,omitempty"`
}
The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.
type FallbackRouteProperties_Source ¶
type FallbackRouteProperties_Source string
+kubebuilder:validation:Enum={"DeviceMessages"}
type FallbackRouteProperties_Source_STATUS ¶
type FallbackRouteProperties_Source_STATUS string
type FeedbackProperties ¶
type FeedbackProperties struct {
// LockDurationAsIso8601: The lock duration for the feedback queue. See:
// https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
// 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.
MaxDeliveryCount *int `json:"maxDeliveryCount,omitempty"`
// 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.
TtlAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
}
The properties of the feedback queue for cloud-to-device messages.
type FeedbackProperties_STATUS ¶
type FeedbackProperties_STATUS struct {
// LockDurationAsIso8601: The lock duration for the feedback queue. See:
// https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
// 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.
MaxDeliveryCount *int `json:"maxDeliveryCount,omitempty"`
// 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.
TtlAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
}
The properties of the feedback queue for cloud-to-device messages.
type IotHubLocationDescription_Role_STATUS ¶
type IotHubLocationDescription_Role_STATUS string
type IotHubLocationDescription_STATUS ¶
type IotHubLocationDescription_STATUS struct {
// Location: The name of the Azure region
Location *string `json:"location,omitempty"`
// 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.
Role *IotHubLocationDescription_Role_STATUS `json:"role,omitempty"`
}
Public representation of one of the locations where a resource is provisioned.
type IotHubProperties ¶
type IotHubProperties struct {
// AllowedFqdnList: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
AllowedFqdnList []string `json:"allowedFqdnList,omitempty"`
// AuthorizationPolicies: The shared access policies you can use to secure a connection to the IoT hub.
AuthorizationPolicies []SharedAccessSignatureAuthorizationRule `json:"authorizationPolicies,omitempty"`
// CloudToDevice: The IoT hub cloud-to-device messaging properties.
CloudToDevice *CloudToDeviceProperties `json:"cloudToDevice,omitempty"`
// Comments: IoT hub comments.
Comments *string `json:"comments,omitempty"`
// DisableDeviceSAS: If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for
// authentication.
DisableDeviceSAS *bool `json:"disableDeviceSAS,omitempty"`
// DisableLocalAuth: If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`
// DisableModuleSAS: If true, all module scoped SAS keys cannot be used for authentication.
DisableModuleSAS *bool `json:"disableModuleSAS,omitempty"`
// EnableDataResidency: This property when set to true, will enable data residency, thus, disabling disaster recovery.
EnableDataResidency *bool `json:"enableDataResidency,omitempty"`
// EnableFileUploadNotifications: If True, file upload notifications are enabled.
EnableFileUploadNotifications *bool `json:"enableFileUploadNotifications,omitempty"`
// 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.
EventHubEndpoints map[string]EventHubProperties `json:"eventHubEndpoints,omitempty"`
// Features: The capabilities and features enabled for the IoT hub.
Features *IotHubProperties_Features `json:"features,omitempty"`
// IpFilterRules: The IP filter rules.
IpFilterRules []IpFilterRule `json:"ipFilterRules,omitempty"`
// MessagingEndpoints: The messaging endpoint properties for the file upload notification queue.
MessagingEndpoints map[string]MessagingEndpointProperties `json:"messagingEndpoints,omitempty"`
// 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.
MinTlsVersion *string `json:"minTlsVersion,omitempty"`
// NetworkRuleSets: Network Rule Set Properties of IotHub
NetworkRuleSets *NetworkRuleSetProperties `json:"networkRuleSets,omitempty"`
// PublicNetworkAccess: Whether requests from Public Network are allowed
PublicNetworkAccess *IotHubProperties_PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
// RestrictOutboundNetworkAccess: If true, egress from IotHub will be restricted to only the allowed FQDNs that are
// configured via allowedFqdnList.
RestrictOutboundNetworkAccess *bool `json:"restrictOutboundNetworkAccess,omitempty"`
// Routing: The routing related properties of the IoT hub. See:
// https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Routing *RoutingProperties `json:"routing,omitempty"`
// 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.
StorageEndpoints map[string]StorageEndpointProperties `json:"storageEndpoints,omitempty"`
}
The properties of an IoT hub.
type IotHubProperties_Features ¶
type IotHubProperties_Features string
+kubebuilder:validation:Enum={"DeviceManagement","None"}
type IotHubProperties_Features_STATUS ¶
type IotHubProperties_Features_STATUS string
type IotHubProperties_PublicNetworkAccess ¶
type IotHubProperties_PublicNetworkAccess string
+kubebuilder:validation:Enum={"Disabled","Enabled"}
type IotHubProperties_PublicNetworkAccess_STATUS ¶
type IotHubProperties_PublicNetworkAccess_STATUS string
type IotHubProperties_STATUS ¶
type IotHubProperties_STATUS struct {
// AllowedFqdnList: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
AllowedFqdnList []string `json:"allowedFqdnList,omitempty"`
// AuthorizationPolicies: The shared access policies you can use to secure a connection to the IoT hub.
AuthorizationPolicies []SharedAccessSignatureAuthorizationRule_STATUS `json:"authorizationPolicies,omitempty"`
// CloudToDevice: The IoT hub cloud-to-device messaging properties.
CloudToDevice *CloudToDeviceProperties_STATUS `json:"cloudToDevice,omitempty"`
// Comments: IoT hub comments.
Comments *string `json:"comments,omitempty"`
// DisableDeviceSAS: If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for
// authentication.
DisableDeviceSAS *bool `json:"disableDeviceSAS,omitempty"`
// DisableLocalAuth: If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`
// DisableModuleSAS: If true, all module scoped SAS keys cannot be used for authentication.
DisableModuleSAS *bool `json:"disableModuleSAS,omitempty"`
// EnableDataResidency: This property when set to true, will enable data residency, thus, disabling disaster recovery.
EnableDataResidency *bool `json:"enableDataResidency,omitempty"`
// EnableFileUploadNotifications: If True, file upload notifications are enabled.
EnableFileUploadNotifications *bool `json:"enableFileUploadNotifications,omitempty"`
// 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.
EventHubEndpoints map[string]EventHubProperties_STATUS `json:"eventHubEndpoints,omitempty"`
// Features: The capabilities and features enabled for the IoT hub.
Features *IotHubProperties_Features_STATUS `json:"features,omitempty"`
// HostName: The name of the host.
HostName *string `json:"hostName,omitempty"`
// IpFilterRules: The IP filter rules.
IpFilterRules []IpFilterRule_STATUS `json:"ipFilterRules,omitempty"`
// Locations: Primary and secondary location for iot hub
Locations []IotHubLocationDescription_STATUS `json:"locations,omitempty"`
// MessagingEndpoints: The messaging endpoint properties for the file upload notification queue.
MessagingEndpoints map[string]MessagingEndpointProperties_STATUS `json:"messagingEndpoints,omitempty"`
// 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.
MinTlsVersion *string `json:"minTlsVersion,omitempty"`
// NetworkRuleSets: Network Rule Set Properties of IotHub
NetworkRuleSets *NetworkRuleSetProperties_STATUS `json:"networkRuleSets,omitempty"`
// PrivateEndpointConnections: Private endpoint connections created on this IotHub
PrivateEndpointConnections []PrivateEndpointConnection_STATUS `json:"privateEndpointConnections,omitempty"`
// ProvisioningState: The provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
// PublicNetworkAccess: Whether requests from Public Network are allowed
PublicNetworkAccess *IotHubProperties_PublicNetworkAccess_STATUS `json:"publicNetworkAccess,omitempty"`
// RestrictOutboundNetworkAccess: If true, egress from IotHub will be restricted to only the allowed FQDNs that are
// configured via allowedFqdnList.
RestrictOutboundNetworkAccess *bool `json:"restrictOutboundNetworkAccess,omitempty"`
// Routing: The routing related properties of the IoT hub. See:
// https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
Routing *RoutingProperties_STATUS `json:"routing,omitempty"`
// State: The hub state.
State *string `json:"state,omitempty"`
// 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.
StorageEndpoints map[string]StorageEndpointProperties_STATUS `json:"storageEndpoints,omitempty"`
}
The properties of an IoT hub.
type IotHubSkuInfo ¶
type IotHubSkuInfo struct {
// Capacity: The number of provisioned IoT Hub units. See:
// https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
Capacity *int `json:"capacity,omitempty"`
// Name: The name of the SKU.
Name *IotHubSkuInfo_Name `json:"name,omitempty"`
}
Information about the SKU of the IoT hub.
type IotHubSkuInfo_Name ¶
type IotHubSkuInfo_Name string
+kubebuilder:validation:Enum={"B1","B2","B3","F1","S1","S2","S3"}
type IotHubSkuInfo_Name_STATUS ¶
type IotHubSkuInfo_Name_STATUS string
type IotHubSkuInfo_STATUS ¶
type IotHubSkuInfo_STATUS struct {
// Capacity: The number of provisioned IoT Hub units. See:
// https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
Capacity *int `json:"capacity,omitempty"`
// Name: The name of the SKU.
Name *IotHubSkuInfo_Name_STATUS `json:"name,omitempty"`
// Tier: The billing tier for the IoT hub.
Tier *IotHubSkuInfo_Tier_STATUS `json:"tier,omitempty"`
}
Information about the SKU of the IoT hub.
type IotHubSkuInfo_Tier_STATUS ¶
type IotHubSkuInfo_Tier_STATUS string
type IotHub_STATUS ¶
type IotHub_STATUS struct {
// 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.
Etag *string `json:"etag,omitempty"`
// Id: The resource identifier.
Id *string `json:"id,omitempty"`
// Identity: The managed identities for the IotHub.
Identity *ArmIdentity_STATUS `json:"identity,omitempty"`
// Location: The resource location.
Location *string `json:"location,omitempty"`
// Name: The resource name.
Name *string `json:"name,omitempty"`
// Properties: IotHub properties
Properties *IotHubProperties_STATUS `json:"properties,omitempty"`
// Sku: IotHub SKU info
Sku *IotHubSkuInfo_STATUS `json:"sku,omitempty"`
// SystemData: The system meta data relating to this resource.
SystemData *SystemData_STATUS `json:"systemData,omitempty"`
// Tags: The resource tags.
Tags map[string]string `json:"tags,omitempty"`
// Type: The resource type.
Type *string `json:"type,omitempty"`
}
type IotHub_Spec ¶
type IotHub_Spec struct {
// Identity: The managed identities for the IotHub.
Identity *ArmIdentity `json:"identity,omitempty"`
// Location: The resource location.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: IotHub properties
Properties *IotHubProperties `json:"properties,omitempty"`
// Sku: IotHub SKU info
Sku *IotHubSkuInfo `json:"sku,omitempty"`
// Tags: The resource tags.
Tags map[string]string `json:"tags,omitempty"`
}
func (IotHub_Spec) GetAPIVersion ¶
func (iotHub IotHub_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2021-07-02"
func (*IotHub_Spec) GetName ¶
func (iotHub *IotHub_Spec) GetName() string
GetName returns the Name of the resource
func (*IotHub_Spec) GetType ¶
func (iotHub *IotHub_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.Devices/IotHubs"
type IpFilterRule ¶
type IpFilterRule struct {
// Action: The desired action for requests captured by this rule.
Action *IpFilterRule_Action `json:"action,omitempty"`
// FilterName: The name of the IP filter rule.
FilterName *string `json:"filterName,omitempty"`
// IpMask: A string that contains the IP address range in CIDR notation for the rule.
IpMask *string `json:"ipMask,omitempty"`
}
The IP filter rules for the IoT hub.
type IpFilterRule_Action ¶
type IpFilterRule_Action string
+kubebuilder:validation:Enum={"Accept","Reject"}
type IpFilterRule_Action_STATUS ¶
type IpFilterRule_Action_STATUS string
type IpFilterRule_STATUS ¶
type IpFilterRule_STATUS struct {
// Action: The desired action for requests captured by this rule.
Action *IpFilterRule_Action_STATUS `json:"action,omitempty"`
// FilterName: The name of the IP filter rule.
FilterName *string `json:"filterName,omitempty"`
// IpMask: A string that contains the IP address range in CIDR notation for the rule.
IpMask *string `json:"ipMask,omitempty"`
}
The IP filter rules for the IoT hub.
type ManagedIdentity ¶
type ManagedIdentity struct {
// UserAssignedIdentity: The user assigned identity.
UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}
The properties of the Managed identity.
type ManagedIdentity_STATUS ¶
type ManagedIdentity_STATUS struct {
// UserAssignedIdentity: The user assigned identity.
UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}
The properties of the Managed identity.
type MessagingEndpointProperties ¶
type MessagingEndpointProperties struct {
// LockDurationAsIso8601: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
// 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.
MaxDeliveryCount *int `json:"maxDeliveryCount,omitempty"`
// 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.
TtlAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
}
The properties of the messaging endpoints used by this IoT hub.
type MessagingEndpointProperties_STATUS ¶
type MessagingEndpointProperties_STATUS struct {
// LockDurationAsIso8601: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
// 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.
MaxDeliveryCount *int `json:"maxDeliveryCount,omitempty"`
// 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.
TtlAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
}
The properties of the messaging endpoints used by this IoT hub.
type NetworkRuleSetIpRule ¶
type NetworkRuleSetIpRule struct {
// Action: IP Filter Action
Action *NetworkRuleSetIpRule_Action `json:"action,omitempty"`
// FilterName: Name of the IP filter rule.
FilterName *string `json:"filterName,omitempty"`
// IpMask: A string that contains the IP address range in CIDR notation for the rule.
IpMask *string `json:"ipMask,omitempty"`
}
IP Rule to be applied as part of Network Rule Set
type NetworkRuleSetIpRule_Action ¶
type NetworkRuleSetIpRule_Action string
+kubebuilder:validation:Enum={"Allow"}
type NetworkRuleSetIpRule_Action_STATUS ¶
type NetworkRuleSetIpRule_Action_STATUS string
type NetworkRuleSetIpRule_STATUS ¶
type NetworkRuleSetIpRule_STATUS struct {
// Action: IP Filter Action
Action *NetworkRuleSetIpRule_Action_STATUS `json:"action,omitempty"`
// FilterName: Name of the IP filter rule.
FilterName *string `json:"filterName,omitempty"`
// IpMask: A string that contains the IP address range in CIDR notation for the rule.
IpMask *string `json:"ipMask,omitempty"`
}
IP Rule to be applied as part of Network Rule Set
type NetworkRuleSetProperties ¶
type NetworkRuleSetProperties struct {
// ApplyToBuiltInEventHubEndpoint: If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
ApplyToBuiltInEventHubEndpoint *bool `json:"applyToBuiltInEventHubEndpoint,omitempty"`
// DefaultAction: Default Action for Network Rule Set
DefaultAction *NetworkRuleSetProperties_DefaultAction `json:"defaultAction,omitempty"`
// IpRules: List of IP Rules
IpRules []NetworkRuleSetIpRule `json:"ipRules,omitempty"`
}
Network Rule Set Properties of IotHub
type NetworkRuleSetProperties_DefaultAction ¶
type NetworkRuleSetProperties_DefaultAction string
+kubebuilder:validation:Enum={"Allow","Deny"}
type NetworkRuleSetProperties_DefaultAction_STATUS ¶
type NetworkRuleSetProperties_DefaultAction_STATUS string
type NetworkRuleSetProperties_STATUS ¶
type NetworkRuleSetProperties_STATUS struct {
// ApplyToBuiltInEventHubEndpoint: If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
ApplyToBuiltInEventHubEndpoint *bool `json:"applyToBuiltInEventHubEndpoint,omitempty"`
// DefaultAction: Default Action for Network Rule Set
DefaultAction *NetworkRuleSetProperties_DefaultAction_STATUS `json:"defaultAction,omitempty"`
// IpRules: List of IP Rules
IpRules []NetworkRuleSetIpRule_STATUS `json:"ipRules,omitempty"`
}
Network Rule Set Properties of IotHub
type PrivateEndpointConnection_STATUS ¶
type PrivateEndpointConnection_STATUS struct {
// Id: The resource identifier.
Id *string `json:"id,omitempty"`
}
The private endpoint connection of an IotHub
type RouteProperties ¶
type RouteProperties struct {
// 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
Condition *string `json:"condition,omitempty"`
// EndpointNames: The list of endpoints to which messages that satisfy the condition are routed. Currently only one
// endpoint is allowed.
EndpointNames []string `json:"endpointNames,omitempty"`
// IsEnabled: Used to specify whether a route is enabled.
IsEnabled *bool `json:"isEnabled,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// Source: The source that the routing rule is to be applied to, such as DeviceMessages.
Source *RouteProperties_Source `json:"source,omitempty"`
}
The properties of a routing rule that your IoT hub uses to route messages to endpoints.
type RouteProperties_STATUS ¶
type RouteProperties_STATUS struct {
// 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
Condition *string `json:"condition,omitempty"`
// EndpointNames: The list of endpoints to which messages that satisfy the condition are routed. Currently only one
// endpoint is allowed.
EndpointNames []string `json:"endpointNames,omitempty"`
// IsEnabled: Used to specify whether a route is enabled.
IsEnabled *bool `json:"isEnabled,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// Source: The source that the routing rule is to be applied to, such as DeviceMessages.
Source *RouteProperties_Source_STATUS `json:"source,omitempty"`
}
The properties of a routing rule that your IoT hub uses to route messages to endpoints.
type RouteProperties_Source ¶
type RouteProperties_Source string
+kubebuilder:validation:Enum={"DeviceConnectionStateEvents","DeviceJobLifecycleEvents","DeviceLifecycleEvents","DeviceMessages","Invalid","TwinChangeEvents"}
type RouteProperties_Source_STATUS ¶
type RouteProperties_Source_STATUS string
type RoutingEndpoints ¶
type RoutingEndpoints struct {
// 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.
EventHubs []RoutingEventHubProperties `json:"eventHubs,omitempty"`
// ServiceBusQueues: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing
// rules.
ServiceBusQueues []RoutingServiceBusQueueEndpointProperties `json:"serviceBusQueues,omitempty"`
// ServiceBusTopics: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing
// rules.
ServiceBusTopics []RoutingServiceBusTopicEndpointProperties `json:"serviceBusTopics,omitempty"`
// StorageContainers: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
StorageContainers []RoutingStorageContainerProperties `json:"storageContainers,omitempty"`
}
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.
type RoutingEndpoints_STATUS ¶
type RoutingEndpoints_STATUS struct {
// 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.
EventHubs []RoutingEventHubProperties_STATUS `json:"eventHubs,omitempty"`
// ServiceBusQueues: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing
// rules.
ServiceBusQueues []RoutingServiceBusQueueEndpointProperties_STATUS `json:"serviceBusQueues,omitempty"`
// ServiceBusTopics: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing
// rules.
ServiceBusTopics []RoutingServiceBusTopicEndpointProperties_STATUS `json:"serviceBusTopics,omitempty"`
// StorageContainers: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
StorageContainers []RoutingStorageContainerProperties_STATUS `json:"storageContainers,omitempty"`
}
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.
type RoutingEventHubProperties ¶
type RoutingEventHubProperties struct {
// AuthenticationType: Method used to authenticate against the event hub endpoint
AuthenticationType *RoutingEventHubProperties_AuthenticationType `json:"authenticationType,omitempty"`
// ConnectionString: The connection string of the event hub endpoint.
ConnectionString *string `json:"connectionString,omitempty"`
// EndpointUri: The url of the event hub endpoint. It must include the protocol sb://
EndpointUri *string `json:"endpointUri,omitempty"`
// EntityPath: Event hub name on the event hub namespace
EntityPath *string `json:"entityPath,omitempty"`
Id *string `json:"id,omitempty"`
// Identity: Managed identity properties of routing event hub endpoint.
Identity *ManagedIdentity `json:"identity,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// ResourceGroup: The name of the resource group of the event hub endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
// SubscriptionId: The subscription identifier of the event hub endpoint.
SubscriptionId *string `json:"subscriptionId,omitempty"`
}
The properties related to an event hub endpoint.
type RoutingEventHubProperties_AuthenticationType ¶
type RoutingEventHubProperties_AuthenticationType string
+kubebuilder:validation:Enum={"identityBased","keyBased"}
type RoutingEventHubProperties_AuthenticationType_STATUS ¶
type RoutingEventHubProperties_AuthenticationType_STATUS string
type RoutingEventHubProperties_STATUS ¶
type RoutingEventHubProperties_STATUS struct {
// AuthenticationType: Method used to authenticate against the event hub endpoint
AuthenticationType *RoutingEventHubProperties_AuthenticationType_STATUS `json:"authenticationType,omitempty"`
// EndpointUri: The url of the event hub endpoint. It must include the protocol sb://
EndpointUri *string `json:"endpointUri,omitempty"`
// EntityPath: Event hub name on the event hub namespace
EntityPath *string `json:"entityPath,omitempty"`
// Id: Id of the event hub endpoint
Id *string `json:"id,omitempty"`
// Identity: Managed identity properties of routing event hub endpoint.
Identity *ManagedIdentity_STATUS `json:"identity,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// ResourceGroup: The name of the resource group of the event hub endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
// SubscriptionId: The subscription identifier of the event hub endpoint.
SubscriptionId *string `json:"subscriptionId,omitempty"`
}
The properties related to an event hub endpoint.
type RoutingProperties ¶
type RoutingProperties struct {
// 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.
Endpoints *RoutingEndpoints `json:"endpoints,omitempty"`
// 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
Enrichments []EnrichmentProperties `json:"enrichments,omitempty"`
// 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.
FallbackRoute *FallbackRouteProperties `json:"fallbackRoute,omitempty"`
// 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.
Routes []RouteProperties `json:"routes,omitempty"`
}
The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
type RoutingProperties_STATUS ¶
type RoutingProperties_STATUS struct {
// 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.
Endpoints *RoutingEndpoints_STATUS `json:"endpoints,omitempty"`
// 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
Enrichments []EnrichmentProperties_STATUS `json:"enrichments,omitempty"`
// 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.
FallbackRoute *FallbackRouteProperties_STATUS `json:"fallbackRoute,omitempty"`
// 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.
Routes []RouteProperties_STATUS `json:"routes,omitempty"`
}
The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
type RoutingServiceBusQueueEndpointProperties ¶
type RoutingServiceBusQueueEndpointProperties struct {
// AuthenticationType: Method used to authenticate against the service bus queue endpoint
AuthenticationType *RoutingServiceBusQueueEndpointProperties_AuthenticationType `json:"authenticationType,omitempty"`
// ConnectionString: The connection string of the service bus queue endpoint.
ConnectionString *string `json:"connectionString,omitempty"`
// EndpointUri: The url of the service bus queue endpoint. It must include the protocol sb://
EndpointUri *string `json:"endpointUri,omitempty"`
// EntityPath: Queue name on the service bus namespace
EntityPath *string `json:"entityPath,omitempty"`
Id *string `json:"id,omitempty"`
// Identity: Managed identity properties of routing service bus queue endpoint.
Identity *ManagedIdentity `json:"identity,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// ResourceGroup: The name of the resource group of the service bus queue endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
// SubscriptionId: The subscription identifier of the service bus queue endpoint.
SubscriptionId *string `json:"subscriptionId,omitempty"`
}
The properties related to service bus queue endpoint types.
type RoutingServiceBusQueueEndpointProperties_AuthenticationType ¶
type RoutingServiceBusQueueEndpointProperties_AuthenticationType string
+kubebuilder:validation:Enum={"identityBased","keyBased"}
type RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS ¶
type RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS string
type RoutingServiceBusQueueEndpointProperties_STATUS ¶
type RoutingServiceBusQueueEndpointProperties_STATUS struct {
// AuthenticationType: Method used to authenticate against the service bus queue endpoint
AuthenticationType *RoutingServiceBusQueueEndpointProperties_AuthenticationType_STATUS `json:"authenticationType,omitempty"`
// EndpointUri: The url of the service bus queue endpoint. It must include the protocol sb://
EndpointUri *string `json:"endpointUri,omitempty"`
// EntityPath: Queue name on the service bus namespace
EntityPath *string `json:"entityPath,omitempty"`
// Id: Id of the service bus queue endpoint
Id *string `json:"id,omitempty"`
// Identity: Managed identity properties of routing service bus queue endpoint.
Identity *ManagedIdentity_STATUS `json:"identity,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// ResourceGroup: The name of the resource group of the service bus queue endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
// SubscriptionId: The subscription identifier of the service bus queue endpoint.
SubscriptionId *string `json:"subscriptionId,omitempty"`
}
The properties related to service bus queue endpoint types.
type RoutingServiceBusTopicEndpointProperties ¶
type RoutingServiceBusTopicEndpointProperties struct {
// AuthenticationType: Method used to authenticate against the service bus topic endpoint
AuthenticationType *RoutingServiceBusTopicEndpointProperties_AuthenticationType `json:"authenticationType,omitempty"`
// ConnectionString: The connection string of the service bus topic endpoint.
ConnectionString *string `json:"connectionString,omitempty"`
// EndpointUri: The url of the service bus topic endpoint. It must include the protocol sb://
EndpointUri *string `json:"endpointUri,omitempty"`
// EntityPath: Queue name on the service bus topic
EntityPath *string `json:"entityPath,omitempty"`
Id *string `json:"id,omitempty"`
// Identity: Managed identity properties of routing service bus topic endpoint.
Identity *ManagedIdentity `json:"identity,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// ResourceGroup: The name of the resource group of the service bus topic endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
// SubscriptionId: The subscription identifier of the service bus topic endpoint.
SubscriptionId *string `json:"subscriptionId,omitempty"`
}
The properties related to service bus topic endpoint types.
type RoutingServiceBusTopicEndpointProperties_AuthenticationType ¶
type RoutingServiceBusTopicEndpointProperties_AuthenticationType string
+kubebuilder:validation:Enum={"identityBased","keyBased"}
type RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS ¶
type RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS string
type RoutingServiceBusTopicEndpointProperties_STATUS ¶
type RoutingServiceBusTopicEndpointProperties_STATUS struct {
// AuthenticationType: Method used to authenticate against the service bus topic endpoint
AuthenticationType *RoutingServiceBusTopicEndpointProperties_AuthenticationType_STATUS `json:"authenticationType,omitempty"`
// EndpointUri: The url of the service bus topic endpoint. It must include the protocol sb://
EndpointUri *string `json:"endpointUri,omitempty"`
// EntityPath: Queue name on the service bus topic
EntityPath *string `json:"entityPath,omitempty"`
// Id: Id of the service bus topic endpoint
Id *string `json:"id,omitempty"`
// Identity: Managed identity properties of routing service bus topic endpoint.
Identity *ManagedIdentity_STATUS `json:"identity,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// ResourceGroup: The name of the resource group of the service bus topic endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
// SubscriptionId: The subscription identifier of the service bus topic endpoint.
SubscriptionId *string `json:"subscriptionId,omitempty"`
}
The properties related to service bus topic endpoint types.
type RoutingStorageContainerProperties ¶
type RoutingStorageContainerProperties struct {
// AuthenticationType: Method used to authenticate against the storage endpoint
AuthenticationType *RoutingStorageContainerProperties_AuthenticationType `json:"authenticationType,omitempty"`
// BatchFrequencyInSeconds: Time interval at which blobs are written to storage. Value should be between 60 and 720
// seconds. Default value is 300 seconds.
BatchFrequencyInSeconds *int `json:"batchFrequencyInSeconds,omitempty"`
// ConnectionString: The connection string of the storage account.
ConnectionString *string `json:"connectionString,omitempty"`
// ContainerName: The name of storage container in the storage account.
ContainerName *string `json:"containerName,omitempty"`
// Encoding: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'.
// Default value is 'avro'.
Encoding *RoutingStorageContainerProperties_Encoding `json:"encoding,omitempty"`
// EndpointUri: The url of the storage endpoint. It must include the protocol https://
EndpointUri *string `json:"endpointUri,omitempty"`
// 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.
FileNameFormat *string `json:"fileNameFormat,omitempty"`
Id *string `json:"id,omitempty"`
// Identity: Managed identity properties of routing storage endpoint.
Identity *ManagedIdentity `json:"identity,omitempty"`
// 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).
MaxChunkSizeInBytes *int `json:"maxChunkSizeInBytes,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// ResourceGroup: The name of the resource group of the storage account.
ResourceGroup *string `json:"resourceGroup,omitempty"`
// SubscriptionId: The subscription identifier of the storage account.
SubscriptionId *string `json:"subscriptionId,omitempty"`
}
The properties related to a storage container endpoint.
type RoutingStorageContainerProperties_AuthenticationType ¶
type RoutingStorageContainerProperties_AuthenticationType string
+kubebuilder:validation:Enum={"identityBased","keyBased"}
type RoutingStorageContainerProperties_AuthenticationType_STATUS ¶
type RoutingStorageContainerProperties_AuthenticationType_STATUS string
type RoutingStorageContainerProperties_Encoding ¶
type RoutingStorageContainerProperties_Encoding string
+kubebuilder:validation:Enum={"Avro","AvroDeflate","JSON"}
type RoutingStorageContainerProperties_Encoding_STATUS ¶
type RoutingStorageContainerProperties_Encoding_STATUS string
type RoutingStorageContainerProperties_STATUS ¶
type RoutingStorageContainerProperties_STATUS struct {
// AuthenticationType: Method used to authenticate against the storage endpoint
AuthenticationType *RoutingStorageContainerProperties_AuthenticationType_STATUS `json:"authenticationType,omitempty"`
// BatchFrequencyInSeconds: Time interval at which blobs are written to storage. Value should be between 60 and 720
// seconds. Default value is 300 seconds.
BatchFrequencyInSeconds *int `json:"batchFrequencyInSeconds,omitempty"`
// ContainerName: The name of storage container in the storage account.
ContainerName *string `json:"containerName,omitempty"`
// Encoding: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'.
// Default value is 'avro'.
Encoding *RoutingStorageContainerProperties_Encoding_STATUS `json:"encoding,omitempty"`
// EndpointUri: The url of the storage endpoint. It must include the protocol https://
EndpointUri *string `json:"endpointUri,omitempty"`
// 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.
FileNameFormat *string `json:"fileNameFormat,omitempty"`
// Id: Id of the storage container endpoint
Id *string `json:"id,omitempty"`
// Identity: Managed identity properties of routing storage endpoint.
Identity *ManagedIdentity_STATUS `json:"identity,omitempty"`
// 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).
MaxChunkSizeInBytes *int `json:"maxChunkSizeInBytes,omitempty"`
// 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.
Name *string `json:"name,omitempty"`
// ResourceGroup: The name of the resource group of the storage account.
ResourceGroup *string `json:"resourceGroup,omitempty"`
// SubscriptionId: The subscription identifier of the storage account.
SubscriptionId *string `json:"subscriptionId,omitempty"`
}
The properties related to a storage container endpoint.
type SharedAccessSignatureAuthorizationRule ¶
type SharedAccessSignatureAuthorizationRule struct {
KeyName *string `json:"keyName,omitempty"`
Rights *SharedAccessSignatureAuthorizationRule_Rights `json:"rights,omitempty"`
}
The properties of an IoT hub shared access policy.
type SharedAccessSignatureAuthorizationRule_Rights ¶
type SharedAccessSignatureAuthorizationRule_Rights string
+kubebuilder:validation:Enum={"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"}
type SharedAccessSignatureAuthorizationRule_Rights_STATUS ¶
type SharedAccessSignatureAuthorizationRule_Rights_STATUS string
type SharedAccessSignatureAuthorizationRule_STATUS ¶
type SharedAccessSignatureAuthorizationRule_STATUS struct {
KeyName *string `json:"keyName,omitempty"`
Rights *SharedAccessSignatureAuthorizationRule_Rights_STATUS `json:"rights,omitempty"`
}
The properties of an IoT hub shared access policy.
type StorageEndpointProperties ¶
type StorageEndpointProperties struct {
// AuthenticationType: Specifies authentication type being used for connecting to the storage account.
AuthenticationType *StorageEndpointProperties_AuthenticationType `json:"authenticationType,omitempty"`
// ConnectionString: The connection string for the Azure Storage account to which files are uploaded.
ConnectionString *string `json:"connectionString,omitempty"`
// ContainerName: The name of the root container where you upload files. The container need not exist but should be
// creatable using the connectionString specified.
ContainerName *string `json:"containerName,omitempty"`
// Identity: Managed identity properties of storage endpoint for file upload.
Identity *ManagedIdentity `json:"identity,omitempty"`
// 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.
SasTtlAsIso8601 *string `json:"sasTtlAsIso8601,omitempty"`
}
The properties of the Azure Storage endpoint for file upload.
type StorageEndpointProperties_AuthenticationType ¶
type StorageEndpointProperties_AuthenticationType string
+kubebuilder:validation:Enum={"identityBased","keyBased"}
type StorageEndpointProperties_AuthenticationType_STATUS ¶
type StorageEndpointProperties_AuthenticationType_STATUS string
type StorageEndpointProperties_STATUS ¶
type StorageEndpointProperties_STATUS struct {
// AuthenticationType: Specifies authentication type being used for connecting to the storage account.
AuthenticationType *StorageEndpointProperties_AuthenticationType_STATUS `json:"authenticationType,omitempty"`
// ContainerName: The name of the root container where you upload files. The container need not exist but should be
// creatable using the connectionString specified.
ContainerName *string `json:"containerName,omitempty"`
// Identity: Managed identity properties of storage endpoint for file upload.
Identity *ManagedIdentity_STATUS `json:"identity,omitempty"`
// 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.
SasTtlAsIso8601 *string `json:"sasTtlAsIso8601,omitempty"`
}
The properties of the Azure Storage endpoint for file upload.
type SystemData_CreatedByType_STATUS ¶
type SystemData_CreatedByType_STATUS string
type SystemData_LastModifiedByType_STATUS ¶
type SystemData_LastModifiedByType_STATUS string
type SystemData_STATUS ¶
type SystemData_STATUS struct {
// CreatedAt: The timestamp of resource creation (UTC).
CreatedAt *string `json:"createdAt,omitempty"`
// CreatedBy: The identity that created the resource.
CreatedBy *string `json:"createdBy,omitempty"`
// CreatedByType: The type of identity that created the resource.
CreatedByType *SystemData_CreatedByType_STATUS `json:"createdByType,omitempty"`
// LastModifiedAt: The timestamp of resource last modification (UTC)
LastModifiedAt *string `json:"lastModifiedAt,omitempty"`
// LastModifiedBy: The identity that last modified the resource.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// LastModifiedByType: The type of identity that last modified the resource.
LastModifiedByType *SystemData_LastModifiedByType_STATUS `json:"lastModifiedByType,omitempty"`
}
Metadata pertaining to creation and last modification of the resource.
type UserAssignedIdentityDetails ¶
type UserAssignedIdentityDetails struct {
}
Information about the user assigned identity for the resource