Volume Class

Volume resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

Volume

Constructor

Volume(*, location: str, creation_token: str, usage_threshold: int = 107374182400, subnet_id: str, tags: Optional[Dict[str, str]] = None, service_level: Optional[Union[str, azure.mgmt.netapp.models._net_app_management_client_enums.ServiceLevel]] = 'Premium', export_policy: Optional[azure.mgmt.netapp.models._models_py3.VolumePropertiesExportPolicy] = None, protocol_types: Optional[List[str]] = None, snapshot_id: Optional[str] = None, backup_id: Optional[str] = None, network_features: Optional[Union[str, azure.mgmt.netapp.models._net_app_management_client_enums.NetworkFeatures]] = 'Basic', volume_type: Optional[str] = None, data_protection: Optional[azure.mgmt.netapp.models._models_py3.VolumePropertiesDataProtection] = None, is_restoring: Optional[bool] = None, snapshot_directory_visible: Optional[bool] = True, kerberos_enabled: Optional[bool] = False, security_style: Optional[Union[str, azure.mgmt.netapp.models._net_app_management_client_enums.SecurityStyle]] = 'unix', smb_encryption: Optional[bool] = False, smb_continuously_available: Optional[bool] = False, throughput_mibps: Optional[float] = 0, encryption_key_source: Optional[str] = None, ldap_enabled: Optional[bool] = False, cool_access: Optional[bool] = False, coolness_period: Optional[int] = None, unix_permissions: Optional[str] = '0770', avs_data_store: Optional[Union[str, azure.mgmt.netapp.models._net_app_management_client_enums.AvsDataStore]] = 'Disabled', is_default_quota_enabled: Optional[bool] = False, default_user_quota_in_ki_bs: Optional[int] = 0, default_group_quota_in_ki_bs: Optional[int] = 0, **kwargs)

Parameters

location

str

Required

Required. Resource location.

tags

dict[str, str]

Required

A set of tags. Resource tags.

creation_token

str

Required

Required. A unique file path for the volume. Used when creating mount targets.

service_level

str or ServiceLevel

Required

The service level of the file system. Possible values include: "Standard", "Premium", "Ultra", "StandardZRS". Default value: "Premium".

usage_threshold

<xref:long>

Required

Required. Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. Specified in bytes.

export_policy

VolumePropertiesExportPolicy

Required

Set of export policy rules.

protocol_types

list[str]

Required

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

snapshot_id

str

Required

UUID v4 or resource identifier used to identify the Snapshot.

backup_id

str

Required

UUID v4 or resource identifier used to identify the Backup.

subnet_id

str

Required

Required. The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.

network_features

str or NetworkFeatures

Required

Basic network, or Standard features available to the volume. Possible values include: "Basic", "Standard". Default value: "Basic".

volume_type

str

Required

What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection.

data_protection

VolumePropertiesDataProtection

Required

DataProtection type volumes include an object containing details of the replication.

is_restoring

bool

Required

Restoring.

snapshot_directory_visible

bool

Required

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

kerberos_enabled

bool

Required

Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later.

security_style

str or SecurityStyle

Required

The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol. Possible values include: "ntfs", "unix". Default value: "unix".

smb_encryption

bool

Required

Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.

smb_continuously_available

bool

Required

Enables continuously available share property for smb volume. Only applicable for SMB volume.

throughput_mibps

float

Required

Maximum throughput in Mibps that can be achieved by this volume.

encryption_key_source

str

Required

Encryption Key Source. Possible values are: 'Microsoft.NetApp'.

ldap_enabled

bool

Required

Specifies whether LDAP is enabled or not for a given NFS volume.

cool_access

bool

Required

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

coolness_period

int

Required

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

unix_permissions

str

Required

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.

avs_data_store

str or AvsDataStore

Required

Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose. Possible values include: "Enabled", "Disabled". Default value: "Disabled".

is_default_quota_enabled

bool

Required

Specifies if default quota is enabled for the volume.

default_user_quota_in_ki_bs

<xref:long>

Required

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

default_group_quota_in_ki_bs

<xref:long>

Required

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

Variables

id

str

Resource Id.

name

str

Resource name.

etag

str

A unique read-only string that changes whenever the resource is updated.

type

str

Resource type.

file_system_id

str

Unique FileSystem Identifier.

provisioning_state

str

Azure lifecycle management.

baremetal_tenant_id

str

Unique Baremetal Tenant Identifier.

network_sibling_set_id

str

Network Sibling Set ID for the the group of volumes sharing networking resources.

storage_to_network_proximity

str or VolumeStorageToNetworkProximity

Provides storage to network proximity information for the volume. Possible values include: "Default", "T1", "T2".

mount_targets

list[MountTargetProperties]

List of mount targets.

clone_progress

int

When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.