@azure/arm-netapp 15.0.0 → 15.1.0

package/types/arm-netapp.d.ts

@@ -250,6 +250,8 @@ export declare interface ActiveDirectory {
     allowLocalNfsUsersWithLdap?: boolean;
     /** If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. */
     encryptDCConnections?: boolean;
+    /** LDAP Search scope options */
+    ldapSearchScope?: LdapSearchScopeOpt;
 }
 
 /**
@@ -546,6 +548,11 @@ export declare interface BackupPolicy {
     tags?: {
         [propertyName: string]: string;
     };
+    /**
+     * The system meta data relating to this resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
     /**
      * Backup Policy Resource ID
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -939,12 +946,17 @@ export declare interface CapacityPool {
     tags?: {
         [propertyName: string]: string;
     };
+    /**
+     * The system meta data relating to this resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
     /**
      * UUID v4 used to identify the Pool
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly poolId?: string;
-    /** Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). */
+    /** Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 4398046511104). */
     size: number;
     /** The service level of the file system */
     serviceLevel: ServiceLevel;
@@ -1002,7 +1014,7 @@ export declare interface CapacityPoolPatch {
     tags?: {
         [propertyName: string]: string;
     };
-    /** Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). */
+    /** Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 4398046511104). */
     size?: number;
     /** The qos type of the pool */
     qosType?: QosType;
@@ -1098,6 +1110,16 @@ export declare interface Dimension {
     displayName?: string;
 }
 
+/**
+ * Defines values for EnableSubvolumes. \
+ * {@link KnownEnableSubvolumes} can be used interchangeably with EnableSubvolumes,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Enabled**: subvolumes are enabled \
+ * **Disabled**: subvolumes are not enabled
+ */
+export declare type EnableSubvolumes = string;
+
 /**
  * Defines values for EncryptionType. \
  * {@link KnownEncryptionType} can be used interchangeably with EncryptionType,
@@ -1245,6 +1267,14 @@ export declare enum KnownCreatedByType {
     Key = "Key"
 }
 
+/** Known values of {@link EnableSubvolumes} that the service accepts. */
+export declare enum KnownEnableSubvolumes {
+    /** subvolumes are enabled */
+    Enabled = "Enabled",
+    /** subvolumes are not enabled */
+    Disabled = "Disabled"
+}
+
 /** Known values of {@link EncryptionType} that the service accepts. */
 export declare enum KnownEncryptionType {
     /** EncryptionType Single, volumes will use single encryption at rest */
@@ -1334,6 +1364,16 @@ export declare enum KnownVolumeStorageToNetworkProximity {
     T2 = "T2"
 }
 
+/** LDAP search scope */
+export declare interface LdapSearchScopeOpt {
+    /** This specifies the user DN, which overrides the base DN for user lookups. */
+    userDN?: string;
+    /** This specifies the group DN, which overrides the base DN for group lookups. */
+    groupDN?: string;
+    /** This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. */
+    groupMembershipFilter?: string;
+}
+
 /** Log Definition of a single resource metric. */
 export declare interface LogSpecification {
     /** Name of log specification. */
@@ -1580,6 +1620,7 @@ export declare class NetAppManagementClient extends coreClient.ServiceClient {
     backupPolicies: BackupPolicies;
     vaults: Vaults;
     volumeGroups: VolumeGroups;
+    subvolumes: Subvolumes;
 }
 
 /** Optional parameters. */
@@ -2235,6 +2276,11 @@ export declare interface SnapshotPolicy {
     tags?: {
         [propertyName: string]: string;
     };
+    /**
+     * The system meta data relating to this resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
     /** Schedule for hourly snapshots */
     hourlySchedule?: HourlySchedule;
     /** Schedule for daily snapshots */
@@ -2338,6 +2384,14 @@ export declare interface SnapshotPolicyVolumeList {
     value?: Volume[];
 }
 
+/** Restore payload for Single File Snapshot Restore */
+export declare interface SnapshotRestoreFiles {
+    /** List of files to be restored */
+    filePaths: string[];
+    /** Destination folder where the files will be restored */
+    destinationPath?: string;
+}
+
 /** Interface representing a Snapshots. */
 export declare interface Snapshots {
     /**
@@ -2423,6 +2477,28 @@ export declare interface Snapshots {
      * @param options The options parameters.
      */
     beginDeleteAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, options?: SnapshotsDeleteOptionalParams): Promise<void>;
+    /**
+     * Restore the specified files from the specified snapshot to the active filesystem
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param snapshotName The name of the snapshot
+     * @param body Restore payload supplied in the body of the operation.
+     * @param options The options parameters.
+     */
+    beginRestoreFiles(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: SnapshotRestoreFiles, options?: SnapshotsRestoreFilesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    /**
+     * Restore the specified files from the specified snapshot to the active filesystem
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param snapshotName The name of the snapshot
+     * @param body Restore payload supplied in the body of the operation.
+     * @param options The options parameters.
+     */
+    beginRestoreFilesAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: SnapshotRestoreFiles, options?: SnapshotsRestoreFilesOptionalParams): Promise<void>;
 }
 
 /** Optional parameters. */
@@ -2464,6 +2540,14 @@ export declare interface SnapshotsListOptionalParams extends coreClient.Operatio
 /** Contains response data for the list operation. */
 export declare type SnapshotsListResponse = SnapshotsList;
 
+/** Optional parameters. */
+export declare interface SnapshotsRestoreFilesOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
 /** Optional parameters. */
 export declare interface SnapshotsUpdateOptionalParams extends coreClient.OperationOptions {
     /** Delay to wait until next poll, in milliseconds. */
@@ -2500,6 +2584,250 @@ export declare interface SubscriptionQuotaItemList {
     value?: SubscriptionQuotaItem[];
 }
 
+/** Subvolume Information properties */
+export declare type SubvolumeInfo = ProxyResource & {
+    /**
+     * The system meta data relating to this resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
+    /** Path to the subvolume */
+    path?: string;
+    /** Truncate subvolume to the provided size in bytes */
+    size?: number;
+    /** parent path to the subvolume */
+    parentPath?: string;
+    /**
+     * Azure lifecycle management
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: string;
+};
+
+/** Result of the post subvolume and action is to get metadata of the subvolume. */
+export declare interface SubvolumeModel {
+    /**
+     * Resource Id
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * Resource name
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * Resource type
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /** Path to the subvolume */
+    path?: string;
+    /** Path to the parent subvolume */
+    parentPath?: string;
+    /** Size of subvolume */
+    size?: number;
+    /** Bytes used */
+    bytesUsed?: number;
+    /** Permissions of the subvolume */
+    permissions?: string;
+    /** Creation time and date */
+    creationTimeStamp?: Date;
+    /** Most recent access time and date */
+    accessedTimeStamp?: Date;
+    /** Most recent modification time and date */
+    modifiedTimeStamp?: Date;
+    /** Most recent change time and date */
+    changedTimeStamp?: Date;
+    /** Azure lifecycle management */
+    provisioningState?: string;
+}
+
+/** Subvolume Patch Request properties */
+export declare interface SubvolumePatchRequest {
+    /** Truncate subvolume to the provided size in bytes */
+    size?: number;
+    /** path to the subvolume */
+    path?: string;
+}
+
+/** Interface representing a Subvolumes. */
+export declare interface Subvolumes {
+    /**
+     * Returns a list of the subvolumes in the volume
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param options The options parameters.
+     */
+    listByVolume(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: SubvolumesListByVolumeOptionalParams): PagedAsyncIterableIterator<SubvolumeInfo>;
+    /**
+     * Returns the path associated with the subvolumeName provided
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param subvolumeName The name of the subvolume.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesGetOptionalParams): Promise<SubvolumesGetResponse>;
+    /**
+     * Creates a subvolume in the path or clones the subvolume mentioned in the parentPath
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param subvolumeName The name of the subvolume.
+     * @param body Subvolume object supplied in the body of the operation.
+     * @param options The options parameters.
+     */
+    beginCreate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumeInfo, options?: SubvolumesCreateOptionalParams): Promise<PollerLike<PollOperationState<SubvolumesCreateResponse>, SubvolumesCreateResponse>>;
+    /**
+     * Creates a subvolume in the path or clones the subvolume mentioned in the parentPath
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param subvolumeName The name of the subvolume.
+     * @param body Subvolume object supplied in the body of the operation.
+     * @param options The options parameters.
+     */
+    beginCreateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumeInfo, options?: SubvolumesCreateOptionalParams): Promise<SubvolumesCreateResponse>;
+    /**
+     * Patch a subvolume
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param subvolumeName The name of the subvolume.
+     * @param body Subvolume object supplied in the body of the operation.
+     * @param options The options parameters.
+     */
+    beginUpdate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumePatchRequest, options?: SubvolumesUpdateOptionalParams): Promise<PollerLike<PollOperationState<SubvolumesUpdateResponse>, SubvolumesUpdateResponse>>;
+    /**
+     * Patch a subvolume
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param subvolumeName The name of the subvolume.
+     * @param body Subvolume object supplied in the body of the operation.
+     * @param options The options parameters.
+     */
+    beginUpdateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumePatchRequest, options?: SubvolumesUpdateOptionalParams): Promise<SubvolumesUpdateResponse>;
+    /**
+     * Delete subvolume
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param subvolumeName The name of the subvolume.
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    /**
+     * Delete subvolume
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param subvolumeName The name of the subvolume.
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesDeleteOptionalParams): Promise<void>;
+    /**
+     * Get details of the specified subvolume
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param subvolumeName The name of the subvolume.
+     * @param options The options parameters.
+     */
+    beginGetMetadata(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesGetMetadataOptionalParams): Promise<PollerLike<PollOperationState<SubvolumesGetMetadataResponse>, SubvolumesGetMetadataResponse>>;
+    /**
+     * Get details of the specified subvolume
+     * @param resourceGroupName The name of the resource group.
+     * @param accountName The name of the NetApp account
+     * @param poolName The name of the capacity pool
+     * @param volumeName The name of the volume
+     * @param subvolumeName The name of the subvolume.
+     * @param options The options parameters.
+     */
+    beginGetMetadataAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesGetMetadataOptionalParams): Promise<SubvolumesGetMetadataResponse>;
+}
+
+/** Optional parameters. */
+export declare interface SubvolumesCreateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the create operation. */
+export declare type SubvolumesCreateResponse = SubvolumeInfo;
+
+/** Optional parameters. */
+export declare interface SubvolumesDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Optional parameters. */
+export declare interface SubvolumesGetMetadataOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the getMetadata operation. */
+export declare type SubvolumesGetMetadataResponse = SubvolumeModel;
+
+/** Optional parameters. */
+export declare interface SubvolumesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type SubvolumesGetResponse = SubvolumeInfo;
+
+/** List of Subvolumes */
+export declare interface SubvolumesList {
+    /** A list of Subvolumes */
+    value?: SubvolumeInfo[];
+    /** URL to get the next set of results. */
+    nextLink?: string;
+}
+
+/** Optional parameters. */
+export declare interface SubvolumesListByVolumeNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByVolumeNext operation. */
+export declare type SubvolumesListByVolumeNextResponse = SubvolumesList;
+
+/** Optional parameters. */
+export declare interface SubvolumesListByVolumeOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByVolume operation. */
+export declare type SubvolumesListByVolumeResponse = SubvolumesList;
+
+/** Optional parameters. */
+export declare interface SubvolumesUpdateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the update operation. */
+export declare type SubvolumesUpdateResponse = SubvolumeInfo;
+
 /** Metadata pertaining to creation and last modification of the resource. */
 export declare interface SystemData {
     /** The identity that created the resource. */
@@ -2591,6 +2919,11 @@ export declare interface Volume {
     tags?: {
         [propertyName: string]: string;
     };
+    /**
+     * The system meta data relating to this resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
     /**
      * Unique FileSystem Identifier.
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -2680,6 +3013,11 @@ export declare interface Volume {
     defaultUserQuotaInKiBs?: number;
     /** Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. */
     defaultGroupQuotaInKiBs?: number;
+    /**
+     * Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly maximumNumberOfFiles?: number;
     /**
      * Volume Group Name
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -2698,6 +3036,8 @@ export declare interface Volume {
     volumeSpecName?: string;
     /** Application specific placement rules for the particular volume */
     placementRules?: PlacementKeyValuePairs[];
+    /** Flag indicating whether subvolume operations are enabled on the volume */
+    enableSubvolumes?: EnableSubvolumes;
 }
 
 /** Volume Backup Properties */
@@ -3006,6 +3346,11 @@ export declare interface VolumeGroupVolumeProperties {
     defaultUserQuotaInKiBs?: number;
     /** Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. */
     defaultGroupQuotaInKiBs?: number;
+    /**
+     * Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly maximumNumberOfFiles?: number;
     /**
      * Volume Group Name
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -3024,6 +3369,8 @@ export declare interface VolumeGroupVolumeProperties {
     volumeSpecName?: string;
     /** Application specific placement rules for the particular volume */
     placementRules?: PlacementKeyValuePairs[];
+    /** Flag indicating whether subvolume operations are enabled on the volume */
+    enableSubvolumes?: EnableSubvolumes;
 }
 
 /** List of volume resources */
@@ -3073,6 +3420,8 @@ export declare interface VolumePatch {
     defaultUserQuotaInKiBs?: number;
     /** Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. */
     defaultGroupQuotaInKiBs?: number;
+    /** UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. */
+    unixPermissions?: string;
 }
 
 /** DataProtection type volumes include an object containing details of the replication */
@@ -3366,6 +3715,8 @@ export declare type VolumesCreateOrUpdateResponse = Volume;
 
 /** Optional parameters. */
 export declare interface VolumesDeleteOptionalParams extends coreClient.OperationOptions {
+    /** An option to force delete the volume. Will cleanup resources connected to the particular volume */
+    forceDelete?: boolean;
     /** Delay to wait until next poll, in milliseconds. */
     updateIntervalInMs?: number;
     /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */