@azure/arm-databox package
Classes
| DataBoxManagementClient |
Interfaces
| AccountCredentialDetails |
Detalhes da credencial da conta. |
| AdditionalErrorInfo |
Essa classe representa informações adicionais que os Provedores de Recursos passam quando ocorre um erro. |
| AddressValidationOutput |
Saída da api de validação de endereço. |
| AddressValidationProperties |
A saída de validação de endereço. |
| ApiError |
interface do modelo ApiError |
| ApplianceNetworkConfiguration |
A configuração do Adaptador de Rede de um DataBox. |
| AvailableSkuRequest |
Os filtros para mostrar os skus disponíveis. |
| AzureFileFilterDetails |
Filtrar detalhes para transferir arquivos do Azure |
| BlobFilterDetails |
Filtrar detalhes para transferir Blobs do Azure |
| CancellationReason |
Motivo do cancelamento. |
| CloudError |
Fornece informações adicionais sobre uma resposta de erro http. |
| ContactDetails |
Detalhes do contato. |
| ContactInfo |
Informações de contato. |
| CopyLogDetails |
Detalhes do log gerado durante a cópia. |
| CopyProgress |
Progresso da cópia. |
| CreateJobValidations |
Ele faz todas as validações de criação de pré-trabalho. |
| CreateOrderLimitForSubscriptionValidationRequest |
Solicite a validação do limite de pedido de criação para a assinatura atual. |
| CreateOrderLimitForSubscriptionValidationResponseProperties |
Propriedades do limite de pedido de criação para resposta de validação de assinatura. |
| CustomerDiskJobSecrets |
Os segredos relacionados ao trabalho de disco do cliente. |
| DataAccountDetails |
Detalhes da conta dos dados a serem transferidos |
| DataBoxAccountCopyLogDetails |
Copiar detalhes do log para uma conta de armazenamento de um trabalho do DataBox |
| DataBoxCustomerDiskCopyLogDetails |
Copiar detalhes do log para o disco do cliente |
| DataBoxCustomerDiskCopyProgress |
Progresso da cópia do CustomerDisk do DataBox |
| DataBoxCustomerDiskJobDetails |
Detalhes do trabalho de disco do cliente. |
| DataBoxDiskCopyLogDetails |
Copiar detalhes do log para um disco |
| DataBoxDiskCopyProgress |
Progresso da cópia do disco databox |
| DataBoxDiskGranularCopyLogDetails |
Detalhes do log de cópia granular para o disco do cliente |
| DataBoxDiskGranularCopyProgress |
Progresso da cópia granular do disco databox |
| DataBoxDiskJobDetails |
Detalhes do trabalho do DataBox Disk. |
| DataBoxDiskJobSecrets |
Os segredos relacionados ao trabalho de disco. |
| DataBoxHeavyAccountCopyLogDetails |
Copiar detalhes do log para uma conta de armazenamento para o Databox heavy |
| DataBoxHeavyJobDetails |
Detalhes do trabalho do dispositivo pesado da caixa de dados |
| DataBoxHeavyJobSecrets |
Os segredos relacionados a um trabalho pesado de caixa de dados. |
| DataBoxHeavySecret |
Os segredos relacionados a uma caixa de dados pesada. |
| DataBoxJobDetails |
Detalhes do trabalho da caixa de dados |
| DataBoxManagementClientOptionalParams |
Parâmetros opcionais para o cliente. |
| DataBoxScheduleAvailabilityRequest |
Corpo da solicitação para obter a disponibilidade para agendar pedidos de pedidos de caixa de dados. |
| DataBoxSecret |
Os segredos relacionados a um DataBox. |
| DataExportDetails |
Detalhes dos dados a serem usados para exportar dados do azure. |
| DataImportDetails |
Detalhes dos dados a serem usados para importar dados para o azure. |
| DataLocationToServiceLocationMap |
Mapa do local de dados para o local do serviço |
| DataTransferDetailsValidationRequest |
Solicite a validação dos detalhes de exportação e importação de dados. |
| DataTransferDetailsValidationResponseProperties |
Propriedades da resposta de validação de detalhes de transferência de dados. |
| DataboxJobSecrets |
Os segredos relacionados a um trabalho de caixa de dados. |
| DatacenterAddressInstructionResponse |
Instrução do datacenter para determinado local de armazenamento. |
| DatacenterAddressLocationResponse |
Endereço do datacenter para determinado local de armazenamento. |
| DatacenterAddressRequest |
Solicitar corpo para obter o endereço do datacenter. |
| DatacenterAddressResponse |
Endereço do datacenter para determinado local de armazenamento. |
| DcAccessSecurityCode |
Código de segurança de acesso de dc |
| Details |
Interface do modelo Detalhes |
| DeviceCapabilityDetails |
Detalhes da funcionalidade do dispositivo para um determinado sku para uma determinada região. |
| DeviceCapabilityRequest |
Solicite o corpo para obter os recursos do dispositivo para determinado sku. |
| DeviceCapabilityResponse |
Funcionalidades do dispositivo para determinado sku em uma região |
| DeviceErasureDetails |
Detalhes de apagamento do dispositivo com status de conclusão de apagamento, chave sas de apagamento seguro e chave sas erasureordestructionlog |
| DiskScheduleAvailabilityRequest |
Corpo da solicitação para obter a disponibilidade para agendar pedidos de disco. |
| DiskSecret |
Contém todos os segredos de um Disco. |
| EncryptionPreferences |
Preferências relacionadas à Criptografia. |
| ErrorDetail |
interface do modelo ErrorDetail |
| ExportDiskDetails |
Exportar detalhes do disco |
| FilterFileDetails |
Detalhes dos arquivos de filtro a serem usados para transferência de dados. |
| GranularCopyLogDetails |
Detalhes granulares para o log gerado durante a cópia. |
| GranularCopyProgress |
Progresso da Cópia Granular. |
| HeavyScheduleAvailabilityRequest |
Corpo da solicitação para obter a disponibilidade para agendar pedidos pesados. |
| IdentityProperties |
Propriedades de identidade gerenciada. |
| ImportDiskDetails |
Importar detalhes do disco |
| JobDelayDetails |
Detalhes da notificação de atraso do trabalho |
| JobDeliveryInfo |
Informações adicionais de entrega. |
| JobDetails |
Detalhes do trabalho. |
| JobProperties |
Propriedades da Tarefa |
| JobResource |
Recurso do Trabalho. |
| JobResourceUpdateParameter |
O JobResourceUpdateParameter. |
| JobSecrets |
A classe base para os segredos |
| JobStages |
Estágios de trabalho. |
| JobsBookShipmentPickUpOptionalParams |
Parâmetros opcionais. |
| JobsCancelOptionalParams |
Parâmetros opcionais. |
| JobsCreateOptionalParams |
Parâmetros opcionais. |
| JobsDeleteOptionalParams |
Parâmetros opcionais. |
| JobsGetOptionalParams |
Parâmetros opcionais. |
| JobsListByResourceGroupOptionalParams |
Parâmetros opcionais. |
| JobsListCredentialsOptionalParams |
Parâmetros opcionais. |
| JobsListOptionalParams |
Parâmetros opcionais. |
| JobsMarkDevicesShippedOptionalParams |
Parâmetros opcionais. |
| JobsOperations |
Interface que representa uma operação de Jobs. |
| JobsUpdateOptionalParams |
Parâmetros opcionais. |
| KeyEncryptionKey |
Chave de criptografia que contém detalhes sobre a chave para criptografar chaves diferentes. |
| LastMitigationActionOnJob |
Última ação de mitigação executada no trabalho |
| ManagedDiskDetails |
Detalhes dos discos gerenciados. |
| MarkDevicesShippedRequest |
O corpo da solicitação para fornecer os detalhes do pacote de entrega do trabalho |
| MitigateJobRequest |
O Trabalho de Mitigação capturado do corpo da solicitação para a API de Mitigação |
| MitigateOptionalParams |
Parâmetros opcionais. |
| NotificationPreference |
Preferência de notificação para um estágio de trabalho. |
| Operation |
Entidade de operação. |
| OperationDisplay |
Exibição da operação |
| OperationsListOptionalParams |
Parâmetros opcionais. |
| OperationsOperations |
Interface que representa operações de operações. |
| PackageCarrierDetails |
Detalhes da transportadora de pacotes. |
| PackageCarrierInfo |
informações da transportadora de pacotes |
| PackageShippingDetails |
detalhes do envio de pacotes |
| PageSettings |
Opções para o método byPage |
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página. |
| Preferences |
Preferências relacionadas à ordem |
| PreferencesValidationRequest |
Solicitação para validar a preferência de transporte e data center. |
| PreferencesValidationResponseProperties |
Propriedades do data center e da resposta de validação de preferência de transporte. |
| RegionConfigurationRequest |
Corpo da solicitação para obter a configuração da região. |
| RegionConfigurationResponse |
Resposta de configuração específica para uma região. |
| Resource |
Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager |
| ResourceIdentity |
Detalhes da identidade msi do recurso |
| RestorePollerOptions | |
| ReverseShippingDetails |
Endereço de envio reverso e detalhes de contato para um trabalho. |
| ScheduleAvailabilityRequest |
Corpo da solicitação para obter a disponibilidade para agendamento de pedidos. |
| ScheduleAvailabilityResponse |
Agende a disponibilidade para determinado sku em uma região. |
| ServiceListAvailableSkusByResourceGroupOptionalParams |
Parâmetros opcionais. |
| ServiceOperations |
Interface representando operações de serviço. |
| ServiceRegionConfigurationByResourceGroupOptionalParams |
Parâmetros opcionais. |
| ServiceRegionConfigurationOptionalParams |
Parâmetros opcionais. |
| ServiceValidateAddressOptionalParams |
Parâmetros opcionais. |
| ServiceValidateInputsByResourceGroupOptionalParams |
Parâmetros opcionais. |
| ServiceValidateInputsOptionalParams |
Parâmetros opcionais. |
| ShareCredentialDetails |
Detalhes da credencial dos compartilhamentos na conta. |
| ShipmentPickUpRequest |
Detalhes da solicitação de retirada de remessa. |
| ShipmentPickUpResponse |
Resposta de retirada de remessa. |
| ShippingAddress |
Endereço de envio em que o cliente deseja receber o dispositivo. |
| SimplePollerLike |
Um sondador simples que pode ser usado para sondar uma operação de longa execução. |
| Sku |
O Sku. |
| SkuAvailabilityValidationRequest |
Solicitação para validar a disponibilidade do sku. |
| SkuAvailabilityValidationResponseProperties |
Propriedades da resposta de validação de disponibilidade de sku. |
| SkuCapacity |
Capacidade do sku. |
| SkuCost |
Descreve metadados para recuperar informações de preço. |
| SkuInformation |
Informações do sku. |
| SkuProperties |
Propriedades do SKU. |
| StorageAccountDetails |
Detalhes da conta de armazenamento. |
| SubscriptionIsAllowedToCreateJobValidationRequest |
Solicite a validação da permissão de assinatura para criar trabalhos. |
| SubscriptionIsAllowedToCreateJobValidationResponseProperties |
Propriedades da permissão de assinatura para criar resposta de validação de trabalho. |
| SystemData |
Metadados relativos à criação e última modificação do recurso. |
| TrackedResource |
A definição do modelo de recurso para um recurso de nível superior rastreado pelo Azure Resource Manager que tem 'marcas' e um 'local' |
| TransferAllDetails |
Detalhes para transferir todos os dados. |
| TransferConfiguration |
Configuração para definir a transferência de dados. |
| TransferConfigurationTransferAllDetails |
Mapa do tipo de filtro e os detalhes para transferir todos os dados. Esse campo será necessário somente se o TransferConfigurationType for dado como TransferAll |
| TransferConfigurationTransferFilterDetails |
Mapa do tipo de filtro e os detalhes a serem filtrados. Esse campo será necessário somente se TransferConfigurationType for dado como TransferUsingFilter. |
| TransferFilterDetails |
Detalhes da filtragem da transferência de dados. |
| TransportAvailabilityDetails |
Detalhes de disponibilidade das opções de transporte para determinada região. |
| TransportAvailabilityRequest |
Corpo da solicitação para obter a disponibilidade de transporte para determinado sku. |
| TransportAvailabilityResponse |
Opções de transporte disponíveis para determinado sku em uma região. |
| TransportPreferences |
Preferências relacionadas à logística de remessa do sku |
| UnencryptedCredentials |
Credenciais não criptografadas para acessar o dispositivo. |
| UpdateJobDetails |
Detalhes do trabalho para atualização. |
| UpdateJobProperties |
Propriedades do Trabalho para atualização |
| UserAssignedIdentity |
Propriedades de identidade atribuídas pelo usuário |
| UserAssignedProperties |
Propriedades de identidade atribuídas pelo usuário. |
| ValidateAddress |
Os requisitos para validar o endereço do cliente para onde o dispositivo precisa ser enviado. |
| ValidationInputRequest |
Campos mínimos que devem estar presentes em qualquer tipo de solicitação de validação. |
| ValidationInputResponse |
Propriedades mínimas que devem estar presentes em cada resposta de validação individual. |
| ValidationRequest |
Requisito mínimo de solicitação de qualquer categoria de validação. |
| ValidationResponse |
Resposta de validações de criação de pré-trabalho. |
| ValidationResponseProperties |
Propriedades da resposta de validação pré-criação de empregos. |
Aliases de tipo
| AccessProtocol |
Protocolos de acesso com suporte no dispositivo. |
| AddressType |
Tipo de endereço. |
| AddressValidationStatus |
O status de validação de endereço. |
| AzureSupportedClouds |
Os valores com suporte para a configuração de nuvem como um tipo literal de cadeia de caracteres |
| ClassDiscriminator |
Indica o tipo de detalhes do trabalho. |
| ContinuablePage |
Uma interface que descreve uma página de resultados. |
| CopyLogDetailsUnion |
Alias: CopyLogDetailsUnion |
| CopyStatus |
O Status da cópia Valores conhecidos compatíveis com o serviço
NotStarted: a cópia de dados ainda não foi iniciada. |
| CreatedByType |
O tipo de entidade que criou o recurso. Valores conhecidos compatíveis com o serviço
User: a entidade foi criada por um usuário. |
| CustomerResolutionCode |
Código de resolução fornecido pelo cliente. |
| DataAccountDetailsUnion |
Alias para DataAccountDetailsUnion |
| DataAccountType |
Tipo da conta. |
| DataCenterCode |
Código do DataCenter. Valores conhecidos compatíveis com o serviço
Inválido |
| DatacenterAddressResponseUnion |
Alias para DatacenterAddressResponseUnion |
| DatacenterAddressType |
Tipo de endereço do data center |
| DelayNotificationStatus |
Status da notificação Valores conhecidos compatíveis com o serviço
Ativo: o atraso ainda está ativo |
| DoubleEncryption |
Define a camada secundária de habilitação de criptografia baseada em software. |
| FilterFileType |
Tipo do arquivo de filtro. |
| GranularCopyLogDetailsUnion |
Alias para GranularCopyLogDetailsUnion |
| HardwareEncryption |
Suporte de criptografia de hardware para um determinado sku para uma determinada região. |
| JobDeliveryType |
Tipo de entrega de Trabalho. |
| JobDetailsUnion |
Nome de Trabalho DetalhesUnion |
| JobSecretsUnion |
Nome de Trabalho SecretosUnion |
| KekType |
Tipo de chave de criptografia usada para criptografia de chave. |
| LogCollectionLevel |
Nível dos logs a serem coletados. |
| ModelName |
O nome amigável do cliente da combinação de versão e capacidade do dispositivo. Esse campo é necessário apenas no momento da ordenação do dispositivo de geração mais recente, ou seja, AzureDataBox120 e AzureDataBox525 a partir de fevereiro de 2025 |
| NotificationStageName |
Nome do estágio. Valores conhecidos compatíveis com o serviço
DevicePrepared: Notificação no estágio preparado pelo dispositivo. |
| OverallValidationStatus |
Status geral de validação. |
| PortalDelayErrorCode |
Código de Erro de Atraso Valores conhecidos compatíveis com o serviço
InternalIssueDelay: Atraso devido a quaisquer motivos internos |
| ReverseShippingDetailsEditStatus |
O status editável para endereço de envio reverso e informações de contato |
| ReverseTransportPreferenceEditStatus |
O status editável para preferências de transporte reverso |
| ScheduleAvailabilityRequestUnion |
Alias: AgendaDisponibilidadeSolicitaçãoUnion |
| ShareDestinationFormatType |
Tipo do compartilhamento. |
| SkuDisabledReason |
Motivo pelo qual o Sku está desabilitado. |
| SkuName |
Nomes de SKU. |
| StageName |
Nome do estágio que está em andamento. Valores conhecidos compatíveis com o serviço
DeviceOrdered: uma ordem foi criada. |
| StageStatus |
Mantém o status de conclusão da eliminação do dispositivo |
| TransferConfigurationType |
Tipo da configuração para transferência. |
| TransferType |
Tipo da transferência. |
| TransportShipmentTypes |
Tipo de Remessa de Transporte suportado para determinada região. |
| ValidationInputDiscriminator |
Identifica o tipo de solicitação de validação. |
| ValidationInputRequestUnion |
Alias para ValidationInputRequestUnion |
| ValidationInputResponseUnion |
Alias para ValidationInputResponseUnion |
| ValidationRequestUnion |
Alias para ValidationRequestUnion |
| ValidationStatus |
Crie o status de validação do limite de pedidos. |
Enumerações
| AzureClouds |
Um enumeração para descrever os ambientes de nuvem do Azure. |
| KnownCopyStatus |
O Status da cópia |
| KnownCreatedByType |
O tipo de entidade que criou o recurso. |
| KnownDataCenterCode |
Código do DataCenter. |
| KnownDelayNotificationStatus |
Status da notificação |
| KnownNotificationStageName |
Nome do estágio. |
| KnownPortalDelayErrorCode |
Código de erro de atraso |
| KnownStageName |
Nome do estágio que está em andamento. |
| KnownVersions |
As versões de API disponíveis. |
Funções
| is |
Typeguard para RestError |
| restore |
Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo. |
Variáveis
| Rest |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
Detalhes da função
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parâmetros
- e
-
unknown
Algo pego por uma cláusula catch.
Retornos
e
restorePoller<TResponse, TResult>(DataBoxManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.
function restorePoller<TResponse, TResult>(client: DataBoxManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parâmetros
- client
- DataBoxManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Retornos
PollerLike<OperationState<TResult>, TResult>
Detalhes da variável
RestError
Um tipo de erro personalizado para solicitações de pipeline com falha.
RestError: RestErrorConstructor