Compartilhar via

DeviceRegistryOperationError Classe

  • Referência

Os detalhes do erro da operação do registro do dispositivo.

Herança
Model
DeviceRegistryOperationError

Construtor

DeviceRegistryOperationError(*, device_id: str = None, error_code=None, error_status: str = None, module_id: str = None, operation: str = None, **kwargs)

Parâmetros

device_id
str
Obrigatório

O identificador exclusivo do dispositivo.

error_code
str ou <xref:protocol.models.enum>
Obrigatório

O código de erro. Os valores possíveis incluem: 'InvalidErrorCode', 'GenericBadRequest', 'InvalidProtocolVersion', 'DeviceInvalidResultCount', 'InvalidOperation', 'ArgumentInvalid', 'ArgumentNull', 'IotHubFormatError', 'DeviceStorageEntitySerializationError', 'BlobContainerValidationError', 'ImportWarningExistsError', 'InvalidSchemaVersion', 'DeviceDefinedMultipleTimes', 'DeserializationError', 'BulkRegistryOperationFailure', 'DefaultStorageEndpointNotConfigured', ' InvalidFileUploadCorrelationId', 'ExpiredFileUploadCorrelationId', 'InvalidStorageEndpoint', 'InvalidMessagingEndpoint', 'InvalidFileUploadCompletionStatus', 'InvalidStorageEndpointOrBlob', 'RequestCanceled', 'InvalidStorageEndpointProperty', 'EtagDoesNotMatch', 'RequestTimedOut', 'UnsupportedOperationOnReplica', 'NullMessage', 'ConnectionForcefullyClosedOnNewConnection', 'InvalidDeviceScope', 'ConnectionForcefullyClosedOnFaultInjection', ' ConnectionRejectedOnFaultInjection', 'InvalidEndpointAuthenticationType', 'ManagedIdentityNotEnabled', 'InvalidRouteTestInput', 'InvalidSourceOnRoute', 'RoutingNotEnabled', 'InvalidContentEncodingOrType', 'InvalidEndorsementKey', 'InvalidRegistrationId', 'InvalidStorageRootKey', 'InvalidEnrollmentGroupId', 'TooManyEnrollments', 'RegistrationIdDefinedMultipleTimes', 'CustomAllocationFailed', 'CustomAllocationIotHubNotSpecified', ' CustomAllocationUnauthorizedAccess', 'CannotRegisterModuleToModule', 'TenantHubRoutingNotEnabled', 'InvalidConfigurationTargetCondition', 'InvalidConfigurationContent', 'CannotModifyImmutableConfigurationContent', 'InvalidConfigurationCustomMetricsQuery', 'InvalidPnPInterfaceDefinition', 'InvalidPnPDesiredProperties', 'InvalidPnPReportedProperties', 'InvalidPnPWritableReportedProperties', 'InvalidDigitalTwinJsonPatch', 'InvalidDigitalTwinPayload', ' InvalidDigitalTwinPatch', 'InvalidDigitalTwinPatchPath', 'GenericUnauthorized', 'IotHubNotFound', 'IotHubUnauthorizedAccess', 'IotHubUnauthorized', 'ElasticPoolNotFound', 'SystemModuleModifyUnauthorizedAccess', 'GenericForbidden', 'IotHubSuspended', 'IotHubQuotaExceeded', 'JobQuotaExceeded', 'DeviceMaximumQueueDepthExceeded', 'IotHubMaxCbsTokenExceeded', 'DeviceMaximumActiveFileUploadLimitExceeded', 'DeviceMaximumQueueSizeExceeded', ' RoutingEndpointResponseForbidden', 'InvalidMessageExpiryTime', 'OperationNotAvailableInCurrentTier', 'KeyEncryptionKeyRevoked', 'DeviceModelMaxPropertiesExceeded', 'DeviceModelMaxIndexablePropertiesExceeded', 'IotDpsSuspended', 'IotDpsSuspending', 'GenericNotFound', 'DeviceNotFound', 'JobNotFound', 'QuotaMetricNotFound', 'SystemPropertyNotFound', 'AmqpAddressNotFound', 'RoutingEndpointResponseNotFound', 'CertificateNotFound', 'ElasticPoolTenantHubNotFound', ' ModuleNotFound', 'AzureTableStoreNotFound', 'IotHubFailingOver', 'FeatureNotSupported', 'DigitalTwinInterfaceNotFound', 'QueryStoreClusterNotFound', 'DeviceNotOnline', 'DeviceConnectionClosedRemotely', 'EnrollmentNotFound', 'DeviceRegistrationNotFound', 'AsyncOperationNotFound', 'EnrollmentGroupNotFound', 'DeviceRecordNotFound', 'GroupRecordNotFound', 'DeviceGroupNotFound', 'ProvisioningSettingsNotFound', 'ProvisioningRecordNotFound', 'LinkedHubNotFound', ' CertificateAuthorityNotFound', 'ConfigurationNotFound', 'GroupNotFound', 'DigitalTwinModelNotFound', 'InterfaceNameModelNotFound', 'GenericMethodNotAllowed', 'OperationNotAllowedInCurrentState', 'ImportDevicesNotSupported', 'BulkAddDevicesNotSupported', 'GenericConflict', 'DeviceAlreadyExists', 'LinkCreationConflict', 'CallbackSubscriptionConflict', 'ModelAlreadyExists', 'DeviceLocked', 'DeviceJobAlreadyExists', 'JobAlreadyExists', 'EnrollmentConflict', ' EnrollmentGroupConflict', 'RegistrationStatusConflict', 'DeviceRecordConflict', 'GroupRecordConflict', 'DeviceGroupConflict', 'ProvisioningSettingsConflict', 'ProvisioningRecordConflict', 'LinkedHubConflict', 'CertificateAuthorityConflict', 'ModuleAlreadyExistsOnDevice', 'ConfigurationAlreadyExists', 'ApplyConfigurationAlreadyInProgressOnDevice', 'DigitalTwinModelAlreadyExists', 'DigitalTwinModelExistsWithOtherModelType', 'InterfaceNameModelAlreadyExists', ' GenericPreconditionFailed', 'PreconditionFailed', 'DeviceMessageLockLost', 'JobRunPreconditionFailed', 'InflightMessagesInLink', 'GenericRequestEntityTooLarge', 'MessageTooLarge', 'TooManyDevices', 'TooManyModulesOnDevice', 'ConfigurationCountLimitExceeded', 'DigitalTwinModelCountLimitExceeded', 'InterfaceNameCompressionModelCountLimitExceeded', 'GenericUnsupportedMediaType', 'IncompatibleDataType', 'GenericTooManyRequests', 'ThrottlingException', ' ThrottleBacklogLimitExceeded', 'ThrottlingBacklogTimeout', 'ThrottlingMaxActiveJobCountExceeded', 'DeviceThrottlingLimitExceeded', 'ClientClosedRequest', 'GenericServerError', 'ServerError', 'JobCancelled', 'StatisticsRetrievalError', 'ConnectionForcefullyClosed', 'InvalidBlobState', 'BackupTimedOut', 'AzureStorageTimeout', 'GenericTimeout', 'InvalidThrottleParameter', 'EventHubLinkAlreadyClosed', 'ReliableBlobStoreError', 'RetryAttemptsExhausted', ' AzureTableStoreError', 'CheckpointStoreNotFound', 'DocumentDbInvalidReturnValue', 'ReliableDocDbStoreStoreError', 'ReliableBlobStoreTimeoutError', 'ConfigReadFailed', 'InvalidContainerReceiveLink', 'InvalidPartitionEpoch', 'RestoreTimedOut', 'StreamReservationFailure', 'SerializationError', 'UnexpectedPropertyValue', 'OrchestrationOperationFailed', 'ModelRepoEndpointError', 'ResolutionError', 'UnableToFetchCredentials', 'UnableToFetchTenantInfo', ' UnableToShareIdentity', 'UnableToExpandDiscoveryInfo', 'UnableToExpandComponentInfo', 'UnableToCompressComponentInfo', 'UnableToCompressDiscoveryInfo', 'OrphanDiscoveryDocument', 'GenericBadGateway', 'InvalidResponseWhileProxying', 'GenericServiceUnavailable', 'ServiceUnavailable', 'PartitionNotFound', 'IotHubActivationFailed', 'ServerBusy', 'IotHubRestoring', 'ReceiveLinkOpensThrottled', 'ConnectionUnavailable', 'DeviceUnavailable', 'ConfigurationNotAvailable', ' GroupNotAvailable', 'HostingServiceNotAvailable', 'GenericGatewayTimeout', 'GatewayTimeout'

