Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AutoPR @azure/arm-databox] Update readme.python.md #3743

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions sdk/databox/arm-databox/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,8 @@
# Release History

## 5.0.0 (2023-02-10)

## 5.0.0-beta.4 (Unreleased)

### Features Added

### Breaking Changes

### Bugs Fixed

### Other Changes

## 5.0.0-beta.3 (2022-11-18)

The package of @azure/arm-databox is using our next generation design principles since version 5.0.0-beta.3, which contains breaking changes.
The package of @azure/arm-databox is using our next generation design principles since version 5.0.0, which contains breaking changes.

To understand the detail of the change, please refer to [Changelog](https://aka.ms/js-track2-changelog).

Expand Down
2 changes: 1 addition & 1 deletion sdk/databox/arm-databox/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2022 Microsoft
Copyright (c) 2023 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion sdk/databox/arm-databox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/databox/arm-databox) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-databox) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-databox?view=azure-node-preview) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-databox) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started
Expand Down
10 changes: 5 additions & 5 deletions sdk/databox/arm-databox/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "e6a2296d02ec6c4b2c32479198bfbcb9b16ea247",
"readme": "specification\\databox\\resource-manager\\readme.md",
"autorest_command": "autorest --version=3.8.4 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\databox\\resource-manager\\readme.md --use=@autorest/typescript@6.0.0-rc.3.20221108.1 --generate-sample=true",
"commit": "5770c558d9dd293617884206686440222c46ee49",
"readme": "specification/databox/resource-manager/readme.md",
"autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/databox/resource-manager/readme.md --use=@autorest/typescript@6.0.0-rc.5",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.4.2",
"use": "@autorest/typescript@6.0.0-rc.3.20221108.1"
"release_tool": "@azure-tools/js-sdk-release-tools@2.6.2",
"use": "@autorest/typescript@6.0.0-rc.5"
}
14 changes: 3 additions & 11 deletions sdk/databox/arm-databox/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for DataBoxManagementClient.",
"version": "5.0.0-beta.4",
"version": "5.0.0",
"engines": {
"node": ">=14.0.0"
},
Expand Down Expand Up @@ -110,13 +110,5 @@
}
]
},
"autoPublish": true,
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-databox?view=azure-node-preview"
}
}
"autoPublish": true
}
111 changes: 106 additions & 5 deletions sdk/databox/arm-databox/review/arm-databox.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,14 @@ export interface ContactDetails {
phoneExtension?: string;
}

// @public
export interface ContactInfo {
contactName: string;
mobile?: string;
phone: string;
phoneExtension?: string;
}

