@azure/arm-elasticsan 1.0.0-beta.2 → 1.0.0

package/review/arm-elasticsan.api.md

@@ -10,6 +10,9 @@ import { OperationState } from '@azure/core-lro';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { SimplePollerLike } from '@azure/core-lro';
 
+// @public
+export type Action = string;
+
 // @public
 export type ActionType = string;
 
@@ -18,17 +21,7 @@ export type CreatedByType = string;
 
 // @public
 export interface ElasticSan extends TrackedResource {
-    availabilityZones?: string[];
-    baseSizeTiB: number;
-    extendedCapacitySizeTiB: number;
-    readonly privateEndpointConnections?: PrivateEndpointConnection[];
-    readonly provisioningState?: ProvisioningStates;
-    sku: Sku;
-    readonly totalIops?: number;
-    readonly totalMBps?: number;
-    readonly totalSizeTiB?: number;
-    readonly totalVolumeSizeGiB?: number;
-    readonly volumeGroupCount?: number;
+    properties: ElasticSanProperties;
 }
 
 // @public
@@ -60,6 +53,8 @@ export class ElasticSanManagement extends coreClient.ServiceClient {
     volumeGroups: VolumeGroups;
     // (undocumented)
     volumes: Volumes;
+    // (undocumented)
+    volumeSnapshots: VolumeSnapshots;
 }
 
 // @public
@@ -69,6 +64,22 @@ export interface ElasticSanManagementOptionalParams extends coreClient.ServiceCl
     endpoint?: string;
 }
 
