enums.go

Documentation: github.com/Azure/azure-sdk-for-go/services/iothub/mgmt/2021-07-02/devices

     1  package devices
     2  
     3  // Copyright (c) Microsoft Corporation. All rights reserved.
     4  // Licensed under the MIT License. See License.txt in the project root for license information.
     5  //
     6  // Code generated by Microsoft (R) AutoRest Code Generator.
     7  // Changes may cause incorrect behavior and will be lost if the code is regenerated.
     8  
     9  // AccessRights enumerates the values for access rights.
    10  type AccessRights string
    11  
    12  const (
    13  	// AccessRightsDeviceConnect ...
    14  	AccessRightsDeviceConnect AccessRights = "DeviceConnect"
    15  	// AccessRightsRegistryRead ...
    16  	AccessRightsRegistryRead AccessRights = "RegistryRead"
    17  	// AccessRightsRegistryReadDeviceConnect ...
    18  	AccessRightsRegistryReadDeviceConnect AccessRights = "RegistryRead, DeviceConnect"
    19  	// AccessRightsRegistryReadRegistryWrite ...
    20  	AccessRightsRegistryReadRegistryWrite AccessRights = "RegistryRead, RegistryWrite"
    21  	// AccessRightsRegistryReadRegistryWriteDeviceConnect ...
    22  	AccessRightsRegistryReadRegistryWriteDeviceConnect AccessRights = "RegistryRead, RegistryWrite, DeviceConnect"
    23  	// AccessRightsRegistryReadRegistryWriteServiceConnect ...
    24  	AccessRightsRegistryReadRegistryWriteServiceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect"
    25  	// AccessRightsRegistryReadRegistryWriteServiceConnectDeviceConnect ...
    26  	AccessRightsRegistryReadRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect"
    27  	// AccessRightsRegistryReadServiceConnect ...
    28  	AccessRightsRegistryReadServiceConnect AccessRights = "RegistryRead, ServiceConnect"
    29  	// AccessRightsRegistryReadServiceConnectDeviceConnect ...
    30  	AccessRightsRegistryReadServiceConnectDeviceConnect AccessRights = "RegistryRead, ServiceConnect, DeviceConnect"
    31  	// AccessRightsRegistryWrite ...
    32  	AccessRightsRegistryWrite AccessRights = "RegistryWrite"
    33  	// AccessRightsRegistryWriteDeviceConnect ...
    34  	AccessRightsRegistryWriteDeviceConnect AccessRights = "RegistryWrite, DeviceConnect"
    35  	// AccessRightsRegistryWriteServiceConnect ...
    36  	AccessRightsRegistryWriteServiceConnect AccessRights = "RegistryWrite, ServiceConnect"
    37  	// AccessRightsRegistryWriteServiceConnectDeviceConnect ...
    38  	AccessRightsRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryWrite, ServiceConnect, DeviceConnect"
    39  	// AccessRightsServiceConnect ...
    40  	AccessRightsServiceConnect AccessRights = "ServiceConnect"
    41  	// AccessRightsServiceConnectDeviceConnect ...
    42  	AccessRightsServiceConnectDeviceConnect AccessRights = "ServiceConnect, DeviceConnect"
    43  )
    44  
    45  // PossibleAccessRightsValues returns an array of possible values for the AccessRights const type.
    46  func PossibleAccessRightsValues() []AccessRights {
    47  	return []AccessRights{AccessRightsDeviceConnect, AccessRightsRegistryRead, AccessRightsRegistryReadDeviceConnect, AccessRightsRegistryReadRegistryWrite, AccessRightsRegistryReadRegistryWriteDeviceConnect, AccessRightsRegistryReadRegistryWriteServiceConnect, AccessRightsRegistryReadRegistryWriteServiceConnectDeviceConnect, AccessRightsRegistryReadServiceConnect, AccessRightsRegistryReadServiceConnectDeviceConnect, AccessRightsRegistryWrite, AccessRightsRegistryWriteDeviceConnect, AccessRightsRegistryWriteServiceConnect, AccessRightsRegistryWriteServiceConnectDeviceConnect, AccessRightsServiceConnect, AccessRightsServiceConnectDeviceConnect}
    48  }
    49  
    50  // AuthenticationType enumerates the values for authentication type.
    51  type AuthenticationType string
    52  
    53  const (
    54  	// AuthenticationTypeIdentityBased ...
    55  	AuthenticationTypeIdentityBased AuthenticationType = "identityBased"
    56  	// AuthenticationTypeKeyBased ...
    57  	AuthenticationTypeKeyBased AuthenticationType = "keyBased"
    58  )
    59  
    60  // PossibleAuthenticationTypeValues returns an array of possible values for the AuthenticationType const type.
    61  func PossibleAuthenticationTypeValues() []AuthenticationType {
    62  	return []AuthenticationType{AuthenticationTypeIdentityBased, AuthenticationTypeKeyBased}
    63  }
    64  
    65  // Capabilities enumerates the values for capabilities.
    66  type Capabilities string
    67  
    68  const (
    69  	// CapabilitiesDeviceManagement ...
    70  	CapabilitiesDeviceManagement Capabilities = "DeviceManagement"
    71  	// CapabilitiesNone ...
    72  	CapabilitiesNone Capabilities = "None"
    73  )
    74  
    75  // PossibleCapabilitiesValues returns an array of possible values for the Capabilities const type.
    76  func PossibleCapabilitiesValues() []Capabilities {
    77  	return []Capabilities{CapabilitiesDeviceManagement, CapabilitiesNone}
    78  }
    79  
    80  // CreatedByType enumerates the values for created by type.
    81  type CreatedByType string
    82  
    83  const (
    84  	// CreatedByTypeApplication ...
    85  	CreatedByTypeApplication CreatedByType = "Application"
    86  	// CreatedByTypeKey ...
    87  	CreatedByTypeKey CreatedByType = "Key"
    88  	// CreatedByTypeManagedIdentity ...
    89  	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
    90  	// CreatedByTypeUser ...
    91  	CreatedByTypeUser CreatedByType = "User"
    92  )
    93  
    94  // PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.
    95  func PossibleCreatedByTypeValues() []CreatedByType {
    96  	return []CreatedByType{CreatedByTypeApplication, CreatedByTypeKey, CreatedByTypeManagedIdentity, CreatedByTypeUser}
    97  }
    98  
    99  // DefaultAction enumerates the values for default action.
   100  type DefaultAction string
   101  
   102  const (
   103  	// DefaultActionAllow ...
   104  	DefaultActionAllow DefaultAction = "Allow"
   105  	// DefaultActionDeny ...
   106  	DefaultActionDeny DefaultAction = "Deny"
   107  )
   108  
   109  // PossibleDefaultActionValues returns an array of possible values for the DefaultAction const type.
   110  func PossibleDefaultActionValues() []DefaultAction {
   111  	return []DefaultAction{DefaultActionAllow, DefaultActionDeny}
   112  }
   113  
   114  // Encoding enumerates the values for encoding.
   115  type Encoding string
   116  
   117  const (
   118  	// EncodingAvro ...
   119  	EncodingAvro Encoding = "Avro"
   120  	// EncodingAvroDeflate ...
   121  	EncodingAvroDeflate Encoding = "AvroDeflate"
   122  	// EncodingJSON ...
   123  	EncodingJSON Encoding = "JSON"
   124  )
   125  
   126  // PossibleEncodingValues returns an array of possible values for the Encoding const type.
   127  func PossibleEncodingValues() []Encoding {
   128  	return []Encoding{EncodingAvro, EncodingAvroDeflate, EncodingJSON}
   129  }
   130  
   131  // EndpointHealthStatus enumerates the values for endpoint health status.
   132  type EndpointHealthStatus string
   133  
   134  const (
   135  	// EndpointHealthStatusDead ...
   136  	EndpointHealthStatusDead EndpointHealthStatus = "dead"
   137  	// EndpointHealthStatusDegraded ...
   138  	EndpointHealthStatusDegraded EndpointHealthStatus = "degraded"
   139  	// EndpointHealthStatusHealthy ...
   140  	EndpointHealthStatusHealthy EndpointHealthStatus = "healthy"
   141  	// EndpointHealthStatusUnhealthy ...
   142  	EndpointHealthStatusUnhealthy EndpointHealthStatus = "unhealthy"
   143  	// EndpointHealthStatusUnknown ...
   144  	EndpointHealthStatusUnknown EndpointHealthStatus = "unknown"
   145  )
   146  
   147  // PossibleEndpointHealthStatusValues returns an array of possible values for the EndpointHealthStatus const type.
   148  func PossibleEndpointHealthStatusValues() []EndpointHealthStatus {
   149  	return []EndpointHealthStatus{EndpointHealthStatusDead, EndpointHealthStatusDegraded, EndpointHealthStatusHealthy, EndpointHealthStatusUnhealthy, EndpointHealthStatusUnknown}
   150  }
   151  
   152  // IotHubNameUnavailabilityReason enumerates the values for iot hub name unavailability reason.
   153  type IotHubNameUnavailabilityReason string
   154  
   155  const (
   156  	// IotHubNameUnavailabilityReasonAlreadyExists ...
   157  	IotHubNameUnavailabilityReasonAlreadyExists IotHubNameUnavailabilityReason = "AlreadyExists"
   158  	// IotHubNameUnavailabilityReasonInvalid ...
   159  	IotHubNameUnavailabilityReasonInvalid IotHubNameUnavailabilityReason = "Invalid"
   160  )
   161  
   162  // PossibleIotHubNameUnavailabilityReasonValues returns an array of possible values for the IotHubNameUnavailabilityReason const type.
   163  func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason {
   164  	return []IotHubNameUnavailabilityReason{IotHubNameUnavailabilityReasonAlreadyExists, IotHubNameUnavailabilityReasonInvalid}
   165  }
   166  
   167  // IotHubReplicaRoleType enumerates the values for iot hub replica role type.
   168  type IotHubReplicaRoleType string
   169  
   170  const (
   171  	// IotHubReplicaRoleTypePrimary ...
   172  	IotHubReplicaRoleTypePrimary IotHubReplicaRoleType = "primary"
   173  	// IotHubReplicaRoleTypeSecondary ...
   174  	IotHubReplicaRoleTypeSecondary IotHubReplicaRoleType = "secondary"
   175  )
   176  
   177  // PossibleIotHubReplicaRoleTypeValues returns an array of possible values for the IotHubReplicaRoleType const type.
   178  func PossibleIotHubReplicaRoleTypeValues() []IotHubReplicaRoleType {
   179  	return []IotHubReplicaRoleType{IotHubReplicaRoleTypePrimary, IotHubReplicaRoleTypeSecondary}
   180  }
   181  
   182  // IotHubScaleType enumerates the values for iot hub scale type.
   183  type IotHubScaleType string
   184  
   185  const (
   186  	// IotHubScaleTypeAutomatic ...
   187  	IotHubScaleTypeAutomatic IotHubScaleType = "Automatic"
   188  	// IotHubScaleTypeManual ...
   189  	IotHubScaleTypeManual IotHubScaleType = "Manual"
   190  	// IotHubScaleTypeNone ...
   191  	IotHubScaleTypeNone IotHubScaleType = "None"
   192  )
   193  
   194  // PossibleIotHubScaleTypeValues returns an array of possible values for the IotHubScaleType const type.
   195  func PossibleIotHubScaleTypeValues() []IotHubScaleType {
   196  	return []IotHubScaleType{IotHubScaleTypeAutomatic, IotHubScaleTypeManual, IotHubScaleTypeNone}
   197  }
   198  
   199  // IotHubSku enumerates the values for iot hub sku.
   200  type IotHubSku string
   201  
   202  const (
   203  	// IotHubSkuB1 ...
   204  	IotHubSkuB1 IotHubSku = "B1"
   205  	// IotHubSkuB2 ...
   206  	IotHubSkuB2 IotHubSku = "B2"
   207  	// IotHubSkuB3 ...
   208  	IotHubSkuB3 IotHubSku = "B3"
   209  	// IotHubSkuF1 ...
   210  	IotHubSkuF1 IotHubSku = "F1"
   211  	// IotHubSkuS1 ...
   212  	IotHubSkuS1 IotHubSku = "S1"
   213  	// IotHubSkuS2 ...
   214  	IotHubSkuS2 IotHubSku = "S2"
   215  	// IotHubSkuS3 ...
   216  	IotHubSkuS3 IotHubSku = "S3"
   217  )
   218  
   219  // PossibleIotHubSkuValues returns an array of possible values for the IotHubSku const type.
   220  func PossibleIotHubSkuValues() []IotHubSku {
   221  	return []IotHubSku{IotHubSkuB1, IotHubSkuB2, IotHubSkuB3, IotHubSkuF1, IotHubSkuS1, IotHubSkuS2, IotHubSkuS3}
   222  }
   223  
   224  // IotHubSkuTier enumerates the values for iot hub sku tier.
   225  type IotHubSkuTier string
   226  
   227  const (
   228  	// IotHubSkuTierBasic ...
   229  	IotHubSkuTierBasic IotHubSkuTier = "Basic"
   230  	// IotHubSkuTierFree ...
   231  	IotHubSkuTierFree IotHubSkuTier = "Free"
   232  	// IotHubSkuTierStandard ...
   233  	IotHubSkuTierStandard IotHubSkuTier = "Standard"
   234  )
   235  
   236  // PossibleIotHubSkuTierValues returns an array of possible values for the IotHubSkuTier const type.
   237  func PossibleIotHubSkuTierValues() []IotHubSkuTier {
   238  	return []IotHubSkuTier{IotHubSkuTierBasic, IotHubSkuTierFree, IotHubSkuTierStandard}
   239  }
   240  
   241  // IPFilterActionType enumerates the values for ip filter action type.
   242  type IPFilterActionType string
   243  
   244  const (
   245  	// IPFilterActionTypeAccept ...
   246  	IPFilterActionTypeAccept IPFilterActionType = "Accept"
   247  	// IPFilterActionTypeReject ...
   248  	IPFilterActionTypeReject IPFilterActionType = "Reject"
   249  )
   250  
   251  // PossibleIPFilterActionTypeValues returns an array of possible values for the IPFilterActionType const type.
   252  func PossibleIPFilterActionTypeValues() []IPFilterActionType {
   253  	return []IPFilterActionType{IPFilterActionTypeAccept, IPFilterActionTypeReject}
   254  }
   255  
   256  // JobStatus enumerates the values for job status.
   257  type JobStatus string
   258  
   259  const (
   260  	// JobStatusCancelled ...
   261  	JobStatusCancelled JobStatus = "cancelled"
   262  	// JobStatusCompleted ...
   263  	JobStatusCompleted JobStatus = "completed"
   264  	// JobStatusEnqueued ...
   265  	JobStatusEnqueued JobStatus = "enqueued"
   266  	// JobStatusFailed ...
   267  	JobStatusFailed JobStatus = "failed"
   268  	// JobStatusRunning ...
   269  	JobStatusRunning JobStatus = "running"
   270  	// JobStatusUnknown ...
   271  	JobStatusUnknown JobStatus = "unknown"
   272  )
   273  
   274  // PossibleJobStatusValues returns an array of possible values for the JobStatus const type.
   275  func PossibleJobStatusValues() []JobStatus {
   276  	return []JobStatus{JobStatusCancelled, JobStatusCompleted, JobStatusEnqueued, JobStatusFailed, JobStatusRunning, JobStatusUnknown}
   277  }
   278  
   279  // JobType enumerates the values for job type.
   280  type JobType string
   281  
   282  const (
   283  	// JobTypeBackup ...
   284  	JobTypeBackup JobType = "backup"
   285  	// JobTypeExport ...
   286  	JobTypeExport JobType = "export"
   287  	// JobTypeFactoryResetDevice ...
   288  	JobTypeFactoryResetDevice JobType = "factoryResetDevice"
   289  	// JobTypeFirmwareUpdate ...
   290  	JobTypeFirmwareUpdate JobType = "firmwareUpdate"
   291  	// JobTypeImport ...
   292  	JobTypeImport JobType = "import"
   293  	// JobTypeReadDeviceProperties ...
   294  	JobTypeReadDeviceProperties JobType = "readDeviceProperties"
   295  	// JobTypeRebootDevice ...
   296  	JobTypeRebootDevice JobType = "rebootDevice"
   297  	// JobTypeUnknown ...
   298  	JobTypeUnknown JobType = "unknown"
   299  	// JobTypeUpdateDeviceConfiguration ...
   300  	JobTypeUpdateDeviceConfiguration JobType = "updateDeviceConfiguration"
   301  	// JobTypeWriteDeviceProperties ...
   302  	JobTypeWriteDeviceProperties JobType = "writeDeviceProperties"
   303  )
   304  
   305  // PossibleJobTypeValues returns an array of possible values for the JobType const type.
   306  func PossibleJobTypeValues() []JobType {
   307  	return []JobType{JobTypeBackup, JobTypeExport, JobTypeFactoryResetDevice, JobTypeFirmwareUpdate, JobTypeImport, JobTypeReadDeviceProperties, JobTypeRebootDevice, JobTypeUnknown, JobTypeUpdateDeviceConfiguration, JobTypeWriteDeviceProperties}
   308  }
   309  
   310  // NetworkRuleIPAction enumerates the values for network rule ip action.
   311  type NetworkRuleIPAction string
   312  
   313  const (
   314  	// NetworkRuleIPActionAllow ...
   315  	NetworkRuleIPActionAllow NetworkRuleIPAction = "Allow"
   316  )
   317  
   318  // PossibleNetworkRuleIPActionValues returns an array of possible values for the NetworkRuleIPAction const type.
   319  func PossibleNetworkRuleIPActionValues() []NetworkRuleIPAction {
   320  	return []NetworkRuleIPAction{NetworkRuleIPActionAllow}
   321  }
   322  
   323  // PrivateLinkServiceConnectionStatus enumerates the values for private link service connection status.
   324  type PrivateLinkServiceConnectionStatus string
   325  
   326  const (
   327  	// PrivateLinkServiceConnectionStatusApproved ...
   328  	PrivateLinkServiceConnectionStatusApproved PrivateLinkServiceConnectionStatus = "Approved"
   329  	// PrivateLinkServiceConnectionStatusDisconnected ...
   330  	PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
   331  	// PrivateLinkServiceConnectionStatusPending ...
   332  	PrivateLinkServiceConnectionStatusPending PrivateLinkServiceConnectionStatus = "Pending"
   333  	// PrivateLinkServiceConnectionStatusRejected ...
   334  	PrivateLinkServiceConnectionStatusRejected PrivateLinkServiceConnectionStatus = "Rejected"
   335  )
   336  
   337  // PossiblePrivateLinkServiceConnectionStatusValues returns an array of possible values for the PrivateLinkServiceConnectionStatus const type.
   338  func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus {
   339  	return []PrivateLinkServiceConnectionStatus{PrivateLinkServiceConnectionStatusApproved, PrivateLinkServiceConnectionStatusDisconnected, PrivateLinkServiceConnectionStatusPending, PrivateLinkServiceConnectionStatusRejected}
   340  }
   341  
   342  // PublicNetworkAccess enumerates the values for public network access.
   343  type PublicNetworkAccess string
   344  
   345  const (
   346  	// PublicNetworkAccessDisabled ...
   347  	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
   348  	// PublicNetworkAccessEnabled ...
   349  	PublicNetworkAccessEnabled PublicNetworkAccess = "Enabled"
   350  )
   351  
   352  // PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.
   353  func PossiblePublicNetworkAccessValues() []PublicNetworkAccess {
   354  	return []PublicNetworkAccess{PublicNetworkAccessDisabled, PublicNetworkAccessEnabled}
   355  }
   356  
   357  // ResourceIdentityType enumerates the values for resource identity type.
   358  type ResourceIdentityType string
   359  
   360  const (
   361  	// ResourceIdentityTypeNone ...
   362  	ResourceIdentityTypeNone ResourceIdentityType = "None"
   363  	// ResourceIdentityTypeSystemAssigned ...
   364  	ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
   365  	// ResourceIdentityTypeSystemAssignedUserAssigned ...
   366  	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
   367  	// ResourceIdentityTypeUserAssigned ...
   368  	ResourceIdentityTypeUserAssigned ResourceIdentityType = "UserAssigned"
   369  )
   370  
   371  // PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.
   372  func PossibleResourceIdentityTypeValues() []ResourceIdentityType {
   373  	return []ResourceIdentityType{ResourceIdentityTypeNone, ResourceIdentityTypeSystemAssigned, ResourceIdentityTypeSystemAssignedUserAssigned, ResourceIdentityTypeUserAssigned}
   374  }
   375  
   376  // RouteErrorSeverity enumerates the values for route error severity.
   377  type RouteErrorSeverity string
   378  
   379  const (
   380  	// RouteErrorSeverityError ...
   381  	RouteErrorSeverityError RouteErrorSeverity = "error"
   382  	// RouteErrorSeverityWarning ...
   383  	RouteErrorSeverityWarning RouteErrorSeverity = "warning"
   384  )
   385  
   386  // PossibleRouteErrorSeverityValues returns an array of possible values for the RouteErrorSeverity const type.
   387  func PossibleRouteErrorSeverityValues() []RouteErrorSeverity {
   388  	return []RouteErrorSeverity{RouteErrorSeverityError, RouteErrorSeverityWarning}
   389  }
   390  
   391  // RoutingSource enumerates the values for routing source.
   392  type RoutingSource string
   393  
   394  const (
   395  	// RoutingSourceDeviceConnectionStateEvents ...
   396  	RoutingSourceDeviceConnectionStateEvents RoutingSource = "DeviceConnectionStateEvents"
   397  	// RoutingSourceDeviceJobLifecycleEvents ...
   398  	RoutingSourceDeviceJobLifecycleEvents RoutingSource = "DeviceJobLifecycleEvents"
   399  	// RoutingSourceDeviceLifecycleEvents ...
   400  	RoutingSourceDeviceLifecycleEvents RoutingSource = "DeviceLifecycleEvents"
   401  	// RoutingSourceDeviceMessages ...
   402  	RoutingSourceDeviceMessages RoutingSource = "DeviceMessages"
   403  	// RoutingSourceInvalid ...
   404  	RoutingSourceInvalid RoutingSource = "Invalid"
   405  	// RoutingSourceTwinChangeEvents ...
   406  	RoutingSourceTwinChangeEvents RoutingSource = "TwinChangeEvents"
   407  )
   408  
   409  // PossibleRoutingSourceValues returns an array of possible values for the RoutingSource const type.
   410  func PossibleRoutingSourceValues() []RoutingSource {
   411  	return []RoutingSource{RoutingSourceDeviceConnectionStateEvents, RoutingSourceDeviceJobLifecycleEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceMessages, RoutingSourceInvalid, RoutingSourceTwinChangeEvents}
   412  }
   413  
   414  // TestResultStatus enumerates the values for test result status.
   415  type TestResultStatus string
   416  
   417  const (
   418  	// TestResultStatusFalse ...
   419  	TestResultStatusFalse TestResultStatus = "false"
   420  	// TestResultStatusTrue ...
   421  	TestResultStatusTrue TestResultStatus = "true"
   422  	// TestResultStatusUndefined ...
   423  	TestResultStatusUndefined TestResultStatus = "undefined"
   424  )
   425  
   426  // PossibleTestResultStatusValues returns an array of possible values for the TestResultStatus const type.
   427  func PossibleTestResultStatusValues() []TestResultStatus {
   428  	return []TestResultStatus{TestResultStatusFalse, TestResultStatusTrue, TestResultStatusUndefined}
   429  }
   430
View as plain text