// @public
export interface CopyLogDetails {
copyLogDetailsType: "DataBox" | "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy";
Expand Down Expand Up @@ -177,7 +185,7 @@ export interface CustomerDiskJobSecrets extends JobSecrets {
}

// @public
export type CustomerResolutionCode = "None" | "MoveToCleanUpDevice" | "Resume";
export type CustomerResolutionCode = "None" | "MoveToCleanUpDevice" | "Resume" | "Restart" | "ReachOutToOperation";

// @public
export interface DataAccountDetails {
Expand Down Expand Up @@ -244,12 +252,29 @@ export interface DataBoxDiskCopyProgress {
readonly status?: CopyStatus;
}

// @public
export interface DataBoxDiskGranularCopyLogDetails extends GranularCopyLogDetails {
readonly accountId?: string;
copyLogDetailsType: "DataBoxCustomerDisk";
readonly errorLogLink?: string;
readonly serialNumber?: string;
readonly verboseLogLink?: string;
}

// @public
export interface DataBoxDiskGranularCopyProgress extends GranularCopyProgress {
readonly copyStatus?: CopyStatus;
readonly serialNumber?: string;
}

// @public
export interface DataBoxDiskJobDetails extends JobDetails {
readonly copyProgress?: DataBoxDiskCopyProgress[];
readonly disksAndSizeDetails?: {
[propertyName: string]: number;
};
readonly granularCopyLogDetails?: DataBoxDiskGranularCopyLogDetails[];
readonly granularCopyProgress?: DataBoxDiskGranularCopyProgress[];
jobDetailsType: "DataBoxDisk";
passkey?: string;
preferredDisks?: {
Expand Down Expand Up @@ -441,6 +466,12 @@ export interface Details {
message: string;
}

// @public
export interface DeviceErasureDetails {
readonly deviceErasureStatus?: StageStatus;
readonly erasureOrDestructionCertificateSasKey?: string;
}

// @public
export interface DiskScheduleAvailabilityRequest extends ScheduleAvailabilityRequest {
expectedDataSizeInTeraBytes: number;
Expand Down Expand Up @@ -492,6 +523,33 @@ export type FilterFileType = "AzureBlob" | "AzureFile";
// @public
export function getContinuationToken(page: unknown): string | undefined;

// @public
export interface GranularCopyLogDetails {
copyLogDetailsType: "DataBoxCustomerDisk";
}

// @public (undocumented)
export type GranularCopyLogDetailsUnion = GranularCopyLogDetails | DataBoxDiskGranularCopyLogDetails;

// @public
export interface GranularCopyProgress {
readonly accountId?: string;
readonly bytesProcessed?: number;
readonly dataAccountType?: DataAccountType;
readonly directoriesErroredOut?: number;
readonly filesErroredOut?: number;
readonly filesProcessed?: number;
readonly invalidDirectoriesProcessed?: number;
readonly invalidFileBytesUploaded?: number;
readonly invalidFilesProcessed?: number;
readonly isEnumerationInProgress?: boolean;
readonly renamedContainerCount?: number;
readonly storageAccountName?: string;
readonly totalBytesToProcess?: number;
readonly totalFilesToProcess?: number;
readonly transferType?: TransferType;
}

// @public
export interface HeavyScheduleAvailabilityRequest extends ScheduleAvailabilityRequest {
skuName: "DataBoxHeavy";
Expand Down Expand Up @@ -530,6 +588,7 @@ export interface JobDetails {
dataExportDetails?: DataExportDetails[];
dataImportDetails?: DataImportDetails[];
readonly deliveryPackage?: PackageShippingDetails;
readonly deviceErasureDetails?: DeviceErasureDetails;
expectedDataSizeInTeraBytes?: number;
jobDetailsType: "DataBoxCustomerDisk" | "DataBoxDisk" | "DataBoxHeavy" | "DataBox";
readonly jobStages?: JobStages[];
Expand All @@ -538,6 +597,7 @@ export interface JobDetails {
preferences?: Preferences;
readonly returnPackage?: PackageShippingDetails;
readonly reverseShipmentLabelSasKey?: string;
reverseShippingDetails?: ReverseShippingDetails;
shippingAddress?: ShippingAddress;
}

Expand All @@ -558,6 +618,8 @@ export interface JobResource extends Resource {
readonly isPrepareToShipEnabled?: boolean;
readonly isShippingAddressEditable?: boolean;
readonly name?: string;
readonly reverseShippingDetailsUpdate?: ReverseShippingDetailsEditStatus;
readonly reverseTransportPreferenceUpdate?: ReverseTransportPreferenceEditStatus;
readonly startTime?: Date;
readonly status?: StageName;
readonly systemData?: SystemData;
Expand Down Expand Up @@ -617,6 +679,11 @@ export interface JobsCreateOptionalParams extends coreClient.OperationOptions {
// @public
export type JobsCreateResponse = JobResource;

// @public
export interface JobsDeleteHeaders {
location?: string;
}

// @public
export interface JobsDeleteOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
Expand All @@ -643,7 +710,6 @@ export type JobsGetResponse = JobResource;

// @public
export interface JobsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
skipToken?: string;
}

// @public
Expand All @@ -666,7 +732,6 @@ export type JobsListCredentialsResponse = UnencryptedCredentialsList;

// @public
export interface JobsListNextOptionalParams extends coreClient.OperationOptions {
skipToken?: string;
}

// @public
Expand All @@ -693,6 +758,11 @@ export interface JobStages {
readonly stageTime?: Date;
}

// @public
export interface JobsUpdateHeaders {
location?: string;
}

// @public
export interface JobsUpdateOptionalParams extends coreClient.OperationOptions {
ifMatch?: string;
Expand Down Expand Up @@ -744,9 +814,11 @@ export enum KnownDataCenterCode {
AMS20 = "AMS20",
AUH20 = "AUH20",
BJB = "BJB",
BJS20 = "BJS20",
BL20 = "BL20",
BL7 = "BL7",
BN1 = "BN1",
BN7 = "BN7",
BOM01 = "BOM01",
BY1 = "BY1",
BY2 = "BY2",
Expand All @@ -759,6 +831,7 @@ export enum KnownDataCenterCode {
CWL20 = "CWL20",
CYS04 = "CYS04",
DSM05 = "DSM05",
DUB07 = "DUB07",
FRA22 = "FRA22",
HKG20 = "HKG20",
Invalid = "Invalid",
Expand All @@ -770,16 +843,22 @@ export enum KnownDataCenterCode {
MNZ21 = "MNZ21",
MWH01 = "MWH01",
ORK70 = "ORK70",
OSA02 = "OSA02",
OSA20 = "OSA20",
OSA22 = "OSA22",
PAR22 = "PAR22",
PNQ01 = "PNQ01",
PUS20 = "PUS20",
SEL20 = "SEL20",
SEL21 = "SEL21",
SG2 = "SG2",
SHA03 = "SHA03",
SIN20 = "SIN20",
SN5 = "SN5",
SN6 = "SN6",
SN8 = "SN8",
SSE90 = "SSE90",
SVG20 = "SVG20",
SYD03 = "SYD03",
SYD23 = "SYD23",
TYO01 = "TYO01",
Expand Down Expand Up @@ -851,7 +930,10 @@ export interface MarkDevicesShippedRequest {

// @public
export interface MitigateJobRequest {
customerResolutionCode: CustomerResolutionCode;
customerResolutionCode?: CustomerResolutionCode;
serialNumberCustomerResolutionMap?: {
[propertyName: string]: CustomerResolutionCode;
};
}

// @public
Expand Down Expand Up @@ -936,6 +1018,8 @@ export interface PackageShippingDetails {
export interface Preferences {
encryptionPreferences?: EncryptionPreferences;
preferredDataCenterRegion?: string[];
reverseTransportPreferences?: TransportPreferences;
storageAccountAccessTierPreferences?: string[];
transportPreferences?: TransportPreferences;
}

Expand Down Expand Up @@ -986,6 +1070,19 @@ export interface ResourceIdentity {
};
}

// @public
export interface ReverseShippingDetails {
contactDetails?: ContactInfo;
readonly isUpdated?: boolean;
shippingAddress?: ShippingAddress;
}

// @public
export type ReverseShippingDetailsEditStatus = "Enabled" | "Disabled" | "NotSupported";

// @public
export type ReverseTransportPreferenceEditStatus = "Enabled" | "Disabled" | "NotSupported";

// @public
export interface ScheduleAvailabilityRequest {
country?: string;
Expand Down Expand Up @@ -1142,6 +1239,7 @@ export interface SkuInformation {
readonly apiVersions?: string[];
readonly capacity?: SkuCapacity;
readonly costs?: SkuCost[];
readonly countriesWithinCommerceBoundary?: string[];
readonly dataLocationToServiceLocationMap?: DataLocationToServiceLocationMap[];
readonly disabledReason?: SkuDisabledReason;
readonly disabledReasonMessage?: string;
Expand All @@ -1157,7 +1255,7 @@ export type SkuName = "DataBox" | "DataBoxDisk" | "DataBoxHeavy" | "DataBoxCusto
export type StageName = string;

// @public
export type StageStatus = "None" | "InProgress" | "Succeeded" | "Failed" | "Cancelled" | "Cancelling" | "SucceededWithErrors" | "WaitingForCustomerAction" | "SucceededWithWarnings" | "WaitingForCustomerActionForKek" | "WaitingForCustomerActionForCleanUp" | "CustomerActionPerformedForCleanUp";
export type StageStatus = "None" | "InProgress" | "Succeeded" | "Failed" | "Cancelled" | "Cancelling" | "SucceededWithErrors" | "WaitingForCustomerAction" | "SucceededWithWarnings" | "WaitingForCustomerActionForKek" | "WaitingForCustomerActionForCleanUp" | "CustomerActionPerformedForCleanUp" | "CustomerActionPerformed";

// @public
export interface StorageAccountDetails extends DataAccountDetails {
Expand Down Expand Up @@ -1241,6 +1339,7 @@ export interface TransportAvailabilityResponse {

// @public
export interface TransportPreferences {
readonly isUpdated?: boolean;
preferredShipmentType: TransportShipmentTypes;
}

Expand All @@ -1263,7 +1362,9 @@ export interface UnencryptedCredentialsList {
export interface UpdateJobDetails {
contactDetails?: ContactDetails;
keyEncryptionKey?: KeyEncryptionKey;
preferences?: Preferences;
returnToCustomerPackageDetails?: PackageCarrierDetails;
reverseShippingDetails?: ReverseShippingDetails;
shippingAddress?: ShippingAddress;
}

Expand Down
4 changes: 2 additions & 2 deletions sdk/databox/arm-databox/src/dataBoxManagementClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export class DataBoxManagementClient extends coreClient.ServiceClient {
credential: credentials
};

const packageDetails = `azsdk-js-arm-databox/5.0.0-beta.4`;
const packageDetails = `azsdk-js-arm-databox/5.0.0`;
const userAgentPrefix =
options.userAgentOptions && options.userAgentOptions.userAgentPrefix
? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
Expand Down Expand Up @@ -109,7 +109,7 @@ export class DataBoxManagementClient extends coreClient.ServiceClient {

// Assigning values to Constant parameters
this.$host = options.$host || "https://management.azure.com";
this.apiVersion = options.apiVersion || "2021-08-01-preview";
this.apiVersion = options.apiVersion || "2022-12-01";
this.operations = new OperationsImpl(this);
this.jobs = new JobsImpl(this);
this.service = new ServiceImpl(this);
Expand Down
Loading