@azure/arm-databox package

Interfaces

AccountCredentialDetails

Détails des informations d’identification du compte.

AdditionalErrorInfo

Cette classe représente des informations supplémentaires sur lesquelles les fournisseurs de ressources passent lorsqu’une erreur se produit.

AddressValidationOutput

Sortie de l’API de validation d’adresse.

AddressValidationProperties

Sortie de validation d’adresse.

ApiError

modèle interface ApiError

ApplianceNetworkConfiguration

Configuration de la carte réseau d’un DataBox.

AvailableSkuRequest

Filtres pour afficher les références SKU disponibles.

AzureFileFilterDetails

Filtrer les détails pour transférer des fichiers Azure

BlobFilterDetails

Filtrer les détails pour transférer des objets blob Azure

CancellationReason

Motif de l’annulation.

CloudError

Fournit des informations supplémentaires sur une réponse d’erreur HTTP.

ContactDetails

Détails du contact.

ContactInfo

Informations de contact.

CopyLogDetails

Détails du journal généré lors de la copie.

CopyProgress

Copiez la progression.

CreateJobValidations

Elle effectue toutes les validations de création de travaux préalables.

CreateOrderLimitForSubscriptionValidationRequest

Demande de validation de la limite de commande pour l’abonnement actuel.

CreateOrderLimitForSubscriptionValidationResponseProperties

Propriétés de la limite de commande de création pour la réponse de validation d’abonnement.

CustomerDiskJobSecrets

Secrets liés à la tâche de disque client.

DataAccountDetails

Détails du compte à transférer

DataBoxAccountCopyLogDetails

Copier les détails du journal pour un compte de stockage d’un travail DataBox

DataBoxCustomerDiskCopyLogDetails

Copier les détails du journal pour le disque client

DataBoxCustomerDiskCopyProgress

Progression de la copie CustomerDisk DataBox

DataBoxCustomerDiskJobDetails

Détails du travail sur le disque client.

DataBoxDiskCopyLogDetails

Copier les détails du journal pour un disque

DataBoxDiskCopyProgress

Progression de la copie de disque DataBox

DataBoxDiskGranularCopyLogDetails

Détails du journal de copie granulaire pour le disque client

DataBoxDiskGranularCopyProgress

Progression de la copie granulaire du disque DataBox

DataBoxDiskJobDetails

Détails du travail de disque DataBox.

DataBoxDiskJobSecrets

Secrets liés à la tâche de disque.

DataBoxHeavyAccountCopyLogDetails

Copier les détails du journal pour un compte de stockage pour Databox lourd

DataBoxHeavyJobDetails

Détails du travail d’appareil lourd Databox

DataBoxHeavyJobSecrets

Secrets liés à un travail lourd databox.

DataBoxHeavySecret

Secrets liés à un databox lourd.

DataBoxJobDetails

Détails du travail Databox

DataBoxManagementClientOptionalParams

Paramètres facultatifs pour le client.

DataBoxScheduleAvailabilityRequest

Demander au corps d’obtenir la disponibilité pour la planification des commandes data box.

DataBoxSecret

Secrets liés à un DataBox.

DataExportDetails

Détails des données à utiliser pour exporter des données à partir d’Azure.

DataImportDetails

Détails des données à utiliser pour l’importation de données dans Azure.

DataLocationToServiceLocationMap

Mappage de l’emplacement des données à l’emplacement du service

DataTransferDetailsValidationRequest

Demande de validation des détails de l’exportation et de l’importation des données.

DataTransferDetailsValidationResponseProperties

Propriétés de la réponse de validation des détails du transfert de données.

DataboxJobSecrets

Secrets liés à un travail databox.

DatacenterAddressInstructionResponse

Instruction du centre de données pour un emplacement de stockage donné.

DatacenterAddressLocationResponse

Adresse du centre de données pour un emplacement de stockage donné.

DatacenterAddressRequest

Corps de la demande pour obtenir l’adresse du centre de données.

DatacenterAddressResponse

Adresse du centre de données pour un emplacement de stockage donné.

DcAccessSecurityCode

Code de sécurité d’accès dc

Details

Interface du modèle Détails

DeviceCapabilityDetails

Détails de la fonctionnalité d’appareil pour une référence SKU donnée pour une région donnée.

DeviceCapabilityRequest

