@azure/arm-databox package

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 de contacto.

ContactInfo

Informação de Contacto.

CopyLogDetails

Detalhes do log gerado durante a cópia.

CopyProgress

Copiar progresso.

CreateJobValidations

Ele faz todas as validações pré-criação de emprego.

CreateOrderLimitForSubscriptionValidationRequest

Solicitação para validar criar limite de pedidos para a assinatura atual.

CreateOrderLimitForSubscriptionValidationResponseProperties

Propriedades de criar limite de ordem para resposta de validação de assinatura.

CustomerDiskJobSecrets

Os segredos relacionados ao trabalho de disco do cliente.

DataAccountDetails

Dados da conta dos dados a transferir

DataBoxAccountCopyLogDetails

Copiar detalhes de log para uma conta de armazenamento de um trabalho DataBox

DataBoxCustomerDiskCopyLogDetails

Copiar detalhes de log para o disco do cliente

DataBoxCustomerDiskCopyProgress

Progresso da cópia do disco do cliente DataBox

DataBoxCustomerDiskJobDetails

Detalhes do trabalho de disco do cliente.

DataBoxDiskCopyLogDetails

Copiar detalhes de log para um disco

DataBoxDiskCopyProgress

Progresso da cópia do disco DataBox

DataBoxDiskGranularCopyLogDetails

Detalhes granulares do log de cópia para o disco do cliente

DataBoxDiskGranularCopyProgress

Progresso da cópia granular do disco DataBox

DataBoxDiskJobDetails

Detalhes do trabalho do disco DataBox.

DataBoxDiskJobSecrets

Os segredos relacionados ao trabalho de disco.

DataBoxHeavyAccountCopyLogDetails

Copiar detalhes de log para uma conta de armazenamento para Databox pesado

DataBoxHeavyJobDetails

Databox Heavy Device Job Detalhes

DataBoxHeavyJobSecrets

Os segredos estavam relacionados a um trabalho pesado de caixa de dados.

DataBoxHeavySecret

Os segredos diziam respeito a uma caixa de dados pesada.

DataBoxJobDetails

Detalhes do trabalho da caixa de dados

DataBoxManagementClientOptionalParams

Parâmetros opcionais para o cliente.

DataBoxScheduleAvailabilityRequest

Solicite o corpo para obter a disponibilidade para agendar pedidos de caixa de dados de pedidos.

DataBoxSecret

Os segredos relacionados a uma 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 da localização dos dados para a localização do serviço

DataTransferDetailsValidationRequest

Solicitação para validar 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ções de datacenter para determinado local de armazenamento.

DatacenterAddressLocationResponse

Endereço do datacenter para determinado local de armazenamento.

DatacenterAddressRequest

Solicite o 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 Dc

Details

Interface do modelo Detalhes

DeviceCapabilityDetails

Detalhes da capacidade 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

Recursos do dispositivo para determinado sku em uma região

DeviceErasureDetails

Detalhes de eliminação do dispositivo com status de conclusão de eliminação, chave sas de eliminação segura e chave sas de apagamentoordestruiçãolog sas

DiskScheduleAvailabilityRequest

Solicite o corpo para obter a disponibilidade para agendar pedidos de disco.

DiskSecret

Contém todos os segredos de um disco.

EncryptionPreferences

Preferências relacionadas com a Encriptação.

ErrorDetail

interface do modelo ErrorDetail

ExportDiskDetails

Exportar detalhes do disco

FilterFileDetails

Detalhes dos arquivos de filtro a serem usados para a transferência de dados.

GranularCopyLogDetails

Detalhes granulares para o log gerado durante a cópia.

GranularCopyProgress

Progresso da cópia granular.

HeavyScheduleAvailabilityRequest

Solicite o corpo para obter a disponibilidade para agendar pedidos pesados.

IdentityProperties

Propriedades de identidade gerenciadas.

ImportDiskDetails

Importar detalhes do disco

JobDelayDetails

Detalhes da notificação de atraso de trabalho

JobDeliveryInfo

Informações adicionais de entrega.

JobDetails

Detalhes do trabalho.

JobProperties

Propriedades do emprego

JobResource

Recurso de trabalho.

JobResourceUpdateParameter

O JobResourceUpdateParameter.

JobSecrets

A classe base para os segredos

JobStages

Etapas do 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 contendo 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 do pedido 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 uma operação de Operações.

PackageCarrierDetails

Detalhes da transportadora do pacote.

PackageCarrierInfo

informações sobre a transportadora do pacote

PackageShippingDetails

detalhes de envio do pacote

PageSettings

Opções para o método byPage

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável até a conclusão e por página.

Preferences

Preferências relacionadas com a encomenda

PreferencesValidationRequest

Pedido de validação de preferência de transporte e data center.

PreferencesValidationResponseProperties

Propriedades do data center e resposta de validação de preferência de transporte.

RegionConfigurationRequest

Solicite o corpo para obter a configuração para a 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

