@azure/arm-databox package

Gränssnitt

AccountCredentialDetails

Information om autentiseringsuppgifter för kontot.

AdditionalErrorInfo

Den här klassen representerar ytterligare information som resursprovidrar skickar när ett fel inträffar.

AddressValidationOutput

Utdata från api:et för adressverifiering.

AddressValidationProperties

Adressvalideringsutdata.

ApiError

modellgränssnitt ApiError

ApplianceNetworkConfiguration

Nätverkskortkonfigurationen för en DataBox.

AvailableSkuRequest

Filtren för att visa tillgängliga sku:er.

AzureFileFilterDetails

Filtrera information för att överföra Azure-filer

BlobFilterDetails

Filtrera information för att överföra Azure Blobs

CancellationReason

Orsak till annullering.

CloudError

Innehåller ytterligare information om ett http-felsvar.

ContactDetails

Kontaktuppgifter.

ContactInfo

Kontaktinformation.

CopyLogDetails

Information om loggen som genereras under kopiering.

CopyProgress

Kopieringsstatus.

CreateJobValidations

Det gör alla valideringar för att skapa förjobb.

CreateOrderLimitForSubscriptionValidationRequest

Begäran om att verifiera gränsen för att skapa order för den aktuella prenumerationen.

CreateOrderLimitForSubscriptionValidationResponseProperties

Egenskaper för att skapa ordergräns för svar på prenumerationsverifiering.

CustomerDiskJobSecrets

Hemligheterna som är relaterade till kundens diskjobb.

DataAccountDetails

Kontoinformation för de data som ska överföras

DataBoxAccountCopyLogDetails

Kopiera logginformation för ett lagringskonto för ett DataBox-jobb

DataBoxCustomerDiskCopyLogDetails

Kopiera logginformation för kunddisk

DataBoxCustomerDiskCopyProgress

Förlopp för DataBox CustomerDisk-kopiering

DataBoxCustomerDiskJobDetails

Information om kundens diskjobb.

DataBoxDiskCopyLogDetails

Kopiera logginformation för en disk

DataBoxDiskCopyProgress

Förlopp för DataBox-diskkopiering

DataBoxDiskGranularCopyLogDetails

Detaljerad information om kopieringslogg för kunddisk

DataBoxDiskGranularCopyProgress

DataBox Disk Detaljerad kopieringsstatus

DataBoxDiskJobDetails

DataBox Disk-jobbinformation.

DataBoxDiskJobSecrets

Hemligheterna som rör diskjobbet.

DataBoxHeavyAccountCopyLogDetails

Kopiera logginformation för ett lagringskonto för Databox Heavy

DataBoxHeavyJobDetails

Information om databox-jobb för tunga enheter

DataBoxHeavyJobSecrets

Hemligheterna som är relaterade till ett tungt databox-jobb.

DataBoxHeavySecret

Hemligheterna som är relaterade till en stor datalåda.

DataBoxJobDetails

Information om databox-jobb

DataBoxManagementClientOptionalParams

Valfria parametrar för klienten.

DataBoxScheduleAvailabilityRequest

Begär brödtext för att få tillgängligheten för schemaläggning av beställningar av datarutor.

DataBoxSecret

Hemligheterna som är relaterade till en DataBox.

DataExportDetails

Information om de data som ska användas för att exportera data från Azure.

DataImportDetails

Information om de data som ska användas för att importera data till Azure.

DataLocationToServiceLocationMap

Karta över dataplats till tjänstplats

DataTransferDetailsValidationRequest

Begäran om att verifiera information om export och import av data.

DataTransferDetailsValidationResponseProperties

Egenskaper för verifieringssvar för dataöverföringsinformation.

DataboxJobSecrets

Hemligheterna som är relaterade till ett databox-jobb.

DatacenterAddressInstructionResponse

Datacenterinstruktion för angiven lagringsplats.

DatacenterAddressLocationResponse

Datacenteradress för angiven lagringsplats.

DatacenterAddressRequest

Begär brödtext för att hämta datacenteradressen.

DatacenterAddressResponse

Datacenteradress för angiven lagringsplats.

DcAccessSecurityCode

Dc-åtkomstsäkerhetskod

Details

Modellgränssnitt Detaljer

