enums.go

Documentation: github.com/Azure/azure-sdk-for-go/services/preview/iothub/mgmt/2021-03-03-preview/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  // DefaultAction enumerates the values for default action.
    81  type DefaultAction string
    82  
    83  const (
    84  	// DefaultActionAllow ...
    85  	DefaultActionAllow DefaultAction = "Allow"
    86  	// DefaultActionDeny ...
    87  	DefaultActionDeny DefaultAction = "Deny"
    88  )
    89  
    90  // PossibleDefaultActionValues returns an array of possible values for the DefaultAction const type.
    91  func PossibleDefaultActionValues() []DefaultAction {
    92  	return []DefaultAction{DefaultActionAllow, DefaultActionDeny}
    93  }
    94  
    95  // Encoding enumerates the values for encoding.
    96  type Encoding string
    97  
    98  const (
    99  	// EncodingAvro ...
   100  	EncodingAvro Encoding = "Avro"
   101  	// EncodingAvroDeflate ...
   102  	EncodingAvroDeflate Encoding = "AvroDeflate"
   103  	// EncodingJSON ...
   104  	EncodingJSON Encoding = "JSON"
   105  )
   106  
   107  // PossibleEncodingValues returns an array of possible values for the Encoding const type.
   108  func PossibleEncodingValues() []Encoding {
   109  	return []Encoding{EncodingAvro, EncodingAvroDeflate, EncodingJSON}
   110  }
   111  
   112  // EndpointHealthStatus enumerates the values for endpoint health status.
   113  type EndpointHealthStatus string
   114  
   115  const (
   116  	// EndpointHealthStatusDead ...
   117  	EndpointHealthStatusDead EndpointHealthStatus = "dead"
   118  	// EndpointHealthStatusDegraded ...
   119  	EndpointHealthStatusDegraded EndpointHealthStatus = "degraded"
   120  	// EndpointHealthStatusHealthy ...
   121  	EndpointHealthStatusHealthy EndpointHealthStatus = "healthy"
   122  	// EndpointHealthStatusUnhealthy ...
   123  	EndpointHealthStatusUnhealthy EndpointHealthStatus = "unhealthy"
   124  	// EndpointHealthStatusUnknown ...
   125  	EndpointHealthStatusUnknown EndpointHealthStatus = "unknown"
   126  )
   127  
   128  // PossibleEndpointHealthStatusValues returns an array of possible values for the EndpointHealthStatus const type.
   129  func PossibleEndpointHealthStatusValues() []EndpointHealthStatus {
   130  	return []EndpointHealthStatus{EndpointHealthStatusDead, EndpointHealthStatusDegraded, EndpointHealthStatusHealthy, EndpointHealthStatusUnhealthy, EndpointHealthStatusUnknown}
   131  }
   132  
   133  // IotHubNameUnavailabilityReason enumerates the values for iot hub name unavailability reason.
   134  type IotHubNameUnavailabilityReason string
   135  
   136  const (
   137  	// IotHubNameUnavailabilityReasonAlreadyExists ...
   138  	IotHubNameUnavailabilityReasonAlreadyExists IotHubNameUnavailabilityReason = "AlreadyExists"
   139  	// IotHubNameUnavailabilityReasonInvalid ...
   140  	IotHubNameUnavailabilityReasonInvalid IotHubNameUnavailabilityReason = "Invalid"
   141  )
   142  
   143  // PossibleIotHubNameUnavailabilityReasonValues returns an array of possible values for the IotHubNameUnavailabilityReason const type.
   144  func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason {
   145  	return []IotHubNameUnavailabilityReason{IotHubNameUnavailabilityReasonAlreadyExists, IotHubNameUnavailabilityReasonInvalid}
   146  }
   147  
   148  // IotHubReplicaRoleType enumerates the values for iot hub replica role type.
   149  type IotHubReplicaRoleType string
   150  
   151  const (
   152  	// IotHubReplicaRoleTypePrimary ...
   153  	IotHubReplicaRoleTypePrimary IotHubReplicaRoleType = "primary"
   154  	// IotHubReplicaRoleTypeSecondary ...
   155  	IotHubReplicaRoleTypeSecondary IotHubReplicaRoleType = "secondary"
   156  )
   157  
   158  // PossibleIotHubReplicaRoleTypeValues returns an array of possible values for the IotHubReplicaRoleType const type.
   159  func PossibleIotHubReplicaRoleTypeValues() []IotHubReplicaRoleType {
   160  	return []IotHubReplicaRoleType{IotHubReplicaRoleTypePrimary, IotHubReplicaRoleTypeSecondary}
   161  }
   162  
   163  // IotHubScaleType enumerates the values for iot hub scale type.
   164  type IotHubScaleType string
   165  
   166  const (
   167  	// IotHubScaleTypeAutomatic ...
   168  	IotHubScaleTypeAutomatic IotHubScaleType = "Automatic"
   169  	// IotHubScaleTypeManual ...
   170  	IotHubScaleTypeManual IotHubScaleType = "Manual"
   171  	// IotHubScaleTypeNone ...
   172  	IotHubScaleTypeNone IotHubScaleType = "None"
   173  )
   174  
   175  // PossibleIotHubScaleTypeValues returns an array of possible values for the IotHubScaleType const type.
   176  func PossibleIotHubScaleTypeValues() []IotHubScaleType {
   177  	return []IotHubScaleType{IotHubScaleTypeAutomatic, IotHubScaleTypeManual, IotHubScaleTypeNone}
   178  }
   179  
   180  // IotHubSku enumerates the values for iot hub sku.
   181  type IotHubSku string
   182  
   183  const (
   184  	// IotHubSkuB1 ...
   185  	IotHubSkuB1 IotHubSku = "B1"
   186  	// IotHubSkuB2 ...
   187  	IotHubSkuB2 IotHubSku = "B2"
   188  	// IotHubSkuB3 ...
   189  	IotHubSkuB3 IotHubSku = "B3"
   190  	// IotHubSkuF1 ...
   191  	IotHubSkuF1 IotHubSku = "F1"
   192  	// IotHubSkuS1 ...
   193  	IotHubSkuS1 IotHubSku = "S1"
   194  	// IotHubSkuS2 ...
   195  	IotHubSkuS2 IotHubSku = "S2"
   196  	// IotHubSkuS3 ...
   197  	IotHubSkuS3 IotHubSku = "S3"
   198  )
   199  
   200  // PossibleIotHubSkuValues returns an array of possible values for the IotHubSku const type.
   201  func PossibleIotHubSkuValues() []IotHubSku {
   202  	return []IotHubSku{IotHubSkuB1, IotHubSkuB2, IotHubSkuB3, IotHubSkuF1, IotHubSkuS1, IotHubSkuS2, IotHubSkuS3}
   203  }
   204  
   205  // IotHubSkuTier enumerates the values for iot hub sku tier.
   206  type IotHubSkuTier string
   207  
   208  const (
   209  	// IotHubSkuTierBasic ...
   210  	IotHubSkuTierBasic IotHubSkuTier = "Basic"
   211  	// IotHubSkuTierFree ...
   212  	IotHubSkuTierFree IotHubSkuTier = "Free"
   213  	// IotHubSkuTierStandard ...
   214  	IotHubSkuTierStandard IotHubSkuTier = "Standard"
   215  )
   216  
   217  // PossibleIotHubSkuTierValues returns an array of possible values for the IotHubSkuTier const type.
   218  func PossibleIotHubSkuTierValues() []IotHubSkuTier {
   219  	return []IotHubSkuTier{IotHubSkuTierBasic, IotHubSkuTierFree, IotHubSkuTierStandard}
   220  }
   221  
   222  // IPFilterActionType enumerates the values for ip filter action type.
   223  type IPFilterActionType string
   224  
   225  const (
   226  	// IPFilterActionTypeAccept ...
   227  	IPFilterActionTypeAccept IPFilterActionType = "Accept"
   228  	// IPFilterActionTypeReject ...
   229  	IPFilterActionTypeReject IPFilterActionType = "Reject"
   230  )
   231  
   232  // PossibleIPFilterActionTypeValues returns an array of possible values for the IPFilterActionType const type.
   233  func PossibleIPFilterActionTypeValues() []IPFilterActionType {
   234  	return []IPFilterActionType{IPFilterActionTypeAccept, IPFilterActionTypeReject}
   235  }
   236  
   237  // JobStatus enumerates the values for job status.
   238  type JobStatus string
   239  
   240  const (
   241  	// JobStatusCancelled ...
   242  	JobStatusCancelled JobStatus = "cancelled"
   243  	// JobStatusCompleted ...
   244  	JobStatusCompleted JobStatus = "completed"
   245  	// JobStatusEnqueued ...
   246  	JobStatusEnqueued JobStatus = "enqueued"
   247  	// JobStatusFailed ...
   248  	JobStatusFailed JobStatus = "failed"
   249  	// JobStatusRunning ...
   250  	JobStatusRunning JobStatus = "running"
   251  	// JobStatusUnknown ...
   252  	JobStatusUnknown JobStatus = "unknown"
   253  )
   254  
   255  // PossibleJobStatusValues returns an array of possible values for the JobStatus const type.
   256  func PossibleJobStatusValues() []JobStatus {
   257  	return []JobStatus{JobStatusCancelled, JobStatusCompleted, JobStatusEnqueued, JobStatusFailed, JobStatusRunning, JobStatusUnknown}
   258  }
   259  
   260  // JobType enumerates the values for job type.
   261  type JobType string
   262  
   263  const (
   264  	// JobTypeBackup ...
   265  	JobTypeBackup JobType = "backup"
   266  	// JobTypeExport ...
   267  	JobTypeExport JobType = "export"
   268  	// JobTypeFactoryResetDevice ...
   269  	JobTypeFactoryResetDevice JobType = "factoryResetDevice"
   270  	// JobTypeFirmwareUpdate ...
   271  	JobTypeFirmwareUpdate JobType = "firmwareUpdate"
   272  	// JobTypeImport ...
   273  	JobTypeImport JobType = "import"
   274  	// JobTypeReadDeviceProperties ...
   275  	JobTypeReadDeviceProperties JobType = "readDeviceProperties"
   276  	// JobTypeRebootDevice ...
   277  	JobTypeRebootDevice JobType = "rebootDevice"
   278  	// JobTypeUnknown ...
   279  	JobTypeUnknown JobType = "unknown"
   280  	// JobTypeUpdateDeviceConfiguration ...
   281  	JobTypeUpdateDeviceConfiguration JobType = "updateDeviceConfiguration"
   282  	// JobTypeWriteDeviceProperties ...
   283  	JobTypeWriteDeviceProperties JobType = "writeDeviceProperties"
   284  )
   285  
   286  // PossibleJobTypeValues returns an array of possible values for the JobType const type.
   287  func PossibleJobTypeValues() []JobType {
   288  	return []JobType{JobTypeBackup, JobTypeExport, JobTypeFactoryResetDevice, JobTypeFirmwareUpdate, JobTypeImport, JobTypeReadDeviceProperties, JobTypeRebootDevice, JobTypeUnknown, JobTypeUpdateDeviceConfiguration, JobTypeWriteDeviceProperties}
   289  }
   290  
   291  // NetworkRuleIPAction enumerates the values for network rule ip action.
   292  type NetworkRuleIPAction string
   293  
   294  const (
   295  	// NetworkRuleIPActionAllow ...
   296  	NetworkRuleIPActionAllow NetworkRuleIPAction = "Allow"
   297  )
   298  
   299  // PossibleNetworkRuleIPActionValues returns an array of possible values for the NetworkRuleIPAction const type.
   300  func PossibleNetworkRuleIPActionValues() []NetworkRuleIPAction {
   301  	return []NetworkRuleIPAction{NetworkRuleIPActionAllow}
   302  }
   303  
   304  // PrivateLinkServiceConnectionStatus enumerates the values for private link service connection status.
   305  type PrivateLinkServiceConnectionStatus string
   306  
   307  const (
   308  	// PrivateLinkServiceConnectionStatusApproved ...
   309  	PrivateLinkServiceConnectionStatusApproved PrivateLinkServiceConnectionStatus = "Approved"
   310  	// PrivateLinkServiceConnectionStatusDisconnected ...
   311  	PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
   312  	// PrivateLinkServiceConnectionStatusPending ...
   313  	PrivateLinkServiceConnectionStatusPending PrivateLinkServiceConnectionStatus = "Pending"
   314  	// PrivateLinkServiceConnectionStatusRejected ...
   315  	PrivateLinkServiceConnectionStatusRejected PrivateLinkServiceConnectionStatus = "Rejected"
   316  )
   317  
   318  // PossiblePrivateLinkServiceConnectionStatusValues returns an array of possible values for the PrivateLinkServiceConnectionStatus const type.
   319  func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus {
   320  	return []PrivateLinkServiceConnectionStatus{PrivateLinkServiceConnectionStatusApproved, PrivateLinkServiceConnectionStatusDisconnected, PrivateLinkServiceConnectionStatusPending, PrivateLinkServiceConnectionStatusRejected}
   321  }
   322  
   323  // PublicNetworkAccess enumerates the values for public network access.
   324  type PublicNetworkAccess string
   325  
   326  const (
   327  	// PublicNetworkAccessDisabled ...
   328  	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
   329  	// PublicNetworkAccessEnabled ...
   330  	PublicNetworkAccessEnabled PublicNetworkAccess = "Enabled"
   331  )
   332  
   333  // PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.
   334  func PossiblePublicNetworkAccessValues() []PublicNetworkAccess {
   335  	return []PublicNetworkAccess{PublicNetworkAccessDisabled, PublicNetworkAccessEnabled}
   336  }
   337  
   338  // ResourceIdentityType enumerates the values for resource identity type.
   339  type ResourceIdentityType string
   340  
   341  const (
   342  	// ResourceIdentityTypeNone ...
   343  	ResourceIdentityTypeNone ResourceIdentityType = "None"
   344  	// ResourceIdentityTypeSystemAssigned ...
   345  	ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
   346  	// ResourceIdentityTypeSystemAssignedUserAssigned ...
   347  	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
   348  	// ResourceIdentityTypeUserAssigned ...
   349  	ResourceIdentityTypeUserAssigned ResourceIdentityType = "UserAssigned"
   350  )
   351  
   352  // PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.
   353  func PossibleResourceIdentityTypeValues() []ResourceIdentityType {
   354  	return []ResourceIdentityType{ResourceIdentityTypeNone, ResourceIdentityTypeSystemAssigned, ResourceIdentityTypeSystemAssignedUserAssigned, ResourceIdentityTypeUserAssigned}
   355  }
   356  
   357  // RouteErrorSeverity enumerates the values for route error severity.
   358  type RouteErrorSeverity string
   359  
   360  const (
   361  	// RouteErrorSeverityError ...
   362  	RouteErrorSeverityError RouteErrorSeverity = "error"
   363  	// RouteErrorSeverityWarning ...
   364  	RouteErrorSeverityWarning RouteErrorSeverity = "warning"
   365  )
   366  
   367  // PossibleRouteErrorSeverityValues returns an array of possible values for the RouteErrorSeverity const type.
   368  func PossibleRouteErrorSeverityValues() []RouteErrorSeverity {
   369  	return []RouteErrorSeverity{RouteErrorSeverityError, RouteErrorSeverityWarning}
   370  }
   371  
   372  // RoutingSource enumerates the values for routing source.
   373  type RoutingSource string
   374  
   375  const (
   376  	// RoutingSourceDeviceConnectionStateEvents ...
   377  	RoutingSourceDeviceConnectionStateEvents RoutingSource = "DeviceConnectionStateEvents"
   378  	// RoutingSourceDeviceJobLifecycleEvents ...
   379  	RoutingSourceDeviceJobLifecycleEvents RoutingSource = "DeviceJobLifecycleEvents"
   380  	// RoutingSourceDeviceLifecycleEvents ...
   381  	RoutingSourceDeviceLifecycleEvents RoutingSource = "DeviceLifecycleEvents"
   382  	// RoutingSourceDeviceMessages ...
   383  	RoutingSourceDeviceMessages RoutingSource = "DeviceMessages"
   384  	// RoutingSourceDigitalTwinChangeEvents ...
   385  	RoutingSourceDigitalTwinChangeEvents RoutingSource = "DigitalTwinChangeEvents"
   386  	// RoutingSourceInvalid ...
   387  	RoutingSourceInvalid RoutingSource = "Invalid"
   388  	// RoutingSourceTwinChangeEvents ...
   389  	RoutingSourceTwinChangeEvents RoutingSource = "TwinChangeEvents"
   390  )
   391  
   392  // PossibleRoutingSourceValues returns an array of possible values for the RoutingSource const type.
   393  func PossibleRoutingSourceValues() []RoutingSource {
   394  	return []RoutingSource{RoutingSourceDeviceConnectionStateEvents, RoutingSourceDeviceJobLifecycleEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceMessages, RoutingSourceDigitalTwinChangeEvents, RoutingSourceInvalid, RoutingSourceTwinChangeEvents}
   395  }
   396  
   397  // TestResultStatus enumerates the values for test result status.
   398  type TestResultStatus string
   399  
   400  const (
   401  	// TestResultStatusFalse ...
   402  	TestResultStatusFalse TestResultStatus = "false"
   403  	// TestResultStatusTrue ...
   404  	TestResultStatusTrue TestResultStatus = "true"
   405  	// TestResultStatusUndefined ...
   406  	TestResultStatusUndefined TestResultStatus = "undefined"
   407  )
   408  
   409  // PossibleTestResultStatusValues returns an array of possible values for the TestResultStatus const type.
   410  func PossibleTestResultStatusValues() []TestResultStatus {
   411  	return []TestResultStatus{TestResultStatusFalse, TestResultStatusTrue, TestResultStatusUndefined}
   412  }
   413
View as plain text