Solicitar corpo para obter a disponibilidade para agendamento de pedidos.

ScheduleAvailabilityResponse

Disponibilidade de agendamento 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 das ações na conta.

ShipmentPickUpRequest

Detalhes do pedido de levantamento do envio.

ShipmentPickUpResponse

Resposta de recolha de envio.

ShippingAddress

Endereço de entrega onde o cliente deseja receber o dispositivo.

SimplePollerLike

Um poller simples que pode ser usado para sondar uma operação de longa duração.

Sku

O Sku.

SkuAvailabilityValidationRequest

Solicitação para validar a disponibilidade de 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 referentes à criação e última modificação do recurso.

TrackedResource

A definição do modelo de recursos para um recurso de nível superior rastreado do Azure Resource Manager que tem 'tags' 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. Este campo é obrigatório somente se o TransferConfigurationType for fornecido como TransferAll

TransferConfigurationTransferFilterDetails

Mapa do tipo de filtro e os detalhes a filtrar. Este campo é obrigatório somente se o TransferConfigurationType for fornecido como TransferUsingFilter.

TransferFilterDetails

Detalhes da filtragem da transferência de dados.

TransportAvailabilityDetails

Detalhes de disponibilidade de opções de transporte para determinada região.

TransportAvailabilityRequest

Solicite o corpo 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 com a logística de envio 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 pedido 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 pré criação de emprego.

ValidationResponseProperties

Propriedades da resposta de validação pré-criação de emprego.

Aliases de Tipo

AccessProtocol

Protocolos de acesso suportados no dispositivo.

AddressType

Tipo de endereço.

AddressValidationStatus

O status de validação de endereço.

AzureSupportedClouds

Os valores suportados 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 para CopyLogDetailsUnion

CopyStatus

O Estado da cópia
KnownCopyStatus pode ser usado de forma intercambiável com CopyStatus, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

NotStarted: A cópia de dados ainda não começou.
InProgress: A cópia de dados está em andamento.
Concluído: Cópia de dados concluída.
CompletedWithErrors: Cópia de dados concluída com erros.
Falha: Falha na cópia dos dados. Não foram copiados dados.
NotReturned: Nenhuma cópia acionada como dispositivo não foi retornada.
HardwareError: O dispositivo atingiu problemas de hardware.
DeviceFormatted: Falha na cópia de dados. O dispositivo foi formatado pelo usuário.
DeviceMetadataModified: Falha na cópia de dados. Os metadados do dispositivo foram modificados pelo usuário.
StorageAccountNotAccessible: Falha na cópia de dados. A Conta de Armazenamento não estava acessível durante a cópia.
UnsupportedData: Falha na cópia de dados. O conteúdo de dados do dispositivo não é suportado.
DriveNotReceived: Nenhuma cópia acionada como dispositivo não foi recebido.
UnsupportedDrive: Nenhuma cópia acionada como tipo de dispositivo não é suportada.
OtherServiceError: Falha na cópia devido a erro de serviço.
OtherUserError: Falha na cópia devido a erro do usuário.
DriveNotDetected: Falha na cópia devido a erro de deteção de disco.
DriveCorrupted: Falha na cópia devido à unidade corrompida.
MetadataFilesModifiedOrRemoved: Falha na cópia devido a arquivos de metadados modificados ou removidos.

CreatedByType

O tipo de entidade que criou o recurso.
KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

User: A entidade foi criada por um usuário.
Application: A entidade foi criada por um aplicativo.
ManagedIdentity: A entidade foi criada por uma identidade gerenciada.
Key: A entidade foi criada por uma chave.

CustomerResolutionCode

Código de resolução fornecido pelo cliente.

DataAccountDetailsUnion

Alias para DataAccountDetailsUnion

DataAccountType

Tipo de conta.

DataCenterCode

Código do DataCenter.
KnownDataCenterCode pode ser usado de forma intercambiável com DataCenterCode, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

inválido
BY2
BY1
ORK70
AM2
AMS20
BY21
BY24
MWH01
AMS06
SSE90
SYD03
SYD23
CBR20
YTO20
CWL20
LON24
BOM01
BL20
BL7
SEL20
TYO01
BN1
SN5
CYS04
TYO22
YTO21
YQB20
FRA22
MAA01
CPQ02
CPQ20
SIN20
HKG20
SG2
MEL23
SEL21
OSA20
SHA03
BJB
JNB22
JNB21
MNZ21
SN8
AUH20
ZRH20
PUS20
AdHoc
CH1
DSM05
DUB07
PNQ01
SVG20
OSA02
OSA22
PAR22
BN7
SN6
BJS20
BL24
IDC5
TYO23
NTG20
DXB23
DSM11
AMS25
CPQ21
OSA23

DatacenterAddressResponseUnion

Alias para DatacenterAddressResponseUnion

DatacenterAddressType

Tipo de endereço do centro de dados

DelayNotificationStatus

