@azure/arm-elasticsan 1.0.0-beta.1

package/review/arm-elasticsan.api.md

@@ -0,0 +1,536 @@
+## API Report File for "@azure/arm-elasticsan"
+
+> 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';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface ElasticSan extends TrackedResource {
+    availabilityZones?: string[];
+    baseSizeTiB: number;
+    extendedCapacitySizeTiB: number;
+    readonly provisioningState?: ProvisioningStates;
+    sku: Sku;
+    readonly systemData?: SystemData;
+    readonly totalIops?: number;
+    readonly totalMBps?: number;
+    readonly totalSizeTiB?: number;
+    readonly totalVolumeSizeGiB?: number;
+    readonly volumeGroupCount?: number;
+}
+
+// @public
+export interface ElasticSanList {
+    readonly nextLink?: string;
+    value: ElasticSan[];
+}
+
+// @public (undocumented)
+export class ElasticSanManagement extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ElasticSanManagementOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    elasticSans: ElasticSans;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    skus: Skus;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    volumeGroups: VolumeGroups;
+    // (undocumented)
+    volumes: Volumes;
+}
+
+// @public
+export interface ElasticSanManagementOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface ElasticSanOperationDisplay {
+    description: string;
+    operation: string;
+    provider: string;
+    resource: string;
+}
+
+// @public
+export interface ElasticSanOperationListResult {
+    nextLink?: string;
+    value: ElasticSanRPOperation[];
+}
+
+// @public
+export interface ElasticSanRPOperation {
+    readonly display?: ElasticSanOperationDisplay;
+    readonly isDataAction?: boolean;
+    name: string;
+}
+
+// @public
+export interface ElasticSans {
+    beginCreate(resourceGroupName: string, elasticSanName: string, parameters: ElasticSan, options?: ElasticSansCreateOptionalParams): Promise<PollerLike<PollOperationState<ElasticSansCreateResponse>, ElasticSansCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, elasticSanName: string, parameters: ElasticSan, options?: ElasticSansCreateOptionalParams): Promise<ElasticSansCreateResponse>;
+    beginDelete(resourceGroupName: string, elasticSanName: string, options?: ElasticSansDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, elasticSanName: string, options?: ElasticSansDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, elasticSanName: string, parameters: ElasticSanUpdate, options?: ElasticSansUpdateOptionalParams): Promise<PollerLike<PollOperationState<ElasticSansUpdateResponse>, ElasticSansUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, elasticSanName: string, parameters: ElasticSanUpdate, options?: ElasticSansUpdateOptionalParams): Promise<ElasticSansUpdateResponse>;
+    get(resourceGroupName: string, elasticSanName: string, options?: ElasticSansGetOptionalParams): Promise<ElasticSansGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: ElasticSansListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ElasticSan>;
+    listBySubscription(options?: ElasticSansListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ElasticSan>;
+}
+
+// @public
+export interface ElasticSansCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ElasticSansCreateResponse = ElasticSan;
+
+// @public
+export interface ElasticSansDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface ElasticSansGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ElasticSansGetResponse = ElasticSan;
+
+// @public
+export interface ElasticSansListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ElasticSansListByResourceGroupNextResponse = ElasticSanList;
+
+// @public
+export interface ElasticSansListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ElasticSansListByResourceGroupResponse = ElasticSanList;
+
+// @public
+export interface ElasticSansListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ElasticSansListBySubscriptionNextResponse = ElasticSanList;
+
+// @public
+export interface ElasticSansListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ElasticSansListBySubscriptionResponse = ElasticSanList;
+
+// @public
+export interface ElasticSansUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ElasticSansUpdateResponse = ElasticSan;
+
+// @public
+export interface ElasticSanUpdate {
+    baseSizeTiB?: number;
+    extendedCapacitySizeTiB?: number;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export type EncryptionType = string;
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorModel {
+    error?: ErrorResponse;
+}
+
+// @public
+export interface ErrorResponse {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorResponse[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface IscsiTargetInfo {
+    readonly provisioningState?: ProvisioningStates;
+    status?: OperationalStatus;
+    readonly targetIqn?: string;
+    readonly targetPortalHostname?: string;
+    readonly targetPortalPort?: number;
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownEncryptionType {
+    EncryptionAtRestWithPlatformKey = "EncryptionAtRestWithPlatformKey"
+}
+
+// @public
+export enum KnownOperationalStatus {
+    Healthy = "Healthy",
+    Invalid = "Invalid",
+    Running = "Running",
+    Stopped = "Stopped",
+    StoppedDeallocated = "Stopped (deallocated)",
+    Unhealthy = "Unhealthy",
+    Unknown = "Unknown",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownProvisioningStates {
+    Canceled = "Canceled",
+    Creating = "Creating",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Invalid = "Invalid",
+    Pending = "Pending",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownSkuName {
+    PremiumLRS = "Premium_LRS",
+    PremiumZRS = "Premium_ZRS"
+}
+
+// @public
+export enum KnownSkuTier {
+    Premium = "Premium"
+}
+
+// @public
+export enum KnownStorageTargetType {
+    Iscsi = "Iscsi",
+    None = "None"
+}
+
+// @public
+export interface NetworkRuleSet {
+    virtualNetworkRules?: VirtualNetworkRule[];
+}
+
+// @public
+export type OperationalStatus = string;
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<ElasticSanRPOperation>;
+}
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = ElasticSanOperationListResult;
+
+// @public
+export type ProvisioningStates = string;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    readonly type?: string;
+}
+
+// @public
+export interface Sku {
+    name: SkuName;
+    tier?: SkuTier;
+}
+
+// @public
+export interface SKUCapability {
+    readonly name?: string;
+    readonly value?: string;
+}
+
+// @public
+export interface SkuInformation {
+    readonly capabilities?: SKUCapability[];
+    readonly locationInfo?: SkuLocationInfo[];
+    readonly locations?: string[];
+    name: SkuName;
+    readonly resourceType?: string;
+    tier?: SkuTier;
+}
+
+// @public
+export interface SkuInformationList {
+    readonly value?: SkuInformation[];
+}
+
+// @public
+export interface SkuLocationInfo {
+    readonly location?: string;
+    readonly zones?: string[];
+}
+
+// @public
+export type SkuName = string;
+
+// @public
+export interface Skus {
+    list(options?: SkusListOptionalParams): PagedAsyncIterableIterator<SkuInformation>;
+}
+
+// @public
+export interface SkusListOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type SkusListResponse = SkuInformationList;
+
+// @public
+export type SkuTier = string;
+
+// @public
+export interface SourceCreationData {
+    createSource?: "None";
+    sourceUri?: string;
+}
+
+// @public
+export type State = "provisioning" | "deprovisioning" | "succeeded" | "failed" | "networkSourceDeleted";
+
+// @public
+export type StorageTargetType = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location?: string;
+}
+
+// @public
+export interface VirtualNetworkRule {
+    action?: "Allow";
+    readonly state?: State;
+    virtualNetworkResourceId: string;
+}
+
+// @public
+export interface Volume extends Resource {
+    creationData?: SourceCreationData;
+    sizeGiB?: number;
+    readonly storageTarget?: IscsiTargetInfo;
+    readonly systemData?: SystemData;
+    readonly volumeId?: string;
+}
+
+// @public
+export interface VolumeGroup extends Resource {
+    encryption?: EncryptionType;
+    networkAcls?: NetworkRuleSet;
+    protocolType?: StorageTargetType;
+    readonly provisioningState?: ProvisioningStates;
+    readonly systemData?: SystemData;
+}
+
+// @public
+export interface VolumeGroupList {
+    readonly nextLink?: string;
+    value: VolumeGroup[];
+}
+
+// @public
+export interface VolumeGroups {
+    beginCreate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, parameters: VolumeGroup, options?: VolumeGroupsCreateOptionalParams): Promise<PollerLike<PollOperationState<VolumeGroupsCreateResponse>, VolumeGroupsCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, parameters: VolumeGroup, options?: VolumeGroupsCreateOptionalParams): Promise<VolumeGroupsCreateResponse>;
+    beginDelete(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, options?: VolumeGroupsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, options?: VolumeGroupsDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, parameters: VolumeGroupUpdate, options?: VolumeGroupsUpdateOptionalParams): Promise<PollerLike<PollOperationState<VolumeGroupsUpdateResponse>, VolumeGroupsUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, parameters: VolumeGroupUpdate, options?: VolumeGroupsUpdateOptionalParams): Promise<VolumeGroupsUpdateResponse>;
+    get(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, options?: VolumeGroupsGetOptionalParams): Promise<VolumeGroupsGetResponse>;
+    listByElasticSan(resourceGroupName: string, elasticSanName: string, options?: VolumeGroupsListByElasticSanOptionalParams): PagedAsyncIterableIterator<VolumeGroup>;
+}
+
+// @public
+export interface VolumeGroupsCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type VolumeGroupsCreateResponse = VolumeGroup;
+
+// @public
+export interface VolumeGroupsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface VolumeGroupsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VolumeGroupsGetResponse = VolumeGroup;
+
+// @public
+export interface VolumeGroupsListByElasticSanNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VolumeGroupsListByElasticSanNextResponse = VolumeGroupList;
+
+// @public
+export interface VolumeGroupsListByElasticSanOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VolumeGroupsListByElasticSanResponse = VolumeGroupList;
+
+// @public
+export interface VolumeGroupsUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type VolumeGroupsUpdateResponse = VolumeGroup;
+
+// @public
+export interface VolumeGroupUpdate {
+    encryption?: EncryptionType;
+    networkAcls?: NetworkRuleSet;
+    protocolType?: StorageTargetType;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface VolumeList {
+    readonly nextLink?: string;
+    value: Volume[];
+}
+
+// @public
+export interface Volumes {
+    beginCreate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: Volume, options?: VolumesCreateOptionalParams): Promise<PollerLike<PollOperationState<VolumesCreateResponse>, VolumesCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: Volume, options?: VolumesCreateOptionalParams): Promise<VolumesCreateResponse>;
+    beginDelete(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, options?: VolumesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, options?: VolumesDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: VolumeUpdate, options?: VolumesUpdateOptionalParams): Promise<PollerLike<PollOperationState<VolumesUpdateResponse>, VolumesUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: VolumeUpdate, options?: VolumesUpdateOptionalParams): Promise<VolumesUpdateResponse>;
+    get(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, options?: VolumesGetOptionalParams): Promise<VolumesGetResponse>;
+    listByVolumeGroup(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, options?: VolumesListByVolumeGroupOptionalParams): PagedAsyncIterableIterator<Volume>;
+}
+
+// @public
+export interface VolumesCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type VolumesCreateResponse = Volume;
+
+// @public
+export interface VolumesDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface VolumesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VolumesGetResponse = Volume;
+
+// @public
+export interface VolumesListByVolumeGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VolumesListByVolumeGroupNextResponse = VolumeList;
+
+// @public
+export interface VolumesListByVolumeGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VolumesListByVolumeGroupResponse = VolumeList;
+
+// @public
+export interface VolumesUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type VolumesUpdateResponse = Volume;
+
+// @public
+export interface VolumeUpdate {
+    sizeGiB?: number;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -0,0 +1,122 @@
+/*
+ * 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";
+
+// #region Warning Handler
+
+/**
+ * A function that can determine whether a rollup warning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEval(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+      (warning.id.includes("node_modules/nise") ||
+        warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependency(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer && warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [ignoreChaiCircularDependency, ignoreNiseSinonEval];
+
+/**
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
+ */
+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/**"]
+    },
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      nodeResolve({
+        mainFields: ["module", "browser"]
+      }),
+      cjs(),
+      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 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()]
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));