// Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. See License.txt in the project root for license information. // Code generated by Microsoft (R) Go Code Generator. DO NOT EDIT. package armiothub const ( version20260301Preview string = "2026-03-01-preview" ) // AccessRights - The permissions assigned to the shared access policy. type AccessRights string const ( // AccessRightsDeviceConnect - DeviceConnect AccessRightsDeviceConnect AccessRights = "DeviceConnect" // AccessRightsRegistryRead - RegistryRead AccessRightsRegistryRead AccessRights = "RegistryRead" // AccessRightsRegistryReadDeviceConnect - RegistryRead, DeviceConnect AccessRightsRegistryReadDeviceConnect AccessRights = "RegistryRead, DeviceConnect" // AccessRightsRegistryReadRegistryWrite - RegistryRead, RegistryWrite AccessRightsRegistryReadRegistryWrite AccessRights = "RegistryRead, RegistryWrite" // AccessRightsRegistryReadRegistryWriteDeviceConnect - RegistryRead, RegistryWrite, DeviceConnect AccessRightsRegistryReadRegistryWriteDeviceConnect AccessRights = "RegistryRead, RegistryWrite, DeviceConnect" // AccessRightsRegistryReadRegistryWriteServiceConnect - RegistryRead, RegistryWrite, ServiceConnect AccessRightsRegistryReadRegistryWriteServiceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect" // AccessRightsRegistryReadRegistryWriteServiceConnectDeviceConnect - RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect AccessRightsRegistryReadRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" // AccessRightsRegistryReadServiceConnect - RegistryRead, ServiceConnect AccessRightsRegistryReadServiceConnect AccessRights = "RegistryRead, ServiceConnect" // AccessRightsRegistryReadServiceConnectDeviceConnect - RegistryRead, ServiceConnect, DeviceConnect AccessRightsRegistryReadServiceConnectDeviceConnect AccessRights = "RegistryRead, ServiceConnect, DeviceConnect" // AccessRightsRegistryWrite - RegistryWrite AccessRightsRegistryWrite AccessRights = "RegistryWrite" // AccessRightsRegistryWriteDeviceConnect - RegistryWrite, DeviceConnect AccessRightsRegistryWriteDeviceConnect AccessRights = "RegistryWrite, DeviceConnect" // AccessRightsRegistryWriteServiceConnect - RegistryWrite, ServiceConnect AccessRightsRegistryWriteServiceConnect AccessRights = "RegistryWrite, ServiceConnect" // AccessRightsRegistryWriteServiceConnectDeviceConnect - RegistryWrite, ServiceConnect, DeviceConnect AccessRightsRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryWrite, ServiceConnect, DeviceConnect" // AccessRightsServiceConnect - ServiceConnect AccessRightsServiceConnect AccessRights = "ServiceConnect" // AccessRightsServiceConnectDeviceConnect - ServiceConnect, DeviceConnect AccessRightsServiceConnectDeviceConnect AccessRights = "ServiceConnect, DeviceConnect" ) // PossibleAccessRightsValues returns the possible values for the AccessRights const type. func PossibleAccessRightsValues() []AccessRights { return []AccessRights{ AccessRightsDeviceConnect, AccessRightsRegistryRead, AccessRightsRegistryReadDeviceConnect, AccessRightsRegistryReadRegistryWrite, AccessRightsRegistryReadRegistryWriteDeviceConnect, AccessRightsRegistryReadRegistryWriteServiceConnect, AccessRightsRegistryReadRegistryWriteServiceConnectDeviceConnect, AccessRightsRegistryReadServiceConnect, AccessRightsRegistryReadServiceConnectDeviceConnect, AccessRightsRegistryWrite, AccessRightsRegistryWriteDeviceConnect, AccessRightsRegistryWriteServiceConnect, AccessRightsRegistryWriteServiceConnectDeviceConnect, AccessRightsServiceConnect, AccessRightsServiceConnectDeviceConnect, } } // AuthenticationType - Specifies authentication type being used for connecting to the storage account. type AuthenticationType string const ( // AuthenticationTypeIdentityBased - identityBased AuthenticationTypeIdentityBased AuthenticationType = "identityBased" // AuthenticationTypeKeyBased - keyBased AuthenticationTypeKeyBased AuthenticationType = "keyBased" ) // PossibleAuthenticationTypeValues returns the possible values for the AuthenticationType const type. func PossibleAuthenticationTypeValues() []AuthenticationType { return []AuthenticationType{ AuthenticationTypeIdentityBased, AuthenticationTypeKeyBased, } } // Capabilities - The capabilities and features enabled for the IoT hub. type Capabilities string const ( // CapabilitiesDeviceManagement - DeviceManagement CapabilitiesDeviceManagement Capabilities = "DeviceManagement" // CapabilitiesNone - None CapabilitiesNone Capabilities = "None" ) // PossibleCapabilitiesValues returns the possible values for the Capabilities const type. func PossibleCapabilitiesValues() []Capabilities { return []Capabilities{ CapabilitiesDeviceManagement, CapabilitiesNone, } } // CreatedByType - The kind of entity that created the resource. type CreatedByType string const ( // CreatedByTypeApplication - The entity was created by an application. CreatedByTypeApplication CreatedByType = "Application" // CreatedByTypeKey - The entity was created by a key. CreatedByTypeKey CreatedByType = "Key" // CreatedByTypeManagedIdentity - The entity was created by a managed identity. CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity" // CreatedByTypeUser - The entity was created by a user. CreatedByTypeUser CreatedByType = "User" ) // PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type. func PossibleCreatedByTypeValues() []CreatedByType { return []CreatedByType{ CreatedByTypeApplication, CreatedByTypeKey, CreatedByTypeManagedIdentity, CreatedByTypeUser, } } // DefaultAction - Default Action for Network Rule Set type DefaultAction string const ( // DefaultActionAllow - Allow DefaultActionAllow DefaultAction = "Allow" // DefaultActionDeny - Deny DefaultActionDeny DefaultAction = "Deny" ) // PossibleDefaultActionValues returns the possible values for the DefaultAction const type. func PossibleDefaultActionValues() []DefaultAction { return []DefaultAction{ DefaultActionAllow, DefaultActionDeny, } } // EndpointHealthStatus - Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting // messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub // is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub // has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, // after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues // with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages // have been delivered to or rejected from this endpoint type EndpointHealthStatus string const ( // EndpointHealthStatusDead - dead EndpointHealthStatusDead EndpointHealthStatus = "dead" // EndpointHealthStatusDegraded - degraded EndpointHealthStatusDegraded EndpointHealthStatus = "degraded" // EndpointHealthStatusHealthy - healthy EndpointHealthStatusHealthy EndpointHealthStatus = "healthy" // EndpointHealthStatusUnhealthy - unhealthy EndpointHealthStatusUnhealthy EndpointHealthStatus = "unhealthy" // EndpointHealthStatusUnknown - unknown EndpointHealthStatusUnknown EndpointHealthStatus = "unknown" ) // PossibleEndpointHealthStatusValues returns the possible values for the EndpointHealthStatus const type. func PossibleEndpointHealthStatusValues() []EndpointHealthStatus { return []EndpointHealthStatus{ EndpointHealthStatusDead, EndpointHealthStatusDegraded, EndpointHealthStatusHealthy, EndpointHealthStatusUnhealthy, EndpointHealthStatusUnknown, } } // GatewayVersion - The IoT hub Gateway version. type GatewayVersion string const ( // GatewayVersionV1 - V1 GatewayVersionV1 GatewayVersion = "V1" // GatewayVersionV2 - V2 GatewayVersionV2 GatewayVersion = "V2" ) // PossibleGatewayVersionValues returns the possible values for the GatewayVersion const type. func PossibleGatewayVersionValues() []GatewayVersion { return []GatewayVersion{ GatewayVersionV1, GatewayVersionV2, } } // IPFilterActionType - The desired action for requests captured by this rule. type IPFilterActionType string const ( // IPFilterActionTypeAccept - Accept IPFilterActionTypeAccept IPFilterActionType = "Accept" // IPFilterActionTypeReject - Reject IPFilterActionTypeReject IPFilterActionType = "Reject" ) // PossibleIPFilterActionTypeValues returns the possible values for the IPFilterActionType const type. func PossibleIPFilterActionTypeValues() []IPFilterActionType { return []IPFilterActionType{ IPFilterActionTypeAccept, IPFilterActionTypeReject, } } // IPVersion - This property specifies the IP Version the hub is currently utilizing. type IPVersion string const ( // IPVersionIPv4 - ipv4 IPVersionIPv4 IPVersion = "ipv4" // IPVersionIPv4IPv6 - ipv4ipv6 IPVersionIPv4IPv6 IPVersion = "ipv4ipv6" // IPVersionIPv6 - ipv6 IPVersionIPv6 IPVersion = "ipv6" ) // PossibleIPVersionValues returns the possible values for the IPVersion const type. func PossibleIPVersionValues() []IPVersion { return []IPVersion{ IPVersionIPv4, IPVersionIPv4IPv6, IPVersionIPv6, } } // IotHubNameUnavailabilityReason - The reason for unavailability. type IotHubNameUnavailabilityReason string const ( // IotHubNameUnavailabilityReasonAlreadyExists - AlreadyExists IotHubNameUnavailabilityReasonAlreadyExists IotHubNameUnavailabilityReason = "AlreadyExists" // IotHubNameUnavailabilityReasonInvalid - Invalid IotHubNameUnavailabilityReasonInvalid IotHubNameUnavailabilityReason = "Invalid" ) // PossibleIotHubNameUnavailabilityReasonValues returns the possible values for the IotHubNameUnavailabilityReason const type. func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason { return []IotHubNameUnavailabilityReason{ IotHubNameUnavailabilityReasonAlreadyExists, IotHubNameUnavailabilityReasonInvalid, } } // IotHubReplicaRoleType - 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. type IotHubReplicaRoleType string const ( // IotHubReplicaRoleTypePrimary - primary IotHubReplicaRoleTypePrimary IotHubReplicaRoleType = "primary" // IotHubReplicaRoleTypeSecondary - secondary IotHubReplicaRoleTypeSecondary IotHubReplicaRoleType = "secondary" ) // PossibleIotHubReplicaRoleTypeValues returns the possible values for the IotHubReplicaRoleType const type. func PossibleIotHubReplicaRoleTypeValues() []IotHubReplicaRoleType { return []IotHubReplicaRoleType{ IotHubReplicaRoleTypePrimary, IotHubReplicaRoleTypeSecondary, } } // IotHubSKU - The name of the SKU. type IotHubSKU string const ( // IotHubSKUB1 - B1 IotHubSKUB1 IotHubSKU = "B1" // IotHubSKUB2 - B2 IotHubSKUB2 IotHubSKU = "B2" // IotHubSKUB3 - B3 IotHubSKUB3 IotHubSKU = "B3" // IotHubSKUF1 - F1 IotHubSKUF1 IotHubSKU = "F1" // IotHubSKUGEN2 - GEN2 IotHubSKUGEN2 IotHubSKU = "GEN2" // IotHubSKUS1 - S1 IotHubSKUS1 IotHubSKU = "S1" // IotHubSKUS2 - S2 IotHubSKUS2 IotHubSKU = "S2" // IotHubSKUS3 - S3 IotHubSKUS3 IotHubSKU = "S3" ) // PossibleIotHubSKUValues returns the possible values for the IotHubSKU const type. func PossibleIotHubSKUValues() []IotHubSKU { return []IotHubSKU{ IotHubSKUB1, IotHubSKUB2, IotHubSKUB3, IotHubSKUF1, IotHubSKUGEN2, IotHubSKUS1, IotHubSKUS2, IotHubSKUS3, } } // IotHubSKUTier - The billing tier for the IoT hub. type IotHubSKUTier string const ( // IotHubSKUTierBasic - Basic IotHubSKUTierBasic IotHubSKUTier = "Basic" // IotHubSKUTierFree - Free IotHubSKUTierFree IotHubSKUTier = "Free" // IotHubSKUTierGeneration2 - Generation2 IotHubSKUTierGeneration2 IotHubSKUTier = "Generation2" // IotHubSKUTierStandard - Standard IotHubSKUTierStandard IotHubSKUTier = "Standard" ) // PossibleIotHubSKUTierValues returns the possible values for the IotHubSKUTier const type. func PossibleIotHubSKUTierValues() []IotHubSKUTier { return []IotHubSKUTier{ IotHubSKUTierBasic, IotHubSKUTierFree, IotHubSKUTierGeneration2, IotHubSKUTierStandard, } } // IotHubScaleType - The type of the scaling enabled. type IotHubScaleType string const ( // IotHubScaleTypeAutomatic - Automatic IotHubScaleTypeAutomatic IotHubScaleType = "Automatic" // IotHubScaleTypeManual - Manual IotHubScaleTypeManual IotHubScaleType = "Manual" // IotHubScaleTypeNone - None IotHubScaleTypeNone IotHubScaleType = "None" ) // PossibleIotHubScaleTypeValues returns the possible values for the IotHubScaleType const type. func PossibleIotHubScaleTypeValues() []IotHubScaleType { return []IotHubScaleType{ IotHubScaleTypeAutomatic, IotHubScaleTypeManual, IotHubScaleTypeNone, } } // JobStatus - The status of the job. type JobStatus string const ( // JobStatusCancelled - cancelled JobStatusCancelled JobStatus = "cancelled" // JobStatusCompleted - completed JobStatusCompleted JobStatus = "completed" // JobStatusEnqueued - enqueued JobStatusEnqueued JobStatus = "enqueued" // JobStatusFailed - failed JobStatusFailed JobStatus = "failed" // JobStatusRunning - running JobStatusRunning JobStatus = "running" // JobStatusUnknown - unknown JobStatusUnknown JobStatus = "unknown" ) // PossibleJobStatusValues returns the possible values for the JobStatus const type. func PossibleJobStatusValues() []JobStatus { return []JobStatus{ JobStatusCancelled, JobStatusCompleted, JobStatusEnqueued, JobStatusFailed, JobStatusRunning, JobStatusUnknown, } } // JobType - The type of the job. type JobType string const ( // JobTypeBackup - backup JobTypeBackup JobType = "backup" // JobTypeExport - export JobTypeExport JobType = "export" // JobTypeFactoryResetDevice - factoryResetDevice JobTypeFactoryResetDevice JobType = "factoryResetDevice" // JobTypeFirmwareUpdate - firmwareUpdate JobTypeFirmwareUpdate JobType = "firmwareUpdate" // JobTypeImport - import JobTypeImport JobType = "import" // JobTypeReadDeviceProperties - readDeviceProperties JobTypeReadDeviceProperties JobType = "readDeviceProperties" // JobTypeRebootDevice - rebootDevice JobTypeRebootDevice JobType = "rebootDevice" // JobTypeUnknown - unknown JobTypeUnknown JobType = "unknown" // JobTypeUpdateDeviceConfiguration - updateDeviceConfiguration JobTypeUpdateDeviceConfiguration JobType = "updateDeviceConfiguration" // JobTypeWriteDeviceProperties - writeDeviceProperties JobTypeWriteDeviceProperties JobType = "writeDeviceProperties" ) // PossibleJobTypeValues returns the possible values for the JobType const type. func PossibleJobTypeValues() []JobType { return []JobType{ JobTypeBackup, JobTypeExport, JobTypeFactoryResetDevice, JobTypeFirmwareUpdate, JobTypeImport, JobTypeReadDeviceProperties, JobTypeRebootDevice, JobTypeUnknown, JobTypeUpdateDeviceConfiguration, JobTypeWriteDeviceProperties, } } // NetworkRuleIPAction - IP Filter Action type NetworkRuleIPAction string const ( // NetworkRuleIPActionAllow - Allow NetworkRuleIPActionAllow NetworkRuleIPAction = "Allow" ) // PossibleNetworkRuleIPActionValues returns the possible values for the NetworkRuleIPAction const type. func PossibleNetworkRuleIPActionValues() []NetworkRuleIPAction { return []NetworkRuleIPAction{ NetworkRuleIPActionAllow, } } // PrivateLinkServiceConnectionStatus - The status of a private endpoint connection type PrivateLinkServiceConnectionStatus string const ( // PrivateLinkServiceConnectionStatusApproved - Approved PrivateLinkServiceConnectionStatusApproved PrivateLinkServiceConnectionStatus = "Approved" // PrivateLinkServiceConnectionStatusDisconnected - Disconnected PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected" // PrivateLinkServiceConnectionStatusPending - Pending PrivateLinkServiceConnectionStatusPending PrivateLinkServiceConnectionStatus = "Pending" // PrivateLinkServiceConnectionStatusRejected - Rejected PrivateLinkServiceConnectionStatusRejected PrivateLinkServiceConnectionStatus = "Rejected" ) // PossiblePrivateLinkServiceConnectionStatusValues returns the possible values for the PrivateLinkServiceConnectionStatus const type. func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus { return []PrivateLinkServiceConnectionStatus{ PrivateLinkServiceConnectionStatusApproved, PrivateLinkServiceConnectionStatusDisconnected, PrivateLinkServiceConnectionStatusPending, PrivateLinkServiceConnectionStatusRejected, } } // PublicNetworkAccess - Whether requests from Public Network are allowed type PublicNetworkAccess string const ( // PublicNetworkAccessDisabled - Disabled PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled" // PublicNetworkAccessEnabled - Enabled PublicNetworkAccessEnabled PublicNetworkAccess = "Enabled" ) // PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type. func PossiblePublicNetworkAccessValues() []PublicNetworkAccess { return []PublicNetworkAccess{ PublicNetworkAccessDisabled, PublicNetworkAccessEnabled, } } // ResourceIdentityType - 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 ResourceIdentityType string const ( // ResourceIdentityTypeNone - None ResourceIdentityTypeNone ResourceIdentityType = "None" // ResourceIdentityTypeSystemAssigned - SystemAssigned ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned" // ResourceIdentityTypeSystemAssignedUserAssigned - SystemAssigned, UserAssigned ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned" // ResourceIdentityTypeUserAssigned - UserAssigned ResourceIdentityTypeUserAssigned ResourceIdentityType = "UserAssigned" ) // PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type. func PossibleResourceIdentityTypeValues() []ResourceIdentityType { return []ResourceIdentityType{ ResourceIdentityTypeNone, ResourceIdentityTypeSystemAssigned, ResourceIdentityTypeSystemAssignedUserAssigned, ResourceIdentityTypeUserAssigned, } } // RouteErrorSeverity - Severity of the route error type RouteErrorSeverity string const ( // RouteErrorSeverityError - error RouteErrorSeverityError RouteErrorSeverity = "error" // RouteErrorSeverityWarning - warning RouteErrorSeverityWarning RouteErrorSeverity = "warning" ) // PossibleRouteErrorSeverityValues returns the possible values for the RouteErrorSeverity const type. func PossibleRouteErrorSeverityValues() []RouteErrorSeverity { return []RouteErrorSeverity{ RouteErrorSeverityError, RouteErrorSeverityWarning, } } // RoutingSource - The source that the routing rule is to be applied to, such as DeviceMessages. type RoutingSource string const ( // RoutingSourceDeviceConnectionStateEvents - DeviceConnectionStateEvents RoutingSourceDeviceConnectionStateEvents RoutingSource = "DeviceConnectionStateEvents" // RoutingSourceDeviceJobLifecycleEvents - DeviceJobLifecycleEvents RoutingSourceDeviceJobLifecycleEvents RoutingSource = "DeviceJobLifecycleEvents" // RoutingSourceDeviceLifecycleEvents - DeviceLifecycleEvents RoutingSourceDeviceLifecycleEvents RoutingSource = "DeviceLifecycleEvents" // RoutingSourceDeviceMessages - DeviceMessages RoutingSourceDeviceMessages RoutingSource = "DeviceMessages" // RoutingSourceDigitalTwinChangeEvents - DigitalTwinChangeEvents RoutingSourceDigitalTwinChangeEvents RoutingSource = "DigitalTwinChangeEvents" // RoutingSourceInvalid - Invalid RoutingSourceInvalid RoutingSource = "Invalid" // RoutingSourceMqttBrokerMessages - MqttBrokerMessages RoutingSourceMqttBrokerMessages RoutingSource = "MqttBrokerMessages" // RoutingSourceTwinChangeEvents - TwinChangeEvents RoutingSourceTwinChangeEvents RoutingSource = "TwinChangeEvents" ) // PossibleRoutingSourceValues returns the possible values for the RoutingSource const type. func PossibleRoutingSourceValues() []RoutingSource { return []RoutingSource{ RoutingSourceDeviceConnectionStateEvents, RoutingSourceDeviceJobLifecycleEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceMessages, RoutingSourceDigitalTwinChangeEvents, RoutingSourceInvalid, RoutingSourceMqttBrokerMessages, RoutingSourceTwinChangeEvents, } } // RoutingStorageContainerPropertiesEncoding - Encoding that is used to serialize messages to blobs. Supported values are // 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. type RoutingStorageContainerPropertiesEncoding string const ( // RoutingStorageContainerPropertiesEncodingAvro - Avro RoutingStorageContainerPropertiesEncodingAvro RoutingStorageContainerPropertiesEncoding = "Avro" // RoutingStorageContainerPropertiesEncodingAvroDeflate - AvroDeflate RoutingStorageContainerPropertiesEncodingAvroDeflate RoutingStorageContainerPropertiesEncoding = "AvroDeflate" // RoutingStorageContainerPropertiesEncodingJSON - JSON RoutingStorageContainerPropertiesEncodingJSON RoutingStorageContainerPropertiesEncoding = "JSON" ) // PossibleRoutingStorageContainerPropertiesEncodingValues returns the possible values for the RoutingStorageContainerPropertiesEncoding const type. func PossibleRoutingStorageContainerPropertiesEncodingValues() []RoutingStorageContainerPropertiesEncoding { return []RoutingStorageContainerPropertiesEncoding{ RoutingStorageContainerPropertiesEncodingAvro, RoutingStorageContainerPropertiesEncodingAvroDeflate, RoutingStorageContainerPropertiesEncodingJSON, } } // TestResultStatus - Result of testing route type TestResultStatus string const ( // TestResultStatusFalse - false TestResultStatusFalse TestResultStatus = "false" // TestResultStatusTrue - true TestResultStatusTrue TestResultStatus = "true" // TestResultStatusUndefined - undefined TestResultStatusUndefined TestResultStatus = "undefined" ) // PossibleTestResultStatusValues returns the possible values for the TestResultStatus const type. func PossibleTestResultStatusValues() []TestResultStatus { return []TestResultStatus{ TestResultStatusFalse, TestResultStatusTrue, TestResultStatusUndefined, } }