Corps de la demande pour obtenir les fonctionnalités de l’appareil pour la référence SKU donnée.

DeviceCapabilityResponse

Fonctionnalités d’appareil pour une référence SKU donnée dans une région

DeviceErasureDetails

Détails de l’effacement de l’appareil avec l’état d’achèvement de l’effacement, la clé sas d’effacement sécurisé et la clé sas d’effacement ou de destruction.

DiskScheduleAvailabilityRequest

Demander au corps d’obtenir la disponibilité pour la planification des commandes de disque.

DiskSecret

Contient tous les secrets d’un disque.

EncryptionPreferences

Préférences liées au chiffrement.

ErrorDetail

interface modèle ErrorDetail

ExportDiskDetails

Exporter les détails du disque

FilterFileDetails

Détails des fichiers de filtre à utiliser pour le transfert de données.

GranularCopyLogDetails

Détails granulaires du journal généré lors de la copie.

GranularCopyProgress

Progression granulaire de la copie.

HeavyScheduleAvailabilityRequest

Demander au corps d’obtenir la disponibilité pour planifier des commandes lourdes.

IdentityProperties

Propriétés d’identité managée.

ImportDiskDetails

Détails de l’importation du disque

JobDelayDetails

Détails de la notification de retard du travail

JobDeliveryInfo

Informations de remise supplémentaires.

JobDetails

Détails du travail.

JobProperties

Propriétés du travail

JobResource

Ressource de travail.

JobResourceUpdateParameter

Le JobResourceUpdateParameter.

JobSecrets

Classe de base pour les secrets

JobStages

Étapes du travail.

JobsBookShipmentPickUpOptionalParams

Paramètres facultatifs.

JobsCancelOptionalParams

Paramètres facultatifs.

JobsCreateOptionalParams

Paramètres facultatifs.

JobsDeleteOptionalParams

Paramètres facultatifs.

JobsGetOptionalParams

Paramètres facultatifs.

JobsListByResourceGroupOptionalParams

Paramètres facultatifs.

JobsListCredentialsOptionalParams

Paramètres facultatifs.

JobsListOptionalParams

Paramètres facultatifs.

JobsMarkDevicesShippedOptionalParams

Paramètres facultatifs.

JobsOperations

Interface représentant une opération Jobs.

JobsUpdateOptionalParams

Paramètres facultatifs.

KeyEncryptionKey

Clé de chiffrement contenant des détails sur la clé pour chiffrer différentes clés.

LastMitigationActionOnJob

Dernière action d’atténuation effectuée sur le travail

ManagedDiskDetails

Détails des disques managés.

MarkDevicesShippedRequest

Corps de la demande pour fournir les détails du package de remise du travail

MitigateJobRequest

Travail d’atténuation capturé à partir du corps de la demande pour l’API d’atténuation

MitigateOptionalParams

Paramètres facultatifs.

NotificationPreference

Préférence de notification pour une phase de travail.

Operation

Entité d’opération.

OperationDisplay

Affichage de l’opération

OperationsListOptionalParams

Paramètres facultatifs.

OperationsOperations

Interface représentant des opérations.

PackageCarrierDetails

Détails de l’opérateur de package.

PackageCarrierInfo

informations sur l’opérateur de package

PackageShippingDetails

détails de l’expédition de package

PageSettings

Options de la méthode byPage

PagedAsyncIterableIterator

Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page.

Preferences

Préférences relatives à la commande

PreferencesValidationRequest

Demander de valider la préférence de transport et de centre de données.

PreferencesValidationResponseProperties

Propriétés du centre de données et de la réponse de validation des préférences de transport.

RegionConfigurationRequest

Corps de la demande pour obtenir la configuration de la région.

RegionConfigurationResponse

Réponse de configuration spécifique à une région.

Resource

Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager

ResourceIdentity

Détails de l’identité Msi de la ressource

RestorePollerOptions
ReverseShippingDetails

Adresse d’expédition inversée et coordonnées d’un travail.

ScheduleAvailabilityRequest

Demander au corps d’obtenir la disponibilité des commandes de planification.

ScheduleAvailabilityResponse

Planifiez la disponibilité de la référence SKU donnée dans une région.

ServiceListAvailableSkusByResourceGroupOptionalParams

Paramètres facultatifs.

