@azure/arm-storageimportexport 0.1.0 → 2.0.0

package/review/arm-storageimportexport.api.md

@@ -0,0 +1,438 @@
+## API Report File for "@azure/arm-storageimportexport"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+// @public
+export interface BitLockerKeys {
+    list(jobName: string, resourceGroupName: string, options?: BitLockerKeysListOptionalParams): PagedAsyncIterableIterator<DriveBitLockerKey>;
+}
+
+// @public
+export interface BitLockerKeysListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type BitLockerKeysListResponse = GetBitLockerKeysResponse;
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface DeliveryPackageInformation {
+    carrierName: string;
+    driveCount?: number;
+    shipDate?: string;
+    trackingNumber: string;
+}
+
+// @public
+export interface DriveBitLockerKey {
+    bitLockerKey?: string;
+    driveId?: string;
+}
+
+// @public
+export type DriveState = string;
+
+// @public
+export interface DriveStatus {
+    bitLockerKey?: string;
+    bytesSucceeded?: number;
+    copyStatus?: string;
+    driveHeaderHash?: string;
+    driveId?: string;
+    errorLogUri?: string;
+    manifestFile?: string;
+    manifestHash?: string;
+    manifestUri?: string;
+    percentComplete?: number;
+    state?: DriveState;
+    verboseLogUri?: string;
+}
+
+// @public
+export type EncryptionKekType = string;
+
+// @public
+export interface EncryptionKeyDetails {
+    kekType?: EncryptionKekType;
+    kekUrl?: string;
+    kekVaultResourceID?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    code?: string;
+    details?: ErrorResponseErrorDetailsItem[];
+    innererror?: Record<string, unknown>;
+    message?: string;
+    target?: string;
+}
+
+// @public (undocumented)
+export interface ErrorResponseErrorDetailsItem {
+    code?: string;
+    message?: string;
+    target?: string;
+}
+
+// @public
+export interface Export {
+    blobListBlobPath?: string;
+    blobPath?: string[];
+    blobPathPrefix?: string[];
+}
+
+// @public
+export interface GetBitLockerKeysResponse {
+    value?: DriveBitLockerKey[];
+}
+
+// @public
+export interface IdentityDetails {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type?: IdentityType;
+}
+
+// @public
+export type IdentityType = string;
+
+// @public
+export interface JobDetails {
+    backupDriveManifest?: boolean;
+    cancelRequested?: boolean;
+    deliveryPackage?: DeliveryPackageInformation;
+    diagnosticsPath?: string;
+    driveList?: DriveStatus[];
+    encryptionKey?: EncryptionKeyDetails;
+    export?: Export;
+    incompleteBlobListUri?: string;
+    jobType?: string;
+    logLevel?: string;
+    percentComplete?: number;
+    provisioningState?: string;
+    returnAddress?: ReturnAddress;
+    returnPackage?: PackageInformation;
+    returnShipping?: ReturnShipping;
+    shippingInformation?: ShippingInformation;
+    state?: string;
+    storageAccountId?: string;
+}
+
+// @public
+export interface JobResponse {
+    readonly id?: string;
+    identity?: IdentityDetails;
+    location?: string;
+    readonly name?: string;
+    properties?: JobDetails;
+    readonly systemData?: SystemData;
+    tags?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface Jobs {
+    create(jobName: string, resourceGroupName: string, body: PutJobParameters, options?: JobsCreateOptionalParams): Promise<JobsCreateResponse>;
+    delete(jobName: string, resourceGroupName: string, options?: JobsDeleteOptionalParams): Promise<void>;
+    get(jobName: string, resourceGroupName: string, options?: JobsGetOptionalParams): Promise<JobsGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<JobResponse>;
+    listBySubscription(options?: JobsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<JobResponse>;
+    update(jobName: string, resourceGroupName: string, body: UpdateJobParameters, options?: JobsUpdateOptionalParams): Promise<JobsUpdateResponse>;
+}
+
+// @public
+export interface JobsCreateOptionalParams extends coreClient.OperationOptions {
+    clientTenantId?: string;
+}
+
+// @public
+export type JobsCreateResponse = JobResponse;
+
+// @public
+export interface JobsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface JobsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type JobsGetResponse = JobResponse;
+
+// @public
+export interface JobsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+    top?: number;
+}
+
+// @public
+export type JobsListByResourceGroupNextResponse = ListJobsResponse;
+
+// @public
+export interface JobsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+    top?: number;
+}
+
+// @public
+export type JobsListByResourceGroupResponse = ListJobsResponse;
+
+// @public
+export interface JobsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+    top?: number;
+}
+
+// @public
+export type JobsListBySubscriptionNextResponse = ListJobsResponse;
+
+// @public
+export interface JobsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+    top?: number;
+}
+
+// @public
+export type JobsListBySubscriptionResponse = ListJobsResponse;
+
+// @public
+export interface JobsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type JobsUpdateResponse = JobResponse;
+
+// @public
+export enum KnownCreatedByType {
+    // (undocumented)
+    Application = "Application",
+    // (undocumented)
+    Key = "Key",
+    // (undocumented)
+    ManagedIdentity = "ManagedIdentity",
+    // (undocumented)
+    User = "User"
+}
+
+// @public
+export enum KnownDriveState {
+    // (undocumented)
+    Completed = "Completed",
+    // (undocumented)
+    CompletedMoreInfo = "CompletedMoreInfo",
+    // (undocumented)
+    NeverReceived = "NeverReceived",
+    // (undocumented)
+    Received = "Received",
+    // (undocumented)
+    ShippedBack = "ShippedBack",
+    // (undocumented)
+    Specified = "Specified",
+    // (undocumented)
+    Transferring = "Transferring"
+}
+
+// @public
+export enum KnownEncryptionKekType {
+    // (undocumented)
+    CustomerManaged = "CustomerManaged",
+    // (undocumented)
+    MicrosoftManaged = "MicrosoftManaged"
+}
+
+// @public
+export enum KnownIdentityType {
+    // (undocumented)
+    None = "None",
+    // (undocumented)
+    SystemAssigned = "SystemAssigned",
+    // (undocumented)
+    UserAssigned = "UserAssigned"
+}
+
+// @public
+export interface ListJobsResponse {
+    nextLink?: string;
+    value?: JobResponse[];
+}
+
+// @public
+export interface ListOperationsResponse {
+    value?: Operation[];
+}
+
+// @public
+interface Location_2 {
+    additionalShippingInformation?: string;
+    alternateLocations?: string[];
+    city?: string;
+    countryOrRegion?: string;
+    id?: string;
+    name?: string;
+    phone?: string;
+    postalCode?: string;
+    recipientName?: string;
+    stateOrProvince?: string;
+    streetAddress1?: string;
+    streetAddress2?: string;
+    supportedCarriers?: string[];
+    type?: string;
+}
+export { Location_2 as Location }
+
+// @public
+export interface Locations {
+    get(locationName: string, options?: LocationsGetOptionalParams): Promise<LocationsGetResponse>;
+    list(options?: LocationsListOptionalParams): PagedAsyncIterableIterator<Location_2>;
+}
+
+// @public
+export interface LocationsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LocationsGetResponse = Location_2;
+
+// @public
+export interface LocationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type LocationsListResponse = LocationsResponse;
+
+// @public
+export interface LocationsResponse {
+    value?: Location_2[];
+}
+
+// @public
+export interface Operation {
+    description?: string;
+    name: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = ListOperationsResponse;
+
+// @public
+export interface PackageInformation {
+    carrierName: string;
+    driveCount: number;
+    shipDate: string;
+    trackingNumber: string;
+}
+
+// @public
+export interface PutJobParameters {
+    location?: string;
+    properties?: JobDetails;
+    tags?: Record<string, unknown>;
+}
+
+// @public
+export interface ReturnAddress {
+    city: string;
+    countryOrRegion: string;
+    email: string;
+    phone: string;
+    postalCode: string;
+    recipientName: string;
+    stateOrProvince?: string;
+    streetAddress1: string;
+    streetAddress2?: string;
+}
+
+// @public
+export interface ReturnShipping {
+    carrierAccountNumber: string;
+    carrierName: string;
+}
+
+// @public
+export interface ShippingInformation {
+    readonly additionalInformation?: string;
+    city?: string;
+    countryOrRegion?: string;
+    phone?: string;
+    postalCode?: string;
+    recipientName?: string;
+    stateOrProvince?: string;
+    streetAddress1?: string;
+    streetAddress2?: string;
+}
+
+// @public (undocumented)
+export class StorageImportExport extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: StorageImportExportOptionalParams);
+    // (undocumented)
+    acceptLanguage?: string;
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    bitLockerKeys: BitLockerKeys;
+    // (undocumented)
+    jobs: Jobs;
+    // (undocumented)
+    locations: Locations;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface StorageImportExportOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    acceptLanguage?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface UpdateJobParameters {
+    backupDriveManifest?: boolean;
+    cancelRequested?: boolean;
+    deliveryPackage?: DeliveryPackageInformation;
+    driveList?: DriveStatus[];
+    logLevel?: string;
+    returnAddress?: ReturnAddress;
+    returnShipping?: ReturnShipping;
+    state?: string;
+    tags?: Record<string, unknown>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -1,31 +1,188 @@
-import nodeResolve from "rollup-plugin-node-resolve";
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import nodeResolve from "@rollup/plugin-node-resolve";
+import cjs from "@rollup/plugin-commonjs";
+import sourcemaps from "rollup-plugin-sourcemaps";
+import multiEntry from "@rollup/plugin-multi-entry";
+import json from "@rollup/plugin-json";
+
+import nodeBuiltins from "builtin-modules";
+
+/**
+ * Gets the proper configuration needed for rollup's commonJS plugin for @opentelemetry/api.
+ *
+ * NOTE: this manual configuration is only needed because OpenTelemetry uses an
+ * __exportStar downleveled helper function to declare its exports which confuses
+ * rollup's automatic discovery mechanism.
+ *
+ * @returns an object reference that can be `...`'d into your cjs() configuration.
+ */
+export function openTelemetryCommonJs() {
+  const namedExports = {};
+
+  for (const key of [
+    "@opentelemetry/api",
+    "@azure/core-tracing/node_modules/@opentelemetry/api"
+  ]) {
+    namedExports[key] = [
+      "SpanKind",
+      "TraceFlags",
+      "getSpan",
+      "setSpan",
+      "SpanStatusCode",
+      "getSpanContext",
+      "setSpanContext"
+    ];
+  }
+
+  const releasedOpenTelemetryVersions = ["0.10.2", "1.0.0-rc.0"];
+
+  for (const version of releasedOpenTelemetryVersions) {
+    namedExports[
+      // working around a limitation in the rollup common.js plugin - it's not able to resolve these modules so the named exports listed above will not get applied. We have to drill down to the actual path.
+      `../../../common/temp/node_modules/.pnpm/@opentelemetry/api@${version}/node_modules/@opentelemetry/api/build/src/index.js`
+    ] = [
+      "SpanKind",
+      "TraceFlags",
+      "getSpan",
+      "setSpan",
+      "StatusCode",
+      "CanonicalCode",
+      "getSpanContext",
+      "setSpanContext"
+    ];
+  }
+
+  return namedExports;
+}
+
+// #region Warning Handler
+
+/**
+ * A function that can determine whether a rollupwarning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEvalWarnings(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+      (warning.id.includes("node_modules/nise") ||
+        warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependencyWarnings(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer && warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [
+  ignoreChaiCircularDependencyWarnings,
+  ignoreNiseSinonEvalWarnings
+];
+
 /**
- * @type {import('rollup').RollupFileOptions}
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
  */
-const config = {
-  input: './esm/storageImportExportManagementClient.js',
-  external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"],
-  output: {
-    file: "./dist/arm-storageimportexport.js",
-    format: "umd",
-    name: "Azure.ArmStorageimportexport",
-    sourcemap: true,
-    globals: {
-      "@azure/ms-rest-js": "msRest",
-      "@azure/ms-rest-azure-js": "msRestAzure"
+function makeOnWarnForTesting() {
+  return (warning, warn) => {
+    // If every inhibitor returns false (i.e. no inhibitors), then show the warning
+    if (warningInhibitors.every((inhib) => !inhib(warning))) {
+      warn(warning);
+    }
+  };
+}
+
+// #endregion
+
+function makeBrowserTestConfig() {
+  const config = {
+    input: {
+      include: ["dist-esm/test/**/*.spec.js"],
+      exclude: ["dist-esm/test/**/node/**"]
     },
-    banner: `/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for
- * license information.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is
- * regenerated.
- */`
-  },
-  plugins: [
-    nodeResolve({ module: true })
-  ]
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      nodeResolve({
+        mainFields: ["module", "browser"]
+      }),
+      cjs({
+        namedExports: {
+          // Chai's strange internal architecture makes it impossible to statically
+          // analyze its exports.
+          chai: [
+            "version",
+            "use",
+            "util",
+            "config",
+            "expect",
+            "should",
+            "assert"
+          ],
+          ...openTelemetryCommonJs()
+        }
+      }),
+      json(),
+      sourcemaps()
+      //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
+    ],
+    onwarn: makeOnWarnForTesting(),
+    // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
+    // rollup started respecting the "sideEffects" field in package.json.  Since
+    // our package.json sets "sideEffects=false", this also applies to test
+    // code, which causes all tests to be removed by tree-shaking.
+    treeshake: false
+  };
+
+  return config;
+}
+
+const defaultConfigurationOptions = {
+  disableBrowserBundle: false
 };
-export default config;
+
+export function makeConfig(pkg, options) {
+  options = {
+    ...defaultConfigurationOptions,
+    ...(options || {})
+  };
+
+  const baseConfig = {
+    // Use the package's module field if it has one
+    input: pkg["module"] || "dist-esm/src/index.js",
+    external: [
+      ...nodeBuiltins,
+      ...Object.keys(pkg.dependencies),
+      ...Object.keys(pkg.devDependencies)
+    ],
+    output: { file: "dist/index.js", format: "cjs", sourcemap: true },
+    preserveSymlinks: false,
+    plugins: [sourcemaps(), nodeResolve(), cjs()]
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));

package/src/index.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+/// <reference lib="esnext.asynciterable" />
+export * from "./models";
+export { StorageImportExport } from "./storageImportExport";
+export * from "./operationsInterfaces";