Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. netapp
  5. getCapacityPoolVolume
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.netapp.getCapacityPoolVolume

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the details of the specified volume

Uses Azure REST API version 2024-09-01.

Other available API versions: 2022-11-01, 2022-11-01-preview, 2023-05-01, 2023-05-01-preview, 2023-07-01, 2023-07-01-preview, 2023-11-01, 2023-11-01-preview, 2024-01-01, 2024-03-01, 2024-03-01-preview, 2024-05-01, 2024-05-01-preview, 2024-07-01, 2024-07-01-preview, 2024-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native netapp [ApiVersion]. See the version guide for details.

Using getCapacityPoolVolume

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCapacityPoolVolume(args: GetCapacityPoolVolumeArgs, opts?: InvokeOptions): Promise<GetCapacityPoolVolumeResult>
function getCapacityPoolVolumeOutput(args: GetCapacityPoolVolumeOutputArgs, opts?: InvokeOptions): Output<GetCapacityPoolVolumeResult>
Copy
def get_capacity_pool_volume(account_name: Optional[str] = None,
                             pool_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             volume_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCapacityPoolVolumeResult
def get_capacity_pool_volume_output(account_name: Optional[pulumi.Input[str]] = None,
                             pool_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             volume_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCapacityPoolVolumeResult]
Copy
func LookupCapacityPoolVolume(ctx *Context, args *LookupCapacityPoolVolumeArgs, opts ...InvokeOption) (*LookupCapacityPoolVolumeResult, error)
func LookupCapacityPoolVolumeOutput(ctx *Context, args *LookupCapacityPoolVolumeOutputArgs, opts ...InvokeOption) LookupCapacityPoolVolumeResultOutput
Copy

> Note: This function is named LookupCapacityPoolVolume in the Go SDK.

public static class GetCapacityPoolVolume 
{
    public static Task<GetCapacityPoolVolumeResult> InvokeAsync(GetCapacityPoolVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetCapacityPoolVolumeResult> Invoke(GetCapacityPoolVolumeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCapacityPoolVolumeResult> getCapacityPoolVolume(GetCapacityPoolVolumeArgs args, InvokeOptions options)
public static Output<GetCapacityPoolVolumeResult> getCapacityPoolVolume(GetCapacityPoolVolumeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:netapp:getCapacityPoolVolume
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
PoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the capacity pool
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VolumeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the volume
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
PoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the capacity pool
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VolumeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the volume
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NetApp account
poolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the capacity pool
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
volumeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the volume
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NetApp account
poolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the capacity pool
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
volumeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the volume
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the NetApp account
pool_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the capacity pool
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
volume_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the volume
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NetApp account
poolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the capacity pool
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
volumeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the volume

getCapacityPoolVolume Result

The following output properties are available:

ActualThroughputMibps double
Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel
AzureApiVersion string
The Azure API version of the resource.
BaremetalTenantId string
Unique Baremetal Tenant Identifier.
CloneProgress 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.
CreationToken string
A unique file path for the volume. Used when creating mount targets
DataStoreResourceId List<string>
Data store resource unique identifier
EffectiveNetworkFeatures string
The effective value of the network features type available to the volume, or current effective state of update.
Encrypted bool
Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.
Etag string
A unique read-only string that changes whenever the resource is updated.
FileAccessLogs string
Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
FileSystemId string
Unique FileSystem Identifier.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
MaximumNumberOfFiles double
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.
MountTargets List<Pulumi.AzureNative.NetApp.Outputs.MountTargetPropertiesResponse>
List of mount targets
Name string
The name of the resource
NetworkSiblingSetId string
Network Sibling Set ID for the the group of volumes sharing networking resources.
OriginatingResourceId string
Id of the snapshot or backup that the volume is restored from.
ProvisionedAvailabilityZone string
The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.
ProvisioningState string
Azure lifecycle management
StorageToNetworkProximity string
Provides storage to network proximity information for the volume.
SubnetId string
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
SystemData Pulumi.AzureNative.NetApp.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
T2Network string
T2 network information
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UsageThreshold double
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.
VolumeGroupName string
Volume Group Name
AvsDataStore string
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
BackupId string
Resource identifier used to identify the Backup.
CapacityPoolResourceId string
Pool Resource Id used in case of creating a volume through volume group
CoolAccess bool
Specifies whether Cool Access(tiering) is enabled for the volume.
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.
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.
CoolnessPeriod int
Specifies the number of days after which data that is not accessed by clients will be tiered.
DataProtection Pulumi.AzureNative.NetApp.Outputs.VolumePropertiesResponseDataProtection
DataProtection type volumes include an object containing details of the replication
DefaultGroupQuotaInKiBs double
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
DefaultUserQuotaInKiBs double
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
DeleteBaseSnapshot bool
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false
EnableSubvolumes string
Flag indicating whether subvolume operations are enabled on the volume
EncryptionKeySource string
Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
ExportPolicy Pulumi.AzureNative.NetApp.Outputs.VolumePropertiesResponseExportPolicy
Set of export policy rules
IsDefaultQuotaEnabled bool
Specifies if default quota is enabled for the volume.
IsLargeVolume bool
Specifies whether volume is a Large Volume or Regular Volume.
IsRestoring bool
Restoring
KerberosEnabled bool
Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
KeyVaultPrivateEndpointResourceId string
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
LdapEnabled bool
Specifies whether LDAP is enabled or not for a given NFS volume.
NetworkFeatures string
The original value of the network features type available to the volume at the time it was created.
PlacementRules List<Pulumi.AzureNative.NetApp.Outputs.PlacementKeyValuePairsResponse>
Application specific placement rules for the particular volume
ProtocolTypes List<string>
Set of protocol types, default NFSv3, CIFS for SMB protocol
ProximityPlacementGroup string
Proximity placement group associated with the volume
SecurityStyle string
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
ServiceLevel string
The service level of the file system
SmbAccessBasedEnumeration string
Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
SmbContinuouslyAvailable bool
Enables continuously available share property for smb volume. Only applicable for SMB volume
SmbEncryption bool
Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later
SmbNonBrowsable string
Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
SnapshotDirectoryVisible bool
If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
SnapshotId string
Resource identifier used to identify the Snapshot.
Tags Dictionary<string, string>
Resource tags.
ThroughputMibps double
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.
VolumeSpecName string
Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log
VolumeType string
What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection
Zones List<string>
Availability Zone
ActualThroughputMibps float64
Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel
AzureApiVersion string
The Azure API version of the resource.
BaremetalTenantId string
Unique Baremetal Tenant Identifier.
CloneProgress 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.
CreationToken string
A unique file path for the volume. Used when creating mount targets
DataStoreResourceId []string
Data store resource unique identifier
EffectiveNetworkFeatures string
The effective value of the network features type available to the volume, or current effective state of update.
Encrypted bool
Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.
Etag string
A unique read-only string that changes whenever the resource is updated.
FileAccessLogs string
Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
FileSystemId string
Unique FileSystem Identifier.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
MaximumNumberOfFiles float64
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.
MountTargets []MountTargetPropertiesResponse
List of mount targets
Name string
The name of the resource
NetworkSiblingSetId string
Network Sibling Set ID for the the group of volumes sharing networking resources.
OriginatingResourceId string
Id of the snapshot or backup that the volume is restored from.
ProvisionedAvailabilityZone string
The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.
ProvisioningState string
Azure lifecycle management
StorageToNetworkProximity string
Provides storage to network proximity information for the volume.
SubnetId string
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
T2Network string
T2 network information
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UsageThreshold float64
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.
VolumeGroupName string
Volume Group Name
AvsDataStore string
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
BackupId string
Resource identifier used to identify the Backup.
CapacityPoolResourceId string
Pool Resource Id used in case of creating a volume through volume group
CoolAccess bool
Specifies whether Cool Access(tiering) is enabled for the volume.
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.
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.
CoolnessPeriod int
Specifies the number of days after which data that is not accessed by clients will be tiered.
DataProtection VolumePropertiesResponseDataProtection
DataProtection type volumes include an object containing details of the replication
DefaultGroupQuotaInKiBs float64
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
DefaultUserQuotaInKiBs float64
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
DeleteBaseSnapshot bool
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false
EnableSubvolumes string
Flag indicating whether subvolume operations are enabled on the volume
EncryptionKeySource string
Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
ExportPolicy VolumePropertiesResponseExportPolicy
Set of export policy rules
IsDefaultQuotaEnabled bool
Specifies if default quota is enabled for the volume.
IsLargeVolume bool
Specifies whether volume is a Large Volume or Regular Volume.
IsRestoring bool
Restoring
KerberosEnabled bool
Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
KeyVaultPrivateEndpointResourceId string
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
LdapEnabled bool
Specifies whether LDAP is enabled or not for a given NFS volume.
NetworkFeatures string
The original value of the network features type available to the volume at the time it was created.
PlacementRules []PlacementKeyValuePairsResponse
Application specific placement rules for the particular volume
ProtocolTypes []string
Set of protocol types, default NFSv3, CIFS for SMB protocol
ProximityPlacementGroup string
Proximity placement group associated with the volume
SecurityStyle string
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
ServiceLevel string
The service level of the file system
SmbAccessBasedEnumeration string
Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
SmbContinuouslyAvailable bool
Enables continuously available share property for smb volume. Only applicable for SMB volume
SmbEncryption bool
Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later
SmbNonBrowsable string
Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
SnapshotDirectoryVisible bool
If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
SnapshotId string
Resource identifier used to identify the Snapshot.
Tags map[string]string
Resource tags.
ThroughputMibps float64
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.
VolumeSpecName string
Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log
VolumeType string
What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection
Zones []string
Availability Zone
actualThroughputMibps Double
Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel
azureApiVersion String
The Azure API version of the resource.
baremetalTenantId String
Unique Baremetal Tenant Identifier.
cloneProgress Integer
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.
creationToken String
A unique file path for the volume. Used when creating mount targets
dataStoreResourceId List<String>
Data store resource unique identifier
effectiveNetworkFeatures String
The effective value of the network features type available to the volume, or current effective state of update.
encrypted Boolean
Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.
etag String
A unique read-only string that changes whenever the resource is updated.
fileAccessLogs String
Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
fileSystemId String
Unique FileSystem Identifier.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
maximumNumberOfFiles Double
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.
mountTargets List<MountTargetPropertiesResponse>
List of mount targets
name String
The name of the resource
networkSiblingSetId String
Network Sibling Set ID for the the group of volumes sharing networking resources.
originatingResourceId String
Id of the snapshot or backup that the volume is restored from.
provisionedAvailabilityZone String
The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.
provisioningState String
Azure lifecycle management
storageToNetworkProximity String
Provides storage to network proximity information for the volume.
subnetId String
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
t2Network String
T2 network information
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
usageThreshold Double
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.
volumeGroupName String
Volume Group Name
avsDataStore String
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
backupId String
Resource identifier used to identify the Backup.
capacityPoolResourceId String
Pool Resource Id used in case of creating a volume through volume group
coolAccess Boolean
Specifies whether Cool Access(tiering) is enabled for the volume.
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.
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.
coolnessPeriod Integer
Specifies the number of days after which data that is not accessed by clients will be tiered.
dataProtection VolumePropertiesResponseDataProtection
DataProtection type volumes include an object containing details of the replication
defaultGroupQuotaInKiBs Double
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
defaultUserQuotaInKiBs Double
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
deleteBaseSnapshot Boolean
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false
enableSubvolumes String
Flag indicating whether subvolume operations are enabled on the volume
encryptionKeySource String
Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
exportPolicy VolumePropertiesResponseExportPolicy
Set of export policy rules
isDefaultQuotaEnabled Boolean
Specifies if default quota is enabled for the volume.
isLargeVolume Boolean
Specifies whether volume is a Large Volume or Regular Volume.
isRestoring Boolean
Restoring
kerberosEnabled Boolean
Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
keyVaultPrivateEndpointResourceId String
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
ldapEnabled Boolean
Specifies whether LDAP is enabled or not for a given NFS volume.
networkFeatures String
The original value of the network features type available to the volume at the time it was created.
placementRules List<PlacementKeyValuePairsResponse>
Application specific placement rules for the particular volume
protocolTypes List<String>
Set of protocol types, default NFSv3, CIFS for SMB protocol
proximityPlacementGroup String
Proximity placement group associated with the volume
securityStyle String
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
serviceLevel String
The service level of the file system
smbAccessBasedEnumeration String
Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
smbContinuouslyAvailable Boolean
Enables continuously available share property for smb volume. Only applicable for SMB volume
smbEncryption Boolean
Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later
smbNonBrowsable String
Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
snapshotDirectoryVisible Boolean
If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
snapshotId String
Resource identifier used to identify the Snapshot.
tags Map<String,String>
Resource tags.
throughputMibps Double
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.
volumeSpecName String
Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log
volumeType String
What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection
zones List<String>
Availability Zone
actualThroughputMibps number
Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel
azureApiVersion string
The Azure API version of the resource.
baremetalTenantId string
Unique Baremetal Tenant Identifier.
cloneProgress number
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.
creationToken string
A unique file path for the volume. Used when creating mount targets
dataStoreResourceId string[]
Data store resource unique identifier
effectiveNetworkFeatures string
The effective value of the network features type available to the volume, or current effective state of update.
encrypted boolean
Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.
etag string
A unique read-only string that changes whenever the resource is updated.
fileAccessLogs string
Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
fileSystemId string
Unique FileSystem Identifier.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
maximumNumberOfFiles 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.
mountTargets MountTargetPropertiesResponse[]
List of mount targets
name string
The name of the resource
networkSiblingSetId string
Network Sibling Set ID for the the group of volumes sharing networking resources.
originatingResourceId string
Id of the snapshot or backup that the volume is restored from.
provisionedAvailabilityZone string
The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.
provisioningState string
Azure lifecycle management
storageToNetworkProximity string
Provides storage to network proximity information for the volume.
subnetId string
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
t2Network string
T2 network information
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
volumeGroupName string
Volume Group Name
avsDataStore string
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
backupId string
Resource identifier used to identify the Backup.
capacityPoolResourceId string
Pool Resource Id used in case of creating a volume through volume group
coolAccess boolean
Specifies whether Cool Access(tiering) is enabled for the volume.
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.
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.
coolnessPeriod number
Specifies the number of days after which data that is not accessed by clients will be tiered.
dataProtection VolumePropertiesResponseDataProtection
DataProtection type volumes include an object containing details of the replication
defaultGroupQuotaInKiBs number
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
defaultUserQuotaInKiBs number
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
deleteBaseSnapshot boolean
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false
enableSubvolumes string
Flag indicating whether subvolume operations are enabled on the volume
encryptionKeySource string
Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
exportPolicy VolumePropertiesResponseExportPolicy
Set of export policy rules
isDefaultQuotaEnabled boolean
Specifies if default quota is enabled for the volume.
isLargeVolume boolean
Specifies whether volume is a Large Volume or Regular Volume.
isRestoring boolean
Restoring
kerberosEnabled boolean
Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
keyVaultPrivateEndpointResourceId string
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
ldapEnabled boolean
Specifies whether LDAP is enabled or not for a given NFS volume.
networkFeatures string
The original value of the network features type available to the volume at the time it was created.
placementRules PlacementKeyValuePairsResponse[]
Application specific placement rules for the particular volume
protocolTypes string[]
Set of protocol types, default NFSv3, CIFS for SMB protocol
proximityPlacementGroup string
Proximity placement group associated with the volume
securityStyle string
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
serviceLevel string
The service level of the file system
smbAccessBasedEnumeration string
Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
smbContinuouslyAvailable boolean
Enables continuously available share property for smb volume. Only applicable for SMB volume
smbEncryption boolean
Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later
smbNonBrowsable string
Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
snapshotDirectoryVisible boolean
If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
snapshotId string
Resource identifier used to identify the Snapshot.
tags {[key: string]: string}
Resource tags.
throughputMibps number
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.
volumeSpecName string
Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log
volumeType string
What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection
zones string[]
Availability Zone
actual_throughput_mibps float
Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel
azure_api_version str
The Azure API version of the resource.
baremetal_tenant_id str
Unique Baremetal Tenant Identifier.
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.
creation_token str
A unique file path for the volume. Used when creating mount targets
data_store_resource_id Sequence[str]
Data store resource unique identifier
effective_network_features str
The effective value of the network features type available to the volume, or current effective state of update.
encrypted bool
Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.
etag str
A unique read-only string that changes whenever the resource is updated.
file_access_logs str
Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
file_system_id str
Unique FileSystem Identifier.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
maximum_number_of_files float
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.
mount_targets Sequence[MountTargetPropertiesResponse]
List of mount targets
name str
The name of the resource
network_sibling_set_id str
Network Sibling Set ID for the the group of volumes sharing networking resources.
originating_resource_id str
Id of the snapshot or backup that the volume is restored from.
provisioned_availability_zone str
The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.
provisioning_state str
Azure lifecycle management
storage_to_network_proximity str
Provides storage to network proximity information for the volume.
subnet_id str
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
t2_network str
T2 network information
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
usage_threshold float
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.
volume_group_name str
Volume Group Name
avs_data_store str
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
backup_id str
Resource identifier used to identify the Backup.
capacity_pool_resource_id str
Pool Resource Id used in case of creating a volume through volume group
cool_access bool
Specifies whether Cool Access(tiering) is enabled for the volume.
cool_access_retrieval_policy str
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.
cool_access_tiering_policy str
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.
coolness_period int
Specifies the number of days after which data that is not accessed by clients will be tiered.
data_protection VolumePropertiesResponseDataProtection
DataProtection type volumes include an object containing details of the replication
default_group_quota_in_ki_bs float
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
default_user_quota_in_ki_bs float
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
delete_base_snapshot bool
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false
enable_subvolumes str
Flag indicating whether subvolume operations are enabled on the volume
encryption_key_source str
Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
export_policy VolumePropertiesResponseExportPolicy
Set of export policy rules
is_default_quota_enabled bool
Specifies if default quota is enabled for the volume.
is_large_volume bool
Specifies whether volume is a Large Volume or Regular Volume.
is_restoring bool
Restoring
kerberos_enabled bool
Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
key_vault_private_endpoint_resource_id str
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
ldap_enabled bool
Specifies whether LDAP is enabled or not for a given NFS volume.
network_features str
The original value of the network features type available to the volume at the time it was created.
placement_rules Sequence[PlacementKeyValuePairsResponse]
Application specific placement rules for the particular volume
protocol_types Sequence[str]
Set of protocol types, default NFSv3, CIFS for SMB protocol
proximity_placement_group str
Proximity placement group associated with the volume
security_style str
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
service_level str
The service level of the file system
smb_access_based_enumeration str
Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
smb_continuously_available bool
Enables continuously available share property for smb volume. Only applicable for SMB volume
smb_encryption bool
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_non_browsable str
Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
snapshot_directory_visible bool
If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
snapshot_id str
Resource identifier used to identify the Snapshot.
tags Mapping[str, str]
Resource tags.
throughput_mibps float
unix_permissions str
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.
volume_spec_name str
Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log
volume_type str
What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection
zones Sequence[str]
Availability Zone
actualThroughputMibps Number
Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel
azureApiVersion String
The Azure API version of the resource.
baremetalTenantId String
Unique Baremetal Tenant Identifier.
cloneProgress Number
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.
creationToken String
A unique file path for the volume. Used when creating mount targets
dataStoreResourceId List<String>
Data store resource unique identifier
effectiveNetworkFeatures String
The effective value of the network features type available to the volume, or current effective state of update.
encrypted Boolean
Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.
etag String
A unique read-only string that changes whenever the resource is updated.
fileAccessLogs String
Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
fileSystemId String
Unique FileSystem Identifier.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
maximumNumberOfFiles 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.
mountTargets List<Property Map>
List of mount targets
name String
The name of the resource
networkSiblingSetId String
Network Sibling Set ID for the the group of volumes sharing networking resources.
originatingResourceId String
Id of the snapshot or backup that the volume is restored from.
provisionedAvailabilityZone String
The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.
provisioningState String
Azure lifecycle management
storageToNetworkProximity String
Provides storage to network proximity information for the volume.
subnetId String
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
t2Network String
T2 network information
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
volumeGroupName String
Volume Group Name
avsDataStore String
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
backupId String
Resource identifier used to identify the Backup.
capacityPoolResourceId String
Pool Resource Id used in case of creating a volume through volume group
coolAccess Boolean
Specifies whether Cool Access(tiering) is enabled for the volume.
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.
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.
coolnessPeriod Number
Specifies the number of days after which data that is not accessed by clients will be tiered.
dataProtection Property Map
DataProtection type volumes include an object containing details of the replication
defaultGroupQuotaInKiBs Number
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
defaultUserQuotaInKiBs Number
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
deleteBaseSnapshot Boolean
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false
enableSubvolumes String
Flag indicating whether subvolume operations are enabled on the volume
encryptionKeySource String
Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
exportPolicy Property Map
Set of export policy rules
isDefaultQuotaEnabled Boolean
Specifies if default quota is enabled for the volume.
isLargeVolume Boolean
Specifies whether volume is a Large Volume or Regular Volume.
isRestoring Boolean
Restoring
kerberosEnabled Boolean
Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
keyVaultPrivateEndpointResourceId String
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
ldapEnabled Boolean
Specifies whether LDAP is enabled or not for a given NFS volume.
networkFeatures String
The original value of the network features type available to the volume at the time it was created.
placementRules List<Property Map>
Application specific placement rules for the particular volume
protocolTypes List<String>
Set of protocol types, default NFSv3, CIFS for SMB protocol
proximityPlacementGroup String
Proximity placement group associated with the volume
securityStyle String
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
serviceLevel String
The service level of the file system
smbAccessBasedEnumeration String
Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
smbContinuouslyAvailable Boolean
Enables continuously available share property for smb volume. Only applicable for SMB volume
smbEncryption Boolean
Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later
smbNonBrowsable String
Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
snapshotDirectoryVisible Boolean
If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
snapshotId String
Resource identifier used to identify the Snapshot.
tags Map<String>
Resource tags.
throughputMibps Number
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.
volumeSpecName String
Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log
volumeType String
What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection
zones List<String>
Availability Zone

Supporting Types

ExportPolicyRuleResponse

AllowedClients string
Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names
ChownMode string
This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.
Cifs bool
Allows CIFS protocol
HasRootAccess bool
Has root access to volume
Kerberos5ReadOnly bool
Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later
Kerberos5ReadWrite bool
Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later
Kerberos5iReadOnly bool
Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later
Kerberos5iReadWrite bool
Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later
Kerberos5pReadOnly bool
Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later
Kerberos5pReadWrite bool
Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later
Nfsv3 bool
Allows NFSv3 protocol. Enable only for NFSv3 type volumes
Nfsv41 bool
Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
RuleIndex int
Order index
UnixReadOnly bool
Read only access
UnixReadWrite bool
Read and write access
AllowedClients string
Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names
ChownMode string
This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.
Cifs bool
Allows CIFS protocol
HasRootAccess bool
Has root access to volume
Kerberos5ReadOnly bool
Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later
Kerberos5ReadWrite bool
Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later
Kerberos5iReadOnly bool
Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later
Kerberos5iReadWrite bool
Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later
Kerberos5pReadOnly bool
Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later
Kerberos5pReadWrite bool
Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later
Nfsv3 bool
Allows NFSv3 protocol. Enable only for NFSv3 type volumes
Nfsv41 bool
Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
RuleIndex int
Order index
UnixReadOnly bool
Read only access
UnixReadWrite bool
Read and write access
allowedClients String
Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names
chownMode String
This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.
cifs Boolean
Allows CIFS protocol
hasRootAccess Boolean
Has root access to volume
kerberos5ReadOnly Boolean
Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later
kerberos5ReadWrite Boolean
Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5iReadOnly Boolean
Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later
kerberos5iReadWrite Boolean
Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5pReadOnly Boolean
Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later
kerberos5pReadWrite Boolean
Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later
nfsv3 Boolean
Allows NFSv3 protocol. Enable only for NFSv3 type volumes
nfsv41 Boolean
Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
ruleIndex Integer
Order index
unixReadOnly Boolean
Read only access
unixReadWrite Boolean
Read and write access
allowedClients string
Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names
chownMode string
This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.
cifs boolean
Allows CIFS protocol
hasRootAccess boolean
Has root access to volume
kerberos5ReadOnly boolean
Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later
kerberos5ReadWrite boolean
Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5iReadOnly boolean
Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later
kerberos5iReadWrite boolean
Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5pReadOnly boolean
Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later
kerberos5pReadWrite boolean
Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later
nfsv3 boolean
Allows NFSv3 protocol. Enable only for NFSv3 type volumes
nfsv41 boolean
Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
ruleIndex number
Order index
unixReadOnly boolean
Read only access
unixReadWrite boolean
Read and write access
allowed_clients str
Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names
chown_mode str
This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.
cifs bool
Allows CIFS protocol
has_root_access bool
Has root access to volume
kerberos5_read_only bool
Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later
kerberos5_read_write bool
Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5i_read_only bool
Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later
kerberos5i_read_write bool
Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5p_read_only bool
Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later
kerberos5p_read_write bool
Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later
nfsv3 bool
Allows NFSv3 protocol. Enable only for NFSv3 type volumes
nfsv41 bool
Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
rule_index int
Order index
unix_read_only bool
Read only access
unix_read_write bool
Read and write access
allowedClients String
Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names
chownMode String
This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.
cifs Boolean
Allows CIFS protocol
hasRootAccess Boolean
Has root access to volume
kerberos5ReadOnly Boolean
Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later
kerberos5ReadWrite Boolean
Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5iReadOnly Boolean
Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later
kerberos5iReadWrite Boolean
Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5pReadOnly Boolean
Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later
kerberos5pReadWrite Boolean
Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later
nfsv3 Boolean
Allows NFSv3 protocol. Enable only for NFSv3 type volumes
nfsv41 Boolean
Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
ruleIndex Number
Order index
unixReadOnly Boolean
Read only access
unixReadWrite Boolean
Read and write access

MountTargetPropertiesResponse

FileSystemId This property is required. string
UUID v4 used to identify the MountTarget
IpAddress This property is required. string
The mount target's IPv4 address
MountTargetId This property is required. string
UUID v4 used to identify the MountTarget
SmbServerFqdn string
The SMB server's Fully Qualified Domain Name, FQDN
FileSystemId This property is required. string
UUID v4 used to identify the MountTarget
IpAddress This property is required. string
The mount target's IPv4 address
MountTargetId This property is required. string
UUID v4 used to identify the MountTarget
SmbServerFqdn string
The SMB server's Fully Qualified Domain Name, FQDN
fileSystemId This property is required. String
UUID v4 used to identify the MountTarget
ipAddress This property is required. String
The mount target's IPv4 address
mountTargetId This property is required. String
UUID v4 used to identify the MountTarget
smbServerFqdn String
The SMB server's Fully Qualified Domain Name, FQDN
fileSystemId This property is required. string
UUID v4 used to identify the MountTarget
ipAddress This property is required. string
The mount target's IPv4 address
mountTargetId This property is required. string
UUID v4 used to identify the MountTarget
smbServerFqdn string
The SMB server's Fully Qualified Domain Name, FQDN
file_system_id This property is required. str
UUID v4 used to identify the MountTarget
ip_address This property is required. str
The mount target's IPv4 address
mount_target_id This property is required. str
UUID v4 used to identify the MountTarget
smb_server_fqdn str
The SMB server's Fully Qualified Domain Name, FQDN
fileSystemId This property is required. String
UUID v4 used to identify the MountTarget
ipAddress This property is required. String
The mount target's IPv4 address
mountTargetId This property is required. String
UUID v4 used to identify the MountTarget
smbServerFqdn String
The SMB server's Fully Qualified Domain Name, FQDN

PlacementKeyValuePairsResponse

Key This property is required. string
Key for an application specific parameter for the placement of volumes in the volume group
Value This property is required. string
Value for an application specific parameter for the placement of volumes in the volume group
Key This property is required. string
Key for an application specific parameter for the placement of volumes in the volume group
Value This property is required. string
Value for an application specific parameter for the placement of volumes in the volume group
key This property is required. String
Key for an application specific parameter for the placement of volumes in the volume group
value This property is required. String
Value for an application specific parameter for the placement of volumes in the volume group
key This property is required. string
Key for an application specific parameter for the placement of volumes in the volume group
value This property is required. string
Value for an application specific parameter for the placement of volumes in the volume group
key This property is required. str
Key for an application specific parameter for the placement of volumes in the volume group
value This property is required. str
Value for an application specific parameter for the placement of volumes in the volume group
key This property is required. String
Key for an application specific parameter for the placement of volumes in the volume group
value This property is required. String
Value for an application specific parameter for the placement of volumes in the volume group

RemotePathResponse

ExternalHostName This property is required. string
The Path to a ONTAP Host
ServerName This property is required. string
The name of a server on the ONTAP Host
VolumeName This property is required. string
The name of a volume on the server
ExternalHostName This property is required. string
The Path to a ONTAP Host
ServerName This property is required. string
The name of a server on the ONTAP Host
VolumeName This property is required. string
The name of a volume on the server
externalHostName This property is required. String
The Path to a ONTAP Host
serverName This property is required. String
The name of a server on the ONTAP Host
volumeName This property is required. String
The name of a volume on the server
externalHostName This property is required. string
The Path to a ONTAP Host
serverName This property is required. string
The name of a server on the ONTAP Host
volumeName This property is required. string
The name of a volume on the server
external_host_name This property is required. str
The Path to a ONTAP Host
server_name This property is required. str
The name of a server on the ONTAP Host
volume_name This property is required. str
The name of a volume on the server
externalHostName This property is required. String
The Path to a ONTAP Host
serverName This property is required. String
The name of a server on the ONTAP Host
volumeName This property is required. String
The name of a volume on the server

ReplicationObjectResponse

ReplicationId This property is required. string
Id
EndpointType string
Indicates whether the local volume is the source or destination for the Volume Replication
RemotePath Pulumi.AzureNative.NetApp.Inputs.RemotePathResponse
The full path to a volume that is to be migrated into ANF. Required for Migration volumes
RemoteVolumeRegion string
The remote region for the other end of the Volume Replication.
RemoteVolumeResourceId string
The resource ID of the remote volume. Required for cross region and cross zone replication
ReplicationSchedule string
Schedule
ReplicationId This property is required. string
Id
EndpointType string
Indicates whether the local volume is the source or destination for the Volume Replication
RemotePath RemotePathResponse
The full path to a volume that is to be migrated into ANF. Required for Migration volumes
RemoteVolumeRegion string
The remote region for the other end of the Volume Replication.
RemoteVolumeResourceId string
The resource ID of the remote volume. Required for cross region and cross zone replication
ReplicationSchedule string
Schedule
replicationId This property is required. String
Id
endpointType String
Indicates whether the local volume is the source or destination for the Volume Replication
remotePath RemotePathResponse
The full path to a volume that is to be migrated into ANF. Required for Migration volumes
remoteVolumeRegion String
The remote region for the other end of the Volume Replication.
remoteVolumeResourceId String
The resource ID of the remote volume. Required for cross region and cross zone replication
replicationSchedule String
Schedule
replicationId This property is required. string
Id
endpointType string
Indicates whether the local volume is the source or destination for the Volume Replication
remotePath RemotePathResponse
The full path to a volume that is to be migrated into ANF. Required for Migration volumes
remoteVolumeRegion string
The remote region for the other end of the Volume Replication.
remoteVolumeResourceId string
The resource ID of the remote volume. Required for cross region and cross zone replication
replicationSchedule string
Schedule
replication_id This property is required. str
Id
endpoint_type str
Indicates whether the local volume is the source or destination for the Volume Replication
remote_path RemotePathResponse
The full path to a volume that is to be migrated into ANF. Required for Migration volumes
remote_volume_region str
The remote region for the other end of the Volume Replication.
remote_volume_resource_id str
The resource ID of the remote volume. Required for cross region and cross zone replication
replication_schedule str
Schedule
replicationId This property is required. String
Id
endpointType String
Indicates whether the local volume is the source or destination for the Volume Replication
remotePath Property Map
The full path to a volume that is to be migrated into ANF. Required for Migration volumes
remoteVolumeRegion String
The remote region for the other end of the Volume Replication.
remoteVolumeResourceId String
The resource ID of the remote volume. Required for cross region and cross zone replication
replicationSchedule String
Schedule

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

VolumeBackupPropertiesResponse

BackupPolicyId string
Backup Policy Resource ID
BackupVaultId string
Backup Vault Resource ID
PolicyEnforced bool
Policy Enforced
BackupPolicyId string
Backup Policy Resource ID
BackupVaultId string
Backup Vault Resource ID
PolicyEnforced bool
Policy Enforced
backupPolicyId String
Backup Policy Resource ID
backupVaultId String
Backup Vault Resource ID
policyEnforced Boolean
Policy Enforced
backupPolicyId string
Backup Policy Resource ID
backupVaultId string
Backup Vault Resource ID
policyEnforced boolean
Policy Enforced
backup_policy_id str
Backup Policy Resource ID
backup_vault_id str
Backup Vault Resource ID
policy_enforced bool
Policy Enforced
backupPolicyId String
Backup Policy Resource ID
backupVaultId String
Backup Vault Resource ID
policyEnforced Boolean
Policy Enforced

VolumePropertiesResponseDataProtection

backup Property Map
Backup Properties
replication Property Map
Replication properties
snapshot Property Map
Snapshot properties.
volumeRelocation Property Map
VolumeRelocation properties

VolumePropertiesResponseExportPolicy

rules List<Property Map>
Export policy rule

VolumeRelocationPropertiesResponse

ReadyToBeFinalized This property is required. bool
Has relocation finished and is ready to be cleaned up
RelocationRequested bool
Has relocation been requested for this volume
ReadyToBeFinalized This property is required. bool
Has relocation finished and is ready to be cleaned up
RelocationRequested bool
Has relocation been requested for this volume
readyToBeFinalized This property is required. Boolean
Has relocation finished and is ready to be cleaned up
relocationRequested Boolean
Has relocation been requested for this volume
readyToBeFinalized This property is required. boolean
Has relocation finished and is ready to be cleaned up
relocationRequested boolean
Has relocation been requested for this volume
ready_to_be_finalized This property is required. bool
Has relocation finished and is ready to be cleaned up
relocation_requested bool
Has relocation been requested for this volume
readyToBeFinalized This property is required. Boolean
Has relocation finished and is ready to be cleaned up
relocationRequested Boolean
Has relocation been requested for this volume

VolumeSnapshotPropertiesResponse

SnapshotPolicyId string
Snapshot Policy ResourceId
SnapshotPolicyId string
Snapshot Policy ResourceId
snapshotPolicyId String
Snapshot Policy ResourceId
snapshotPolicyId string
Snapshot Policy ResourceId
snapshot_policy_id str
Snapshot Policy ResourceId
snapshotPolicyId String
Snapshot Policy ResourceId

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native