ServiceOperations

Interface représentant une opération de service.

ServiceRegionConfigurationByResourceGroupOptionalParams

Paramètres facultatifs.

ServiceRegionConfigurationOptionalParams

Paramètres facultatifs.

ServiceValidateAddressOptionalParams

Paramètres facultatifs.

ServiceValidateInputsByResourceGroupOptionalParams

Paramètres facultatifs.

ServiceValidateInputsOptionalParams

Paramètres facultatifs.

ShareCredentialDetails

Détails des informations d’identification des partages dans le compte.

ShipmentPickUpRequest

Détails de la demande de livraison.

ShipmentPickUpResponse

Réponse de prise en charge de l’expédition.

ShippingAddress

Adresse d’expédition où le client souhaite recevoir l’appareil.

SimplePollerLike

Un polleur simple qui peut être utilisé pour interroger une opération de longue durée.

Sku

Référence SKU.

SkuAvailabilityValidationRequest

Demande de validation de la disponibilité de la référence SKU.

SkuAvailabilityValidationResponseProperties

Propriétés de la réponse de validation de la disponibilité de la référence SKU.

SkuCapacity

Capacité de la référence SKU.

SkuCost

Décrit les métadonnées pour récupérer les informations de prix.

SkuInformation

Informations de la référence SKU.

SkuProperties

Propriétés du SKU.

StorageAccountDetails

Détails du compte de stockage.

SubscriptionIsAllowedToCreateJobValidationRequest

Demandez à valider l’autorisation d’abonnement pour créer des travaux.

SubscriptionIsAllowedToCreateJobValidationResponseProperties

Propriétés de l’autorisation d’abonnement pour créer une réponse de validation de travail.

SystemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

TrackedResource

Définition du modèle de ressource pour une ressource de niveau supérieur suivi d’Azure Resource Manager qui a des « balises » et un « emplacement »

TransferAllDetails

Détails pour transférer toutes les données.

TransferConfiguration

Configuration pour définir le transfert de données.

TransferConfigurationTransferAllDetails

Mappage du type de filtre et des détails pour transférer toutes les données. Ce champ n’est requis que si transferConfigurationType est donné en tant que TransferAll

TransferConfigurationTransferFilterDetails

Mappage du type de filtre et des détails à filtrer. Ce champ n’est requis que si transferConfigurationType est donné en tant que TransferUsingFilter.

TransferFilterDetails

Détails du filtrage du transfert de données.

TransportAvailabilityDetails

Détails de disponibilité des options de transport pour une région donnée.

TransportAvailabilityRequest

Corps de la demande pour obtenir la disponibilité du transport pour la référence SKU donnée.

TransportAvailabilityResponse

Options de transport disponibles pour une référence SKU donnée dans une région.

TransportPreferences

Préférences relatives à la logistique d’expédition de la référence SKU

UnencryptedCredentials

Informations d’identification non chiffrées pour accéder à l’appareil.

UpdateJobDetails

Détails du travail pour la mise à jour.

UpdateJobProperties

Propriétés du poste pour mise à jour

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

UserAssignedProperties

Propriétés d’identité attribuées par l’utilisateur.

ValidateAddress

Conditions requises pour valider l’adresse du client où l’appareil doit être expédié.

ValidationInputRequest

Champs minimaux qui doivent être présents dans n’importe quel type de demande de validation.

ValidationInputResponse

Propriétés minimales qui doivent être présentes dans chaque réponse de validation individuelle.

ValidationRequest

Exigence minimale de demande de n’importe quelle catégorie de validation.

ValidationResponse

Réponse des validations de création de travaux préalables.

ValidationResponseProperties

Propriétés de la réponse de validation avant création d’emploi.

Alias de type

AccessProtocol

Protocoles d’accès pris en charge sur l’appareil.

AddressType

Type d’adresse.

AddressValidationStatus

L’état de validation de l’adresse.

AzureSupportedClouds

Valeurs prises en charge pour le paramètre cloud en tant que type littéral de chaîne

ClassDiscriminator

Indique le type de détails du travail.

ContinuablePage

Interface qui décrit une page de résultats.

CopyLogDetailsUnion

Alias pour CopyLogDetailsUnion

CopyStatus

Le statut de la copie
KnownCopyStatus pouvez être utilisé de manière interchangeable avec CopyStatus, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