DeviceCapabilityDetails

Information om enhetsfunktioner för en viss SKU för en viss region.

DeviceCapabilityRequest

Begär brödtext för att hämta enhetsfunktionerna för angiven sku.

DeviceCapabilityResponse

Enhetsfunktioner för angiven SKU i en region

DeviceErasureDetails

Information om enhetsradering med status för slutförande av radering, säker radering SAS-nyckel och ErasureorDestructionLog SAS-nyckel

DiskScheduleAvailabilityRequest

Begär brödtext för att få tillgängligheten för schemaläggning av diskbeställningar.

DiskSecret

Innehåller alla hemligheter för en disk.

EncryptionPreferences

Inställningar som är relaterade till krypteringen.

ErrorDetail

modellgränssnitt ErrorDetail

ExportDiskDetails

Exportera diskinformation

FilterFileDetails

Information om de filterfiler som ska användas för dataöverföring.

GranularCopyLogDetails

Detaljerad information för loggen som genereras under kopiering.

GranularCopyProgress

Förlopp för detaljerad kopiering.

HeavyScheduleAvailabilityRequest

Begär brödtext för att få tillgänglighet för schemaläggning av tunga beställningar.

IdentityProperties

Egenskaper för hanterad identitet.

ImportDiskDetails

Importera diskinformation

JobDelayDetails

Information om meddelande om jobbfördröjning

JobDeliveryInfo

Ytterligare leveransinformation.

JobDetails

Jobbinformation.

JobProperties

Jobbegenskaper

JobResource

Jobbresurs.

JobResourceUpdateParameter

The JobResourceUpdateParameter.

JobSecrets

Basklassen för hemligheterna

JobStages

Jobbfaser.

JobsBookShipmentPickUpOptionalParams

Valfria parametrar.

JobsCancelOptionalParams

Valfria parametrar.

JobsCreateOptionalParams

Valfria parametrar.

JobsDeleteOptionalParams

Valfria parametrar.

JobsGetOptionalParams

Valfria parametrar.

JobsListByResourceGroupOptionalParams

Valfria parametrar.

JobsListCredentialsOptionalParams

Valfria parametrar.

JobsListOptionalParams

Valfria parametrar.

JobsMarkDevicesShippedOptionalParams

Valfria parametrar.

JobsOperations

Gränssnitt som representerar en jobbåtgärd.

JobsUpdateOptionalParams

Valfria parametrar.

KeyEncryptionKey

Krypteringsnyckel som innehåller information om nyckeln för att kryptera olika nycklar.

LastMitigationActionOnJob

Senaste åtgärd som utförts på jobbet

ManagedDiskDetails

Information om de hanterade diskarna.

MarkDevicesShippedRequest

Begärandetexten för att ange leveranspaketinformationen för jobbet

MitigateJobRequest

Åtgärdsjobbet som samlas in från begärandetexten för Mitigate API

MitigateOptionalParams

Valfria parametrar.

NotificationPreference

Meddelandeinställning för ett jobbsteg.

Operation

Åtgärdsentitet.

OperationDisplay

Åtgärdsvisning

OperationsListOptionalParams

Valfria parametrar.

OperationsOperations

Gränssnitt som representerar åtgärder.

PackageCarrierDetails

Pakettransportinformation.

PackageCarrierInfo

pakettransportinformation

PackageShippingDetails

paketleveransinformation

PageSettings

Alternativ för byPage-metoden

PagedAsyncIterableIterator

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.

Preferences

Inställningar relaterade till ordern

PreferencesValidationRequest

Begäran om att validera inställningar för transport och datacenter.

PreferencesValidationResponseProperties

Egenskaper för valideringssvar för datacenter och transportpreferenser.

RegionConfigurationRequest

Begär brödtext för att hämta konfigurationen för regionen.

RegionConfigurationResponse

Konfigurationssvar som är specifikt för en region.

Resource

Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser

ResourceIdentity

Msi-identitetsinformation för resursen

RestorePollerOptions
ReverseShippingDetails

Adress för omvänd leverans och kontaktuppgifter för ett jobb.

ScheduleAvailabilityRequest

Begär brödtext för att få tillgänglighet för schemaläggning av beställningar.

ScheduleAvailabilityResponse