Estado da notificação
KnownDelayNotificationStatus pode ser usado de forma intercambiável com DelayNotificationStatus, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Ative: O atraso ainda está ativo
Resolvido: O atraso foi resolvido

DoubleEncryption

Define a camada secundária de ativaçã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 do trabalho.

JobDetailsUnion

Pseudónimo para JobDetailsUnion

JobSecretsUnion

Pseudónimo para JobSecretsUnion

KekType

Tipo de chave de encriptação utilizada para encriptação 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. Este campo é necessário apenas no momento da encomenda do dispositivo de nova geração, ou seja, AzureDataBox120 e AzureDataBox525 a partir de fev/2025

NotificationStageName

Nome do palco.
KnownNotificationStageName pode ser usado de forma intercambiável com NotificationStageName, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

DevicePrepared: Notificação na fase de preparação do dispositivo.
Despachado: Notificação na fase de despacho do dispositivo.
Entregue: Notificação no estágio de entrega do dispositivo.
PickedUp: Notificação no dispositivo recolhido do estágio do usuário.
AtAzureDC: Notificação no dispositivo recebida no estágio do datacenter do Azure.
DataCopy: Notificação no estágio iniciado da cópia de dados.
Created: Notificação na fase de criação de emprego.
ShippedToCustomer: Notificação nos dispositivos enviados para o estágio do cliente.

OverallValidationStatus

Estado geral de validação.

PortalDelayErrorCode

Código de Erro de Atraso
KnownPortalDelayErrorCode pode ser usado de forma intercambiável com PortalDelayErrorCode, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

InternalIssueDelay: Atraso devido a quaisquer razões internas
ActiveOrderLimitBreachedDelay: Limite de ordem ativa violado.
HighDemandDelay: Alta demanda
LargeNumberOfFilesDelay: Cópia lenta devido ao grande número de arquivos

ReverseShippingDetailsEditStatus

O status editável para endereço de envio reverso e informações de contato

ReverseTransportPreferenceEditStatus

O status Editável para as preferências de Transporte Inverso

ScheduleAvailabilityRequestUnion

Alias para ScheduleAvailabilityRequestUnion

ShareDestinationFormatType

Tipo de ação.

SkuDisabledReason

Razão pela qual o Sku está desativado.

SkuName

Nomes de SKU.

StageName

Nome da fase em curso.
KnownStageName pode ser usado de forma intercambiável com StageName, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

DeviceOrdered: Uma ordem foi criada.
DevicePrepared: Um dispositivo foi preparado para o pedido.
Despachado: O dispositivo foi enviado para o usuário do pedido.
Entregue: O dispositivo foi entregue ao utilizador da encomenda.
PickedUp: O dispositivo foi recolhido do utilizador e está em trânsito para o centro de dados do Azure.
AtAzureDC: O dispositivo foi recebido do usuário no datacenter do Azure.
DataCopy: Cópia de dados do dispositivo no datacenter do Azure.
Concluído: A encomenda foi concluída.
CompletedWithErrors: A ordem foi concluída com erros.
Cancelado: A encomenda foi cancelada.
Failed_IssueReportedAtCustomer: A encomenda falhou devido a um problema reportado pelo utilizador.
Failed_IssueDetectedAtAzureDC: A encomenda falhou devido a um problema detetado no datacenter do Azure.
Abortado: A ordem foi abortada.
CompletedWithWarnings: A ordem foi concluída com avisos.
ReadyToDispatchFromAzureDC: O dispositivo está pronto para ser entregue ao cliente a partir do Azure DC.
ReadyToReceiveAtAzureDC: O dispositivo pode ser deixado no Azure DC.
Created: Trabalho criado pelo cliente.
ShippedToAzureDC: O usuário enviou o dispositivo para o AzureDC.
AwaitingShipmentDetails: Aguardando detalhes de envio do dispositivo do cliente.
PreparingToShipFromAzureDC: Preparando o dispositivo para envio ao cliente.
ShippedToCustomer: Enviado o dispositivo para o cliente.

StageStatus

Mantém o status de conclusão da eliminação do dispositivo

TransferConfigurationType

Tipo de configuração para transferência.

TransferType

Tipo de transferência.

TransportShipmentTypes

Tipo de Envio 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 enum para descrever 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

Estado da notificação

KnownNotificationStageName

Nome do palco.

KnownPortalDelayErrorCode

Código de erro de atraso

KnownStageName

Nome da fase em curso.

KnownVersions

As versões de API disponíveis.

Funções

isRestError(unknown)

Typeguard para RestError

restorePoller<TResponse, TResult>(DataBoxManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Variáveis

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

Detalhes de Função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo apanhado por uma cláusula de captura.

Devoluções

e

restorePoller<TResponse, TResult>(DataBoxManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está 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

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Devoluções

PollerLike<OperationState<TResult>, TResult>

Detalhes das variáveis

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

RestError: RestErrorConstructor

Tipo