NotStarted: la copie de données n’a pas encore démarré.
InProgress: la copie de données est en cours.
terminé: copie de données terminée.
CompletedWithErrors: copie de données terminée avec des erreurs.
échec: échec de la copie des données. Aucune donnée n’a été copiée.
NotReturned: aucune copie déclenchée en tant qu’appareil n’a pas été retourné.
HardwareError: l’appareil a rencontré des problèmes matériels.
DeviceFormatted: échec de la copie des données. L’appareil a été mis en forme par l’utilisateur.
DeviceMetadataModified: échec de la copie des données. Les métadonnées de l’appareil ont été modifiées par l’utilisateur.
StorageAccountNotAccessible: échec de la copie des données. Le compte de stockage n’a pas été accessible pendant la copie.
Non pris en chargeData : échec de la copie des données. Le contenu des données de l’appareil n’est pas pris en charge.
DriveNotReceived: aucune copie déclenchée lorsque l’appareil n’a pas été reçu.
UnsupportedDrive: aucune copie déclenchée en tant que type d’appareil n’est pas prise en charge.
OtherServiceError: la copie a échoué en raison d’une erreur de service.
OtherUserError: la copie a échoué en raison d’une erreur utilisateur.
DriveNotDetected: la copie a échoué en raison d’une erreur de détection de disque.
DriveCorrupted: la copie a échoué en raison d’un lecteur endommagé.
MetadataFilesModifiedOrRemoved: la copie a échoué en raison de fichiers de métadonnées modifiés ou supprimés.

CreatedByType

Type d’entité qui a créé la ressource.
KnownCreatedByType peut être utilisé de manière interchangeable avec CreatedByType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

'utilisateur: l’entité a été créée par un utilisateur.
Application: l’entité a été créée par une application.
ManagedIdentity: l’entité a été créée par une identité managée.
Key: l’entité a été créée par une clé.

CustomerResolutionCode

Code de résolution fourni par le client.

DataAccountDetailsUnion

Alias pour DataAccountDetailsUnion

DataAccountType

Type du compte.

DataCenterCode

Code DataCenter.
KnownDataCenterCode peut être utilisé de manière interchangeable avec DataCenterCode, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

non valide
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
Réf. CPQ21
OSA23

DatacenterAddressResponseUnion

Alias pour DatacenterAddressResponseUnion

DatacenterAddressType

Type d’adresse du centre de données

DelayNotificationStatus

Statut de la notification
KnownDelayNotificationStatus pouvez être utilisé de manière interchangeable avec DelayNotificationStatus, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

actif : le délai est toujours actif
résolu : le délai a été résolu

DoubleEncryption

Définit la couche secondaire d’activation du chiffrement basé sur le logiciel.

FilterFileType

Type du fichier de filtre.

GranularCopyLogDetailsUnion

Alias pour GranularCopyLogDetailsUnion

HardwareEncryption

Prise en charge du chiffrement matériel pour une référence SKU donnée pour une région donnée.

JobDeliveryType

Type de travail de remise.

JobDetailsUnion

Alias pour JobDetailsUnion

JobSecretsUnion

Alias pour JobSecretsUnion

KekType

Type de clé de chiffrement utilisée pour le chiffrement de clé.

LogCollectionLevel

Niveau des journaux à collecter.

ModelName

Nom convivial du client de la combinaison de version et de capacité de l’appareil. Ce champ est nécessaire uniquement au moment de commander l’appareil de nouvelle génération, c’est-à-dire AzureDataBox120 et AzureDataBox525 à compter de février/2025

NotificationStageName

Nom de l’étape.
KnownNotificationStageName peut être utilisé de manière interchangeable avec NotificationStageName, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

DevicePrepared: notification à l’étape préparée par l’appareil.
distribuée : notification à l’étape distribuée de l’appareil.
remise: notification à l’étape remise de l’appareil.
PickedUp: notification à l’appareil récupérée à partir de l’étape de l’utilisateur.
AtAzureDC: notification à l’appareil reçu au stade du centre de données Azure.
DataCopy: notification à l’étape de démarrage de la copie des données.
créé: notification à l’étape de création du travail.
ShippedToCustomer: notification sur les appareils expédiés à l’étape du client.

OverallValidationStatus

État général de la validation.