Schemalägg tillgänglighet för angiven sku i en region.

ServiceListAvailableSkusByResourceGroupOptionalParams

Valfria parametrar.

ServiceOperations

Gränssnitt som representerar en tjänstoperation.

ServiceRegionConfigurationByResourceGroupOptionalParams

Valfria parametrar.

ServiceRegionConfigurationOptionalParams

Valfria parametrar.

ServiceValidateAddressOptionalParams

Valfria parametrar.

ServiceValidateInputsByResourceGroupOptionalParams

Valfria parametrar.

ServiceValidateInputsOptionalParams

Valfria parametrar.

ShareCredentialDetails

Information om autentiseringsuppgifter för resurserna i kontot.

ShipmentPickUpRequest

Information om leveranshämtningsbegäran.

ShipmentPickUpResponse

Hämtningssvar för försändelsen.

ShippingAddress

Leveransadress där kunden vill ta emot enheten.

SimplePollerLike

En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd.

Sku

Sku:n.

SkuAvailabilityValidationRequest

Begäran om att verifiera SKU-tillgängligheten.

SkuAvailabilityValidationResponseProperties

Egenskaper för svar på SKU-tillgänglighetsverifiering.

SkuCapacity

SKU:ns kapacitet.

SkuCost

Beskriver metadata för att hämta prisinformation.

SkuInformation

Information om sku:n.

SkuProperties

Egenskaper hos SKU:n.

StorageAccountDetails

Information om lagringskontot.

SubscriptionIsAllowedToCreateJobValidationRequest

Begäran om att verifiera prenumerationsbehörighet för att skapa jobb.

SubscriptionIsAllowedToCreateJobValidationResponseProperties

Egenskaper för prenumerationsbehörighet för att skapa jobbvalideringssvar.

SystemData

Metadata som rör skapande och senaste ändring av resursen.

TrackedResource

Resursmodelldefinitionen för en Azure Resource Manager-spårad resurs på den översta nivån som har "taggar" och en "plats"

TransferAllDetails

Information för att överföra alla data.

TransferConfiguration

Konfiguration för att definiera överföring av data.

TransferConfigurationTransferAllDetails

Karta över filtertyp och information för att överföra alla data. Det här fältet krävs endast om TransferConfigurationType anges som TransferAll

TransferConfigurationTransferFilterDetails

Mappning av filtertyp och information som ska filtreras. Det här fältet krävs endast om TransferConfigurationType anges som TransferUsingFilter.

TransferFilterDetails

Information om filtrering av dataöverföring.

TransportAvailabilityDetails

Tillgänglighetsinformation för transportalternativ för en viss region.

TransportAvailabilityRequest

Begär brödtext för att hämta transporttillgängligheten för angiven sku.

TransportAvailabilityResponse

Transportalternativ som är tillgängliga för angiven SKU i en region.

TransportPreferences

Inställningar relaterade till leveranslogistiken för sku:n

UnencryptedCredentials

Okrypterade autentiseringsuppgifter för åtkomst till enheten.

UpdateJobDetails

Jobbinformation för uppdatering.

UpdateJobProperties

Jobbegenskaper för uppdatering

UserAssignedIdentity

Användartilldelade identitetsegenskaper

UserAssignedProperties

Användartilldelade identitetsegenskaper.

ValidateAddress

Kraven för att verifiera kundadressen där enheten måste levereras.

ValidationInputRequest

Minsta fält som måste finnas i alla typer av valideringsbegäran.

ValidationInputResponse

Minsta egenskaper som ska finnas i varje enskilt valideringssvar.

ValidationRequest

Minimikrav för begäran för alla valideringskategorier.

ValidationResponse

Svar på valideringar före jobbskapande.

ValidationResponseProperties

Egenskaper hos valideringsresponsen före jobbskapande.

Typalias

AccessProtocol

Åtkomstprotokoll som stöds på enheten.

AddressType

Typ av adress.

AddressValidationStatus

Adressens valideringsstatus.

AzureSupportedClouds

De värden som stöds för molninställningen som en strängliteraltyp

ClassDiscriminator

Anger typen av jobbinformation.

ContinuablePage

Ett gränssnitt som beskriver en resultatsida.

CopyLogDetailsUnion