+// @public
+export interface ElasticSanProperties {
+    availabilityZones?: string[];
+    baseSizeTiB: number;
+    extendedCapacitySizeTiB: number;
+    readonly privateEndpointConnections?: PrivateEndpointConnection[];
+    readonly provisioningState?: ProvisioningStates;
+    publicNetworkAccess?: PublicNetworkAccess;
+    sku: Sku;
+    readonly totalIops?: number;
+    readonly totalMBps?: number;
+    readonly totalSizeTiB?: number;
+    readonly totalVolumeSizeGiB?: number;
+    readonly volumeGroupCount?: number;
+}
+
 // @public
 export interface ElasticSans {
     beginCreate(resourceGroupName: string, elasticSanName: string, parameters: ElasticSan, options?: ElasticSansCreateOptionalParams): Promise<SimplePollerLike<OperationState<ElasticSansCreateResponse>, ElasticSansCreateResponse>>;
@@ -155,13 +166,30 @@ export type ElasticSansUpdateResponse = ElasticSan;
 
 // @public
 export interface ElasticSanUpdate {
-    baseSizeTiB?: number;
-    extendedCapacitySizeTiB?: number;
+    properties?: ElasticSanUpdateProperties;
     tags?: {
         [propertyName: string]: string;
     };
 }
 
+// @public
+export interface ElasticSanUpdateProperties {
+    baseSizeTiB?: number;
+    extendedCapacitySizeTiB?: number;
+    publicNetworkAccess?: PublicNetworkAccess;
+}
+
+// @public
+export interface EncryptionIdentity {
+    encryptionUserAssignedIdentity?: string;
+}
+
+// @public
+export interface EncryptionProperties {
+    encryptionIdentity?: EncryptionIdentity;
+    keyVaultProperties?: KeyVaultProperties;
+}
+
 // @public
 export type EncryptionType = string;
 
@@ -188,6 +216,19 @@ export interface ErrorResponse {
 // @public
 export function getContinuationToken(page: unknown): string | undefined;
 
+// @public
+export interface Identity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type: IdentityType;
+    userAssignedIdentities?: {
+        [propertyName: string]: UserAssignedIdentity;
+    };
+}
+
+// @public
+export type IdentityType = string;
+
 // @public
 export interface IscsiTargetInfo {
     readonly provisioningState?: ProvisioningStates;
@@ -197,6 +238,21 @@ export interface IscsiTargetInfo {
     readonly targetPortalPort?: number;
 }
 
+// @public
+export interface KeyVaultProperties {
+    readonly currentVersionedKeyExpirationTimestamp?: Date;
+    readonly currentVersionedKeyIdentifier?: string;
+    keyName?: string;
+    keyVaultUri?: string;
+    keyVersion?: string;
+    readonly lastKeyRotationTimestamp?: Date;
+}
+
+// @public
+export enum KnownAction {
+    Allow = "Allow"
+}
+
 // @public
 export enum KnownActionType {
     Internal = "Internal"
@@ -212,9 +268,17 @@ export enum KnownCreatedByType {
 
 // @public
 export enum KnownEncryptionType {
+    EncryptionAtRestWithCustomerManagedKey = "EncryptionAtRestWithCustomerManagedKey",
     EncryptionAtRestWithPlatformKey = "EncryptionAtRestWithPlatformKey"
 }
 
+// @public
+export enum KnownIdentityType {
+    None = "None",
+    SystemAssigned = "SystemAssigned",
+    UserAssigned = "UserAssigned"
+}
+
 // @public
 export enum KnownOperationalStatus {
     Healthy = "Healthy",
@@ -254,6 +318,12 @@ export enum KnownProvisioningStates {
     Updating = "Updating"
 }
 
+// @public
+export enum KnownPublicNetworkAccess {
+    Disabled = "Disabled",
+    Enabled = "Enabled"
+}
+
 // @public
 export enum KnownSkuName {
     PremiumLRS = "Premium_LRS",
@@ -271,6 +341,32 @@ export enum KnownStorageTargetType {
     None = "None"
 }
 
+// @public
+export enum KnownVolumeCreateOption {
+    Disk = "Disk",
+    DiskRestorePoint = "DiskRestorePoint",
+    DiskSnapshot = "DiskSnapshot",
+    None = "None",
+    VolumeSnapshot = "VolumeSnapshot"
+}
+
+// @public
+export enum KnownXMsDeleteSnapshots {
+    False = "false",
+    True = "true"
+}
+
+// @public
+export enum KnownXMsForceDelete {
+    False = "false",
+    True = "true"
+}
+
+// @public
+export interface ManagedByInfo {
+    resourceId?: string;
+}
+
 // @public
 export interface NetworkRuleSet {
     virtualNetworkRules?: VirtualNetworkRule[];
@@ -324,10 +420,7 @@ export interface PrivateEndpoint {
 
 // @public
 export interface PrivateEndpointConnection extends Resource {
-    groupIds?: string[];
-    privateEndpoint?: PrivateEndpoint;
-    privateLinkServiceConnectionState: PrivateLinkServiceConnectionState;
-    readonly provisioningState?: ProvisioningStates;
+    properties: PrivateEndpointConnectionProperties;
 }
 
 // @public
@@ -336,6 +429,14 @@ export interface PrivateEndpointConnectionListResult {
     value?: PrivateEndpointConnection[];
 }
 
+// @public
+export interface PrivateEndpointConnectionProperties {
+    groupIds?: string[];
+    privateEndpoint?: PrivateEndpoint;
+    privateLinkServiceConnectionState: PrivateLinkServiceConnectionState;
+    readonly provisioningState?: ProvisioningStates;
+}
+
 // @public
 export interface PrivateEndpointConnections {
     beginCreate(resourceGroupName: string, elasticSanName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionsCreateResponse>, PrivateEndpointConnectionsCreateResponse>>;
@@ -386,9 +487,7 @@ export type PrivateEndpointServiceConnectionStatus = string;
 
 // @public
 export interface PrivateLinkResource extends Resource {
-    readonly groupId?: string;
-    readonly requiredMembers?: string[];
-    requiredZoneNames?: string[];
+    properties?: PrivateLinkResourceProperties;
 }
 
 // @public
@@ -397,6 +496,13 @@ export interface PrivateLinkResourceListResult {
     value?: PrivateLinkResource[];
 }
 
+// @public
+export interface PrivateLinkResourceProperties {
+    readonly groupId?: string;
+    readonly requiredMembers?: string[];
+    requiredZoneNames?: string[];
+}
+
 // @public
 export interface PrivateLinkResources {
     listByElasticSan(resourceGroupName: string, elasticSanName: string, options?: PrivateLinkResourcesListByElasticSanOptionalParams): Promise<PrivateLinkResourcesListByElasticSanResponse>;
@@ -423,6 +529,9 @@ export type ProvisioningStates = string;
 export interface ProxyResource extends Resource {
 }
 
+// @public
+export type PublicNetworkAccess = string;
+
 // @public
 export interface Resource {
     readonly id?: string;
@@ -485,13 +594,34 @@ export type SkusListResponse = SkuInformationList;
 export type SkuTier = string;
 
 // @public
-export interface SourceCreationData {
-    createSource?: "None";
-    sourceUri?: string;
+export interface Snapshot extends ProxyResource {
+    properties: SnapshotProperties;
+}
+
+// @public
+export interface SnapshotCreationData {
+    sourceId: string;
+}
+
+// @public
+export interface SnapshotList {
+    readonly nextLink?: string;
+    value?: Snapshot[];
 }
 
 // @public
-export type State = "provisioning" | "deprovisioning" | "succeeded" | "failed" | "networkSourceDeleted";
+export interface SnapshotProperties {
+    creationData: SnapshotCreationData;
+    readonly provisioningState?: ProvisioningStates;
+    readonly sourceVolumeSizeGiB?: number;
+    readonly volumeName?: string;
+}
+
+// @public
+export interface SourceCreationData {
+    createSource?: VolumeCreateOption;
+    sourceId?: string;
+}
 
 // @public
 export type StorageTargetType = string;
@@ -514,28 +644,30 @@ export interface TrackedResource extends Resource {
     };
 }
 
+// @public
+export interface UserAssignedIdentity {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
+
 // @public
 export interface VirtualNetworkRule {
-    action?: "Allow";
-    readonly state?: State;
+    action?: Action;
     virtualNetworkResourceId: string;
 }
 
 // @public
 export interface Volume extends ProxyResource {
-    creationData?: SourceCreationData;
-    sizeGiB: number;
-    readonly storageTarget?: IscsiTargetInfo;
-    readonly volumeId?: string;
+    properties: VolumeProperties;
 }
 
+// @public
+export type VolumeCreateOption = string;
+
 // @public
 export interface VolumeGroup extends ProxyResource {
-    encryption?: EncryptionType;
-    networkAcls?: NetworkRuleSet;
-    readonly privateEndpointConnections?: PrivateEndpointConnection[];
-    protocolType?: StorageTargetType;
-    readonly provisioningState?: ProvisioningStates;
+    identity?: Identity;
+    properties?: VolumeGroupProperties;
 }
 
 // @public
@@ -544,6 +676,16 @@ export interface VolumeGroupList {
     value?: VolumeGroup[];
 }
 
+// @public
+export interface VolumeGroupProperties {
+    encryption?: EncryptionType;
+    encryptionProperties?: EncryptionProperties;
+    networkAcls?: NetworkRuleSet;
+    readonly privateEndpointConnections?: PrivateEndpointConnection[];
+    protocolType?: StorageTargetType;
+    readonly provisioningState?: ProvisioningStates;
+}
+
 // @public
 export interface VolumeGroups {
     beginCreate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, parameters: VolumeGroup, options?: VolumeGroupsCreateOptionalParams): Promise<SimplePollerLike<OperationState<VolumeGroupsCreateResponse>, VolumeGroupsCreateResponse>>;
@@ -615,7 +757,14 @@ export type VolumeGroupsUpdateResponse = VolumeGroup;
 
 // @public
 export interface VolumeGroupUpdate {
+    identity?: Identity;
+    properties?: VolumeGroupUpdateProperties;
+}
+
+// @public
+export interface VolumeGroupUpdateProperties {
     encryption?: EncryptionType;
+    encryptionProperties?: EncryptionProperties;
     networkAcls?: NetworkRuleSet;
     protocolType?: StorageTargetType;
 }
@@ -626,6 +775,16 @@ export interface VolumeList {
     value?: Volume[];
 }
 
+// @public
+export interface VolumeProperties {
+    creationData?: SourceCreationData;
+    managedBy?: ManagedByInfo;
+    readonly provisioningState?: ProvisioningStates;
+    sizeGiB: number;
+    readonly storageTarget?: IscsiTargetInfo;
+    readonly volumeId?: string;
+}
+
 // @public
 export interface Volumes {
     beginCreate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: Volume, options?: VolumesCreateOptionalParams): Promise<SimplePollerLike<OperationState<VolumesCreateResponse>, VolumesCreateResponse>>;
@@ -657,6 +816,8 @@ export interface VolumesDeleteHeaders {
 export interface VolumesDeleteOptionalParams extends coreClient.OperationOptions {
     resumeFrom?: string;
     updateIntervalInMs?: number;
+    xMsDeleteSnapshots?: XMsDeleteSnapshots;
+    xMsForceDelete?: XMsForceDelete;
 }
 
 // @public
@@ -680,6 +841,59 @@ export interface VolumesListByVolumeGroupOptionalParams extends coreClient.Opera
 // @public
 export type VolumesListByVolumeGroupResponse = VolumeList;
 
+// @public
+export interface VolumeSnapshots {
+    beginCreate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, snapshotName: string, parameters: Snapshot, options?: VolumeSnapshotsCreateOptionalParams): Promise<SimplePollerLike<OperationState<VolumeSnapshotsCreateResponse>, VolumeSnapshotsCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, snapshotName: string, parameters: Snapshot, options?: VolumeSnapshotsCreateOptionalParams): Promise<VolumeSnapshotsCreateResponse>;
+    beginDelete(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, snapshotName: string, options?: VolumeSnapshotsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, snapshotName: string, options?: VolumeSnapshotsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, snapshotName: string, options?: VolumeSnapshotsGetOptionalParams): Promise<VolumeSnapshotsGetResponse>;
+    listByVolumeGroup(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, options?: VolumeSnapshotsListByVolumeGroupOptionalParams): PagedAsyncIterableIterator<Snapshot>;
+}
+
+// @public
+export interface VolumeSnapshotsCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type VolumeSnapshotsCreateResponse = Snapshot;
+
+// @public
+export interface VolumeSnapshotsDeleteHeaders {
+    // (undocumented)
+    location?: string;
+}
+
+// @public
+export interface VolumeSnapshotsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface VolumeSnapshotsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VolumeSnapshotsGetResponse = Snapshot;
+
+// @public
+export interface VolumeSnapshotsListByVolumeGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VolumeSnapshotsListByVolumeGroupNextResponse = SnapshotList;
+
+// @public
+export interface VolumeSnapshotsListByVolumeGroupOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type VolumeSnapshotsListByVolumeGroupResponse = SnapshotList;
+
 // @public
 export interface VolumesUpdateHeaders {
     // (undocumented)
@@ -697,9 +911,21 @@ export type VolumesUpdateResponse = Volume;
 
 // @public
 export interface VolumeUpdate {
+    properties?: VolumeUpdateProperties;
+}
+
+// @public
+export interface VolumeUpdateProperties {
+    managedBy?: ManagedByInfo;
     sizeGiB?: number;
 }
 
+// @public
+export type XMsDeleteSnapshots = string;
+
+// @public
+export type XMsForceDelete = string;
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/src/elasticSanManagement.ts

@@ -21,7 +21,8 @@ import {
   VolumeGroupsImpl,
   VolumesImpl,
   PrivateEndpointConnectionsImpl,
-  PrivateLinkResourcesImpl
+  PrivateLinkResourcesImpl,
+  VolumeSnapshotsImpl
 } from "./operations";
 import {
   Operations,
@@ -30,7 +31,8 @@ import {
   VolumeGroups,
   Volumes,
   PrivateEndpointConnections,
-  PrivateLinkResources
+  PrivateLinkResources,
+  VolumeSnapshots
 } from "./operationsInterfaces";
 import { ElasticSanManagementOptionalParams } from "./models";
 
@@ -66,7 +68,7 @@ export class ElasticSanManagement extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-elasticsan/1.0.0-beta.2`;
+    const packageDetails = `azsdk-js-arm-elasticsan/1.0.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -119,7 +121,7 @@ export class ElasticSanManagement extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2022-12-01-preview";
+    this.apiVersion = options.apiVersion || "2023-01-01";
     this.operations = new OperationsImpl(this);
     this.skus = new SkusImpl(this);
     this.elasticSans = new ElasticSansImpl(this);
@@ -127,6 +129,7 @@ export class ElasticSanManagement extends coreClient.ServiceClient {
     this.volumes = new VolumesImpl(this);
     this.privateEndpointConnections = new PrivateEndpointConnectionsImpl(this);
     this.privateLinkResources = new PrivateLinkResourcesImpl(this);
+    this.volumeSnapshots = new VolumeSnapshotsImpl(this);
     this.addCustomApiVersionPolicy(options.apiVersion);
   }
 
@@ -165,4 +168,5 @@ export class ElasticSanManagement extends coreClient.ServiceClient {
   volumes: Volumes;
   privateEndpointConnections: PrivateEndpointConnections;
   privateLinkResources: PrivateLinkResources;
+  volumeSnapshots: VolumeSnapshots;
 }