Package version:

Interface VolumePatch

Volume patch resource

interface VolumePatch {
    coolAccess?: boolean;
    coolAccessRetrievalPolicy?: string;
    coolAccessTieringPolicy?: string;
    coolnessPeriod?: number;
    dataProtection?: VolumePatchPropertiesDataProtection;
    defaultGroupQuotaInKiBs?: number;
    defaultUserQuotaInKiBs?: number;
    exportPolicy?: VolumePatchPropertiesExportPolicy;
    id?: string;
    isDefaultQuotaEnabled?: boolean;
    location?: string;
    name?: string;
    protocolTypes?: string[];
    serviceLevel?: string;
    smbAccessBasedEnumeration?: string;
    smbNonBrowsable?: string;
    snapshotDirectoryVisible?: boolean;
    tags?: {
        [propertyName: string]: string;
    };
    throughputMibps?: number;
    type?: string;
    unixPermissions?: string;
    usageThreshold?: number;
}

Properties

coolAccess? coolAccessRetrievalPolicy? coolAccessTieringPolicy? coolnessPeriod? dataProtection? defaultGroupQuotaInKiBs? defaultUserQuotaInKiBs? exportPolicy? id? isDefaultQuotaEnabled? location? name? protocolTypes? serviceLevel? smbAccessBasedEnumeration? smbNonBrowsable? snapshotDirectoryVisible? tags? throughputMibps? type? unixPermissions? usageThreshold?

Properties

OptionalcoolAccess

coolAccess?: boolean

Specifies whether Cool Access(tiering) is enabled for the volume.

OptionalcoolAccessRetrievalPolicy

coolAccessRetrievalPolicy?: string

coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage.

OptionalcoolAccessTieringPolicy

coolAccessTieringPolicy?: string

coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier.

OptionalcoolnessPeriod

coolnessPeriod?: number

Specifies the number of days after which data that is not accessed by clients will be tiered.

OptionaldataProtection

dataProtection?: VolumePatchPropertiesDataProtection

DataProtection type volumes include an object containing details of the replication

OptionaldefaultGroupQuotaInKiBs

defaultGroupQuotaInKiBs?: number

Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

OptionaldefaultUserQuotaInKiBs

defaultUserQuotaInKiBs?: number

Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .

OptionalexportPolicy

exportPolicy?: VolumePatchPropertiesExportPolicy

Set of export policy rules

Optional Readonlyid

id?: string

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

OptionalisDefaultQuotaEnabled

isDefaultQuotaEnabled?: boolean

Specifies if default quota is enabled for the volume.

Optionallocation

location?: string

Resource location

Optional Readonlyname

name?: string

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

OptionalprotocolTypes

protocolTypes?: string[]

Set of protocol types, default NFSv3, CIFS for SMB protocol

OptionalserviceLevel

serviceLevel?: string

The service level of the file system

OptionalsmbAccessBasedEnumeration

smbAccessBasedEnumeration?: string

Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume

OptionalsmbNonBrowsable

smbNonBrowsable?: string

Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume

OptionalsnapshotDirectoryVisible

snapshotDirectoryVisible?: boolean

If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots.

Optionaltags

tags?: {
    [propertyName: string]: string;
}

Resource tags

OptionalthroughputMibps

throughputMibps?: number

Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume

Optional Readonlytype

type?: string

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

OptionalunixPermissions

unixPermissions?: string

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.

OptionalusageThreshold

usageThreshold?: number

Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.

Settings

Member Visibility