Alias för CopyLogDetailsUnion

CopyStatus

Kopians status
KnownCopyStatus kan användas omväxlande med CopyStatus innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

NotStarted: Datakopiering har inte startat ännu.
InProgress: Datakopiering pågår.
Slutförd: Datakopian har slutförts.
CompletedWithErrors: Datakopiering slutfördes med fel.
Misslyckades: Datakopian misslyckades. Inga data kopierades.
NotReturned: Ingen kopia utlöstes eftersom enheten inte returnerades.
HardwareError: Enheten har drabbats av maskinvaruproblem.
DeviceFormatted: Datakopian misslyckades. Enheten har formaterats av användaren.
DeviceMetadataModified: Datakopian misslyckades. Enhetsmetadata ändrades av användaren.
StorageAccountNotAccessible: Datakopian misslyckades. Lagringskontot var inte tillgängligt under kopiering.
Data som inte stöds: Datakopian misslyckades. Enhetens datainnehåll stöds inte.
DriveNotReceived: Ingen kopia utlöstes eftersom enheten inte togs emot.
Stöds inteDrive-: Ingen kopiering som utlöses som enhetstyp stöds inte.
OtherServiceError: Kopiering misslyckades på grund av tjänstfel.
OtherUserError: Kopiering misslyckades på grund av användarfel.
DriveNotDetected: Kopiering misslyckades på grund av diskidentifieringsfel.
DriveCorrupted: Kopiering misslyckades på grund av skadad enhet.
MetadataFilesModifiedOrRemoved: Kopiering misslyckades på grund av ändrade eller borttagna metadatafiler.

CreatedByType

Den typ av entitet som skapade resursen.
KnownCreatedByType- kan användas utbytbart med CreateByType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Användare: Entiteten skapades av en användare.
Application: Entiteten skapades av ett program.
ManagedIdentity: Entiteten skapades av en hanterad identitet.
Nyckel: Entiteten skapades av en nyckel.

CustomerResolutionCode

Lösningskod som tillhandahålls av kunden.

DataAccountDetailsUnion

Alias för DataAccountDetailsUnion

DataAccountType

Typ av konto.

DataCenterCode

DataCenter-kod.
KnownDataCenterCode- kan användas utbytbart med DataCenterCode innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Ogiltig
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 för DatacenterAddressResponseUnion

DatacenterAddressType

Adresstyp för datacenter

DelayNotificationStatus

Status för anmälan
KnownDelayNotificationStatus kan användas utbytbart med DelayNotificationStatus innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Aktiv: Fördröjningen är fortfarande aktiv
Löst: Fördröjningen har lösts

DoubleEncryption

Definierar sekundärt lager av programvarubaserad krypteringsaktivering.

FilterFileType

Typ av filterfil.

GranularCopyLogDetailsUnion

Alias för GranularCopyLogDetailsUnion

HardwareEncryption

Stöd för maskinvarukryptering för en viss SKU för en viss region.

JobDeliveryType

Leveranstyp för Jobb.

JobDetailsUnion

Alias för JobDetailsUnion

JobSecretsUnion

Alias för JobSecretsUnion

KekType

Typ av krypteringsnyckel som används för nyckelkryptering.

LogCollectionLevel

Nivå för loggarna som ska samlas in.

ModelName

Det kundanpassade namnet på kombinationen av version och kapacitet för enheten. Det här fältet är endast nödvändigt vid tidpunkten för beställningen av den nyare generationens enhet, dvs. AzureDataBox120 och AzureDataBox525 från och med februari/2025

NotificationStageName

Namnet på fasen.
KnownNotificationStageName kan användas utbytbart med NotificationStageName innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

DevicePrepared: Notification at device prepared stage (Meddelande i enhetsbearbetade skede).
Dispatched: Notification at device dispatched stage .
Levereras: Meddelande i enhetslevereringsfasen.
PickedUp: Meddelande på enheten hämtas från användarsteget.
AtAzureDC: Meddelande på enheten som tas emot i Azures datacenterstadium.
DataCopy: Meddelande vid startsteget för datakopiering.
Skapad: Meddelande i jobbskapandefasen.
ShippedToCustomer: Meddelande på levererade enheter till kundfasen.

OverallValidationStatus

Övergripande valideringsstatus.

PortalDelayErrorCode

Fördröjningsfelkod
KnownPortalDelayErrorCode kan användas utbytbart med PortalDelayErrorCode innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

InternalIssueDelay: Fördröjning på grund av interna orsaker
ActiveOrderLimitBreachedDelay: Gränsen för aktiv order har överskridits.
HighDemandDelay: Hög efterfrågan
LargeNumberOfFilesDelay: Långsam kopiering på grund av ett stort antal filer

ReverseShippingDetailsEditStatus

Redigerbar status för omvänd leveransadress och kontaktinformation

ReverseTransportPreferenceEditStatus

Redigerbar status för inställningar för omvänd transport

ScheduleAvailabilityRequestUnion

Alias för SchemaTillgänglighetBegäranFackförening

ShareDestinationFormatType

Typ av resurs.

SkuDisabledReason

Orsak till att SKU:n är inaktiverad.

SkuName

SKU-namn.

StageName

Namn på den fas som pågår.
KnownStageName kan användas utbytbart med StageName innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

DeviceOrdered: En order har skapats.
DevicePrepared: En enhet har förberetts för beställningen.
Dispatched: Enheten har skickats till användaren av ordern.
Levereras: Enheten har levererats till användaren av ordern.
PickedUp: Enheten har hämtats från användaren och under överföring till Azure-datacentret.
AtAzureDC: Enheten har tagits emot i Azure-datacentret från användaren.
DataCopy: Datakopiering från enheten i Azure-datacentret.
Slutförd: Beställningen har slutförts.
CompletedWithErrors: Beställningen har slutförts med fel.
Annullerad: Beställningen har avbrutits.
Failed_IssueReportedAtCustomer: Beställningen misslyckades på grund av problem som rapporterats av användaren.
Failed_IssueDetectedAtAzureDC: Beställningen misslyckades på grund av ett problem som identifierats i Azure-datacentret.
avbröts: Ordningen har avbrutits.
CompletedWithWarnings: Order har slutförts med varningar.
ReadyToDispatchFromAzureDC: Enheten är redo att överlämnas till kunden från Azure DC.
ReadyToReceiveAtAzureDC: Enheten kan släppas i Azure DC.
Skapad: Jobb som skapats av kunden.
ShippedToAzureDC: Användaren skickade enheten till AzureDC.
AwaitingShipmentDetails: Väntar på leveransinformation om enheten från kunden.
PreparingToShipFromAzureDC: Förbereder enheten för leverans till kund.
ShippedToCustomer: Levererade enheten till kunden.

StageStatus

Innehåller statusen för slutförande av enhetens radering

TransferConfigurationType

Typ av konfiguration för överföring.

TransferType

Typ av överföring.

TransportShipmentTypes

Transportsändningstyp som stöds för den angivna regionen.

ValidationInputDiscriminator

Identifierar typen av valideringsbegäran.

ValidationInputRequestUnion

Alias för ValidationInputRequestUnion

ValidationInputResponseUnion

Alias för ValidationInputResponseUnion

ValidationRequestUnion

Alias för ValidationRequestUnion

ValidationStatus

Skapa valideringsstatus för ordergräns.

Uppräkningar

AzureClouds

En uppräkning för att beskriva Azure Cloud-miljöer.

KnownCopyStatus

Kopians status

KnownCreatedByType

Den typ av entitet som skapade resursen.

KnownDataCenterCode

DataCenter-kod.

KnownDelayNotificationStatus

Status för meddelande

KnownNotificationStageName

Namnet på fasen.

KnownPortalDelayErrorCode

Felkod för fördröjning

KnownStageName

Namn på den fas som pågår.

KnownVersions

Tillgängliga API-versioner.

Funktioner

isRestError(unknown)

Typeguard för RestError

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

Variabler

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

Funktionsinformation

isRestError(unknown)

Typeguard för RestError

function isRestError(e: unknown): e

Parametrar

e

unknown

Något som fångas av en fångstklausul.

Returer

e

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

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

Parametrar

serializedState

string

sourceOperation

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

Returer

PollerLike<OperationState<TResult>, TResult>

Variabelinformation

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

RestError: RestErrorConstructor

Typ