PortalDelayErrorCode

Code d’erreur de délai
KnownPortalDelayErrorCode peut être utilisé de manière interchangeable avec PortalDelayErrorCode, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

InternalIssueDelay: retard dû à des raisons internes
ActiveOrderLimitBreachedDelay: limite de commande active enfreinte.
HighDemandDelay: demande élevée
LargeNumberOfFilesDelay: copie lente en raison d’un grand nombre de fichiers

ReverseShippingDetailsEditStatus

État modifiable de l’adresse d’expédition inversée et des informations de contact

ReverseTransportPreferenceEditStatus

État modifiable des préférences de transport inverse

ScheduleAvailabilityRequestUnion

Alias pour ScheduleAvailabilityRequestUnion

ShareDestinationFormatType

Type du partage.

SkuDisabledReason

Raison pour laquelle la référence SKU est désactivée.

SkuName

Noms de SKU.

StageName

Nom de la phase en cours.
KnownStageName peut être utilisé de manière interchangeable avec StageName, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

DeviceOrdered: une commande a été créée.
DevicePrepared: un appareil a été préparé pour la commande.
distribué : l’appareil a été distribué à l’utilisateur de la commande.
remise: l’appareil a été remis à l’utilisateur de la commande.
pickedUp: l’appareil a été récupéré à partir de l’utilisateur et en transit vers le centre de données Azure.
AtAzureDC: l’appareil a été reçu dans le centre de données Azure de l’utilisateur.
DataCopy: copie de données à partir de l’appareil dans le centre de données Azure.
Terminé: la commande est terminée.
CompletedWithErrors: l’ordre s’est terminé avec des erreurs.
Annulation: la commande a été annulée.
Failed_IssueReportedAtCustomer: l’ordre a échoué en raison d’un problème signalé par l’utilisateur.
Failed_IssueDetectedAtAzureDC: l’ordre a échoué en raison d’un problème détecté dans le centre de données Azure.
abandonnée : l’ordre a été abandonné.
CompletedWithWarnings: commande terminée avec des avertissements.
ReadyToDispatchFromAzureDC: l’appareil est prêt à être remis au client à partir d’Azure DC.
ReadyToReceiveAtAzureDC: l’appareil peut être supprimé sur Azure DC.
Créé: travail créé par le client.
ShippedToAzureDC: l’utilisateur a expédié l’appareil à AzureDC.
A waitingShipmentDetails: attente des détails de l’expédition de l’appareil du client.
PreparationToShipFromAzureDC: préparation de l’appareil à expédier au client.
ShippedToCustomer: expédié l’appareil au client.

StageStatus

Contient l’état d’achèvement de l’effacement de l’appareil

TransferConfigurationType

Type de la configuration pour le transfert.

TransferType

Type du transfert.

TransportShipmentTypes

Type d’expédition de transport pris en charge pour une région donnée.

ValidationInputDiscriminator

Identifie le type de demande de validation.

ValidationInputRequestUnion

Alias pour ValidationInputRequestUnion

ValidationInputResponseUnion

Alias pour ValidationInputResponseUnion

ValidationRequestUnion

Alias pour ValidationRequestUnion

ValidationStatus

Créez le statut de validation de la limite de commande.

Énumérations

AzureClouds

Une énumération pour décrire les environnements Cloud Azure.

KnownCopyStatus

État de la copie

KnownCreatedByType

Type d’entité qui a créé la ressource.

KnownDataCenterCode

Code DataCenter.

KnownDelayNotificationStatus

État de la notification

KnownNotificationStageName

Nom de l’étape.

KnownPortalDelayErrorCode

Retarder le code d’erreur

KnownStageName

Nom de la phase en cours.

KnownVersions

Versions d’API disponibles.

Functions

isRestError(unknown)

Typeguard pour RestError

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

Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

Variables

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

Informations relatives à la fonction

isRestError(unknown)

Typeguard pour RestError

function isRestError(e: unknown): e

Paramètres

e

unknown

Quelque chose d’intercepté par une clause catch.

Retours

e

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

Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.

function restorePoller<TResponse, TResult>(client: DataBoxManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Paramètres

serializedState

string

sourceOperation

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

Retours

PollerLike<OperationState<TResult>, TResult>

Détails de variable

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

RestError: RestErrorConstructor

Type