error_status
str
Obrigatório

Os detalhes do erro.

module_id
str
Obrigatório

O identificador exclusivo do módulo, se aplicável.

operation
str
Obrigatório

O tipo da operação que falhou.

Métodos

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto .

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.
enable_additional_properties_sending
from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
validate

Valide esse modelo recursivamente e retorne uma lista de ValidationError.

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto .

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parâmetros

key_transformer
<xref:function>

Uma função de transformador de chave.

keep_readonly
valor padrão: True

Retornos

Um objeto compatível com JSON de dict

Tipo de retorno

dict

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

deserialize(data, content_type=None)

Parâmetros

data
str
Obrigatório

Um str usando a estrutura RestAPI. JSON por padrão.

content_type
str
valor padrão: None

JSON por padrão, defina application/xml se XML.

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parâmetros

data
dict
Obrigatório

Um ditado usando a estrutura RestAPI

content_type
str
valor padrão: None

JSON por padrão, defina application/xml se XML.

key_extractors
valor padrão: None

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly
bool
valor padrão: False

Se você quiser serializar os atributos somente leitura

Retornos

Um objeto compatível com JSON de dict

Tipo de retorno

dict

validate

Valide esse modelo recursivamente e retorne uma lista de ValidationError.

validate()

Retornos

Uma lista de erros de validação

Tipo de retorno

list