Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. netapp
  5. Volume

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.netapp.Volume

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a NetApp Volume.

    !>IMPORTANT: This resource uses a feature to prevent deletion called prevent_volume_destruction, defaulting to true. It is intentionally set to true to prevent the possibility of accidental data loss. The example in this page shows all possible protection options you can apply, it is using same values as the defaults.

    Create Volume Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
    @overload
def Volume(resource_name: str,
           args: VolumeArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           pool_name: Optional[str] = None,
           volume_path: Optional[str] = None,
           subnet_id: Optional[str] = None,
           storage_quota_in_gb: Optional[int] = None,
           service_level: Optional[str] = None,
           resource_group_name: Optional[str] = None,
           account_name: Optional[str] = None,
           protocols: Optional[Sequence[str]] = None,
           smb3_protocol_encryption_enabled: Optional[bool] = None,
           key_vault_private_endpoint_id: Optional[str] = None,
           location: Optional[str] = None,
           name: Optional[str] = None,
           network_features: Optional[str] = None,
           export_policy_rules: Optional[Sequence[VolumeExportPolicyRuleArgs]] = None,
           encryption_key_source: Optional[str] = None,
           data_protection_snapshot_policy: Optional[VolumeDataProtectionSnapshotPolicyArgs] = None,
           security_style: Optional[str] = None,
           data_protection_replication: Optional[VolumeDataProtectionReplicationArgs] = None,
           kerberos_enabled: Optional[bool] = None,
           smb_access_based_enumeration_enabled: Optional[bool] = None,
           smb_continuous_availability_enabled: Optional[bool] = None,
           smb_non_browsable_enabled: Optional[bool] = None,
           snapshot_directory_visible: Optional[bool] = None,
           data_protection_backup_policy: Optional[VolumeDataProtectionBackupPolicyArgs] = None,
           create_from_snapshot_resource_id: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           throughput_in_mibps: Optional[float] = None,
           azure_vmware_data_store_enabled: Optional[bool] = None,
           zone: Optional[str] = None)
    func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
    public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
    public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)

    type: azure:netapp:Volume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azureVolumeResource = new Azure.NetApp.Volume("azureVolumeResource", new()
{
    PoolName = "string",
    VolumePath = "string",
    SubnetId = "string",
    StorageQuotaInGb = 0,
    ServiceLevel = "string",
    ResourceGroupName = "string",
    AccountName = "string",
    Protocols = new[]
    {
        "string",
    },
    Smb3ProtocolEncryptionEnabled = false,
    KeyVaultPrivateEndpointId = "string",
    Location = "string",
    Name = "string",
    NetworkFeatures = "string",
    ExportPolicyRules = new[]
    {
        new Azure.NetApp.Inputs.VolumeExportPolicyRuleArgs
        {
            AllowedClients = new[]
            {
                "string",
            },
            RuleIndex = 0,
            Kerberos5ReadOnlyEnabled = false,
            Kerberos5ReadWriteEnabled = false,
            Kerberos5iReadOnlyEnabled = false,
            Kerberos5iReadWriteEnabled = false,
            Kerberos5pReadOnlyEnabled = false,
            Kerberos5pReadWriteEnabled = false,
            ProtocolsEnabled = "string",
            RootAccessEnabled = false,
            UnixReadOnly = false,
            UnixReadWrite = false,
        },
    },
    EncryptionKeySource = "string",
    DataProtectionSnapshotPolicy = new Azure.NetApp.Inputs.VolumeDataProtectionSnapshotPolicyArgs
    {
        SnapshotPolicyId = "string",
    },
    SecurityStyle = "string",
    DataProtectionReplication = new Azure.NetApp.Inputs.VolumeDataProtectionReplicationArgs
    {
        RemoteVolumeLocation = "string",
        RemoteVolumeResourceId = "string",
        ReplicationFrequency = "string",
        EndpointType = "string",
    },
    KerberosEnabled = false,
    SmbAccessBasedEnumerationEnabled = false,
    SmbContinuousAvailabilityEnabled = false,
    SmbNonBrowsableEnabled = false,
    SnapshotDirectoryVisible = false,
    DataProtectionBackupPolicy = new Azure.NetApp.Inputs.VolumeDataProtectionBackupPolicyArgs
    {
        BackupPolicyId = "string",
        BackupVaultId = "string",
        PolicyEnabled = false,
    },
    CreateFromSnapshotResourceId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    ThroughputInMibps = 0,
    AzureVmwareDataStoreEnabled = false,
    Zone = "string",
});

    example, err := netapp.NewVolume(ctx, "azureVolumeResource", &netapp.VolumeArgs{
	PoolName:          pulumi.String("string"),
	VolumePath:        pulumi.String("string"),
	SubnetId:          pulumi.String("string"),
	StorageQuotaInGb:  pulumi.Int(0),
	ServiceLevel:      pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	AccountName:       pulumi.String("string"),
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	Smb3ProtocolEncryptionEnabled: pulumi.Bool(false),
	KeyVaultPrivateEndpointId:     pulumi.String("string"),
	Location:                      pulumi.String("string"),
	Name:                          pulumi.String("string"),
	NetworkFeatures:               pulumi.String("string"),
	ExportPolicyRules: netapp.VolumeExportPolicyRuleArray{
		&netapp.VolumeExportPolicyRuleArgs{
			AllowedClients: pulumi.StringArray{
				pulumi.String("string"),
			},
			RuleIndex:                  pulumi.Int(0),
			Kerberos5ReadOnlyEnabled:   pulumi.Bool(false),
			Kerberos5ReadWriteEnabled:  pulumi.Bool(false),
			Kerberos5iReadOnlyEnabled:  pulumi.Bool(false),
			Kerberos5iReadWriteEnabled: pulumi.Bool(false),
			Kerberos5pReadOnlyEnabled:  pulumi.Bool(false),
			Kerberos5pReadWriteEnabled: pulumi.Bool(false),
			ProtocolsEnabled:           pulumi.String("string"),
			RootAccessEnabled:          pulumi.Bool(false),
			UnixReadOnly:               pulumi.Bool(false),
			UnixReadWrite:              pulumi.Bool(false),
		},
	},
	EncryptionKeySource: pulumi.String("string"),
	DataProtectionSnapshotPolicy: &netapp.VolumeDataProtectionSnapshotPolicyArgs{
		SnapshotPolicyId: pulumi.String("string"),
	},
	SecurityStyle: pulumi.String("string"),
	DataProtectionReplication: &netapp.VolumeDataProtectionReplicationArgs{
		RemoteVolumeLocation:   pulumi.String("string"),
		RemoteVolumeResourceId: pulumi.String("string"),
		ReplicationFrequency:   pulumi.String("string"),
		EndpointType:           pulumi.String("string"),
	},
	KerberosEnabled:                  pulumi.Bool(false),
	SmbAccessBasedEnumerationEnabled: pulumi.Bool(false),
	SmbContinuousAvailabilityEnabled: pulumi.Bool(false),
	SmbNonBrowsableEnabled:           pulumi.Bool(false),
	SnapshotDirectoryVisible:         pulumi.Bool(false),
	DataProtectionBackupPolicy: &netapp.VolumeDataProtectionBackupPolicyArgs{
		BackupPolicyId: pulumi.String("string"),
		BackupVaultId:  pulumi.String("string"),
		PolicyEnabled:  pulumi.Bool(false),
	},
	CreateFromSnapshotResourceId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ThroughputInMibps:           pulumi.Float64(0),
	AzureVmwareDataStoreEnabled: pulumi.Bool(false),
	Zone:                        pulumi.String("string"),
})

    var azureVolumeResource = new Volume("azureVolumeResource", VolumeArgs.builder()
    .poolName("string")
    .volumePath("string")
    .subnetId("string")
    .storageQuotaInGb(0)
    .serviceLevel("string")
    .resourceGroupName("string")
    .accountName("string")
    .protocols("string")
    .smb3ProtocolEncryptionEnabled(false)
    .keyVaultPrivateEndpointId("string")
    .location("string")
    .name("string")
    .networkFeatures("string")
    .exportPolicyRules(VolumeExportPolicyRuleArgs.builder()
        .allowedClients("string")
        .ruleIndex(0)
        .kerberos5ReadOnlyEnabled(false)
        .kerberos5ReadWriteEnabled(false)
        .kerberos5iReadOnlyEnabled(false)
        .kerberos5iReadWriteEnabled(false)
        .kerberos5pReadOnlyEnabled(false)
        .kerberos5pReadWriteEnabled(false)
        .protocolsEnabled("string")
        .rootAccessEnabled(false)
        .unixReadOnly(false)
        .unixReadWrite(false)
        .build())
    .encryptionKeySource("string")
    .dataProtectionSnapshotPolicy(VolumeDataProtectionSnapshotPolicyArgs.builder()
        .snapshotPolicyId("string")
        .build())
    .securityStyle("string")
    .dataProtectionReplication(VolumeDataProtectionReplicationArgs.builder()
        .remoteVolumeLocation("string")
        .remoteVolumeResourceId("string")
        .replicationFrequency("string")
        .endpointType("string")
        .build())
    .kerberosEnabled(false)
    .smbAccessBasedEnumerationEnabled(false)
    .smbContinuousAvailabilityEnabled(false)
    .smbNonBrowsableEnabled(false)
    .snapshotDirectoryVisible(false)
    .dataProtectionBackupPolicy(VolumeDataProtectionBackupPolicyArgs.builder()
        .backupPolicyId("string")
        .backupVaultId("string")
        .policyEnabled(false)
        .build())
    .createFromSnapshotResourceId("string")
    .tags(Map.of("string", "string"))
    .throughputInMibps(0)
    .azureVmwareDataStoreEnabled(false)
    .zone("string")
    .build());

    azure_volume_resource = azure.netapp.Volume("azureVolumeResource",
    pool_name="string",
    volume_path="string",
    subnet_id="string",
    storage_quota_in_gb=0,
    service_level="string",
    resource_group_name="string",
    account_name="string",
    protocols=["string"],
    smb3_protocol_encryption_enabled=False,
    key_vault_private_endpoint_id="string",
    location="string",
    name="string",
    network_features="string",
    export_policy_rules=[{
        "allowed_clients": ["string"],
        "rule_index": 0,
        "kerberos5_read_only_enabled": False,
        "kerberos5_read_write_enabled": False,
        "kerberos5i_read_only_enabled": False,
        "kerberos5i_read_write_enabled": False,
        "kerberos5p_read_only_enabled": False,
        "kerberos5p_read_write_enabled": False,
        "protocols_enabled": "string",
        "root_access_enabled": False,
        "unix_read_only": False,
        "unix_read_write": False,
    }],
    encryption_key_source="string",
    data_protection_snapshot_policy={
        "snapshot_policy_id": "string",
    },
    security_style="string",
    data_protection_replication={
        "remote_volume_location": "string",
        "remote_volume_resource_id": "string",
        "replication_frequency": "string",
        "endpoint_type": "string",
    },
    kerberos_enabled=False,
    smb_access_based_enumeration_enabled=False,
    smb_continuous_availability_enabled=False,
    smb_non_browsable_enabled=False,
    snapshot_directory_visible=False,
    data_protection_backup_policy={
        "backup_policy_id": "string",
        "backup_vault_id": "string",
        "policy_enabled": False,
    },
    create_from_snapshot_resource_id="string",
    tags={
        "string": "string",
    },
    throughput_in_mibps=0,
    azure_vmware_data_store_enabled=False,
    zone="string")

    const azureVolumeResource = new azure.netapp.Volume("azureVolumeResource", {
    poolName: "string",
    volumePath: "string",
    subnetId: "string",
    storageQuotaInGb: 0,
    serviceLevel: "string",
    resourceGroupName: "string",
    accountName: "string",
    protocols: ["string"],
    smb3ProtocolEncryptionEnabled: false,
    keyVaultPrivateEndpointId: "string",
    location: "string",
    name: "string",
    networkFeatures: "string",
    exportPolicyRules: [{
        allowedClients: ["string"],
        ruleIndex: 0,
        kerberos5ReadOnlyEnabled: false,
        kerberos5ReadWriteEnabled: false,
        kerberos5iReadOnlyEnabled: false,
        kerberos5iReadWriteEnabled: false,
        kerberos5pReadOnlyEnabled: false,
        kerberos5pReadWriteEnabled: false,
        protocolsEnabled: "string",
        rootAccessEnabled: false,
        unixReadOnly: false,
        unixReadWrite: false,
    }],
    encryptionKeySource: "string",
    dataProtectionSnapshotPolicy: {
        snapshotPolicyId: "string",
    },
    securityStyle: "string",
    dataProtectionReplication: {
        remoteVolumeLocation: "string",
        remoteVolumeResourceId: "string",
        replicationFrequency: "string",
        endpointType: "string",
    },
    kerberosEnabled: false,
    smbAccessBasedEnumerationEnabled: false,
    smbContinuousAvailabilityEnabled: false,
    smbNonBrowsableEnabled: false,
    snapshotDirectoryVisible: false,
    dataProtectionBackupPolicy: {
        backupPolicyId: "string",
        backupVaultId: "string",
        policyEnabled: false,
    },
    createFromSnapshotResourceId: "string",
    tags: {
        string: "string",
    },
    throughputInMibps: 0,
    azureVmwareDataStoreEnabled: false,
    zone: "string",
});

    type: azure:netapp:Volume
properties:
    accountName: string
    azureVmwareDataStoreEnabled: false
    createFromSnapshotResourceId: string
    dataProtectionBackupPolicy:
        backupPolicyId: string
        backupVaultId: string
        policyEnabled: false
    dataProtectionReplication:
        endpointType: string
        remoteVolumeLocation: string
        remoteVolumeResourceId: string
        replicationFrequency: string
    dataProtectionSnapshotPolicy:
        snapshotPolicyId: string
    encryptionKeySource: string
    exportPolicyRules:
        - allowedClients:
            - string
          kerberos5ReadOnlyEnabled: false
          kerberos5ReadWriteEnabled: false
          kerberos5iReadOnlyEnabled: false
          kerberos5iReadWriteEnabled: false
          kerberos5pReadOnlyEnabled: false
          kerberos5pReadWriteEnabled: false
          protocolsEnabled: string
          rootAccessEnabled: false
          ruleIndex: 0
          unixReadOnly: false
          unixReadWrite: false
    kerberosEnabled: false
    keyVaultPrivateEndpointId: string
    location: string
    name: string
    networkFeatures: string
    poolName: string
    protocols:
        - string
    resourceGroupName: string
    securityStyle: string
    serviceLevel: string
    smb3ProtocolEncryptionEnabled: false
    smbAccessBasedEnumerationEnabled: false
    smbContinuousAvailabilityEnabled: false
    smbNonBrowsableEnabled: false
    snapshotDirectoryVisible: false
    storageQuotaInGb: 0
    subnetId: string
    tags:
        string: string
    throughputInMibps: 0
    volumePath: string
    zone: string

    Volume Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Volume resource accepts the following input properties:

    AccountName string
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    PoolName string
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    ServiceLevel string
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    StorageQuotaInGb int
    The maximum Storage Quota allowed for a file system in Gigabytes.
    SubnetId string
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    VolumePath string
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    AzureVmwareDataStoreEnabled bool
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    CreateFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    DataProtectionBackupPolicy VolumeDataProtectionBackupPolicy
    A data_protection_backup_policy block as defined below.
    DataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    DataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    EncryptionKeySource string
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    ExportPolicyRules List<VolumeExportPolicyRule>
    One or more export_policy_rule block defined below.
    KerberosEnabled bool
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    KeyVaultPrivateEndpointId string
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    NetworkFeatures string
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    Protocols List<string>
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    SecurityStyle string
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    Smb3ProtocolEncryptionEnabled bool
    Enable SMB encryption.
    SmbAccessBasedEnumerationEnabled bool
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    SmbContinuousAvailabilityEnabled bool
    Enable SMB Continuous Availability.
    SmbNonBrowsableEnabled bool
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    SnapshotDirectoryVisible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    Tags Dictionary<string, string>

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    ThroughputInMibps double
    Throughput of this volume in Mibps.
    Zone string
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.
    AccountName string
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    PoolName string
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    ServiceLevel string
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    StorageQuotaInGb int
    The maximum Storage Quota allowed for a file system in Gigabytes.
    SubnetId string
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    VolumePath string
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    AzureVmwareDataStoreEnabled bool
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    CreateFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    DataProtectionBackupPolicy VolumeDataProtectionBackupPolicyArgs
    A data_protection_backup_policy block as defined below.
    DataProtectionReplication VolumeDataProtectionReplicationArgs
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    DataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicyArgs
    A data_protection_snapshot_policy block as defined below.
    EncryptionKeySource string
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    ExportPolicyRules []VolumeExportPolicyRuleArgs
    One or more export_policy_rule block defined below.
    KerberosEnabled bool
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    KeyVaultPrivateEndpointId string
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    NetworkFeatures string
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    Protocols []string
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    SecurityStyle string
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    Smb3ProtocolEncryptionEnabled bool
    Enable SMB encryption.
    SmbAccessBasedEnumerationEnabled bool
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    SmbContinuousAvailabilityEnabled bool
    Enable SMB Continuous Availability.
    SmbNonBrowsableEnabled bool
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    SnapshotDirectoryVisible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    Tags map[string]string

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    ThroughputInMibps float64
    Throughput of this volume in Mibps.
    Zone string
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.
    accountName String
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    poolName String
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    serviceLevel String
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    storageQuotaInGb Integer
    The maximum Storage Quota allowed for a file system in Gigabytes.
    subnetId String
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    volumePath String
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    azureVmwareDataStoreEnabled Boolean
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    createFromSnapshotResourceId String
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    dataProtectionBackupPolicy VolumeDataProtectionBackupPolicy
    A data_protection_backup_policy block as defined below.
    dataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    dataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    encryptionKeySource String
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    exportPolicyRules List<VolumeExportPolicyRule>
    One or more export_policy_rule block defined below.
    kerberosEnabled Boolean
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    keyVaultPrivateEndpointId String
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    networkFeatures String
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    protocols List<String>
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    securityStyle String
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    smb3ProtocolEncryptionEnabled Boolean
    Enable SMB encryption.
    smbAccessBasedEnumerationEnabled Boolean
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    smbContinuousAvailabilityEnabled Boolean
    Enable SMB Continuous Availability.
    smbNonBrowsableEnabled Boolean
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    snapshotDirectoryVisible Boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    tags Map<String,String>

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    throughputInMibps Double
    Throughput of this volume in Mibps.
    zone String
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.
    accountName string
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    poolName string
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    serviceLevel string
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    storageQuotaInGb number
    The maximum Storage Quota allowed for a file system in Gigabytes.
    subnetId string
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    volumePath string
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    azureVmwareDataStoreEnabled boolean
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    createFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    dataProtectionBackupPolicy VolumeDataProtectionBackupPolicy
    A data_protection_backup_policy block as defined below.
    dataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    dataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    encryptionKeySource string
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    exportPolicyRules VolumeExportPolicyRule[]
    One or more export_policy_rule block defined below.
    kerberosEnabled boolean
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    keyVaultPrivateEndpointId string
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    networkFeatures string
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    protocols string[]
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    securityStyle string
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    smb3ProtocolEncryptionEnabled boolean
    Enable SMB encryption.
    smbAccessBasedEnumerationEnabled boolean
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    smbContinuousAvailabilityEnabled boolean
    Enable SMB Continuous Availability.
    smbNonBrowsableEnabled boolean
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    snapshotDirectoryVisible boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    tags {[key: string]: string}

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    throughputInMibps number
    Throughput of this volume in Mibps.
    zone string
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.
    account_name str
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    pool_name str
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    service_level str
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    storage_quota_in_gb int
    The maximum Storage Quota allowed for a file system in Gigabytes.
    subnet_id str
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    volume_path str
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    azure_vmware_data_store_enabled bool
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    create_from_snapshot_resource_id str
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    data_protection_backup_policy VolumeDataProtectionBackupPolicyArgs
    A data_protection_backup_policy block as defined below.
    data_protection_replication VolumeDataProtectionReplicationArgs
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    data_protection_snapshot_policy VolumeDataProtectionSnapshotPolicyArgs
    A data_protection_snapshot_policy block as defined below.
    encryption_key_source str
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    export_policy_rules Sequence[VolumeExportPolicyRuleArgs]
    One or more export_policy_rule block defined below.
    kerberos_enabled bool
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    key_vault_private_endpoint_id str
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    network_features str
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    protocols Sequence[str]
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    security_style str
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    smb3_protocol_encryption_enabled bool
    Enable SMB encryption.
    smb_access_based_enumeration_enabled bool
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    smb_continuous_availability_enabled bool
    Enable SMB Continuous Availability.
    smb_non_browsable_enabled bool
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    snapshot_directory_visible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    tags Mapping[str, str]

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    throughput_in_mibps float
    Throughput of this volume in Mibps.
    zone str
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.
    accountName String
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    poolName String
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    serviceLevel String
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    storageQuotaInGb Number
    The maximum Storage Quota allowed for a file system in Gigabytes.
    subnetId String
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    volumePath String
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    azureVmwareDataStoreEnabled Boolean
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    createFromSnapshotResourceId String
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    dataProtectionBackupPolicy Property Map
    A data_protection_backup_policy block as defined below.
    dataProtectionReplication Property Map
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    dataProtectionSnapshotPolicy Property Map
    A data_protection_snapshot_policy block as defined below.
    encryptionKeySource String
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    exportPolicyRules List<Property Map>
    One or more export_policy_rule block defined below.
    kerberosEnabled Boolean
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    keyVaultPrivateEndpointId String
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    networkFeatures String
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    protocols List<String>
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    securityStyle String
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    smb3ProtocolEncryptionEnabled Boolean
    Enable SMB encryption.
    smbAccessBasedEnumerationEnabled Boolean
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    smbContinuousAvailabilityEnabled Boolean
    Enable SMB Continuous Availability.
    smbNonBrowsableEnabled Boolean
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    snapshotDirectoryVisible Boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    tags Map<String>

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    throughputInMibps Number
    Throughput of this volume in Mibps.
    zone String
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    MountIpAddresses List<string>
    A list of IPv4 Addresses which should be used to mount the volume.
    Id string
    The provider-assigned unique ID for this managed resource.
    MountIpAddresses []string
    A list of IPv4 Addresses which should be used to mount the volume.
    id String
    The provider-assigned unique ID for this managed resource.
    mountIpAddresses List<String>
    A list of IPv4 Addresses which should be used to mount the volume.
    id string
    The provider-assigned unique ID for this managed resource.
    mountIpAddresses string[]
    A list of IPv4 Addresses which should be used to mount the volume.
    id str
    The provider-assigned unique ID for this managed resource.
    mount_ip_addresses Sequence[str]
    A list of IPv4 Addresses which should be used to mount the volume.
    id String
    The provider-assigned unique ID for this managed resource.
    mountIpAddresses List<String>
    A list of IPv4 Addresses which should be used to mount the volume.

    Look up Existing Volume Resource

    Get an existing Volume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VolumeState, opts?: CustomResourceOptions): Volume
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        azure_vmware_data_store_enabled: Optional[bool] = None,
        create_from_snapshot_resource_id: Optional[str] = None,
        data_protection_backup_policy: Optional[VolumeDataProtectionBackupPolicyArgs] = None,
        data_protection_replication: Optional[VolumeDataProtectionReplicationArgs] = None,
        data_protection_snapshot_policy: Optional[VolumeDataProtectionSnapshotPolicyArgs] = None,
        encryption_key_source: Optional[str] = None,
        export_policy_rules: Optional[Sequence[VolumeExportPolicyRuleArgs]] = None,
        kerberos_enabled: Optional[bool] = None,
        key_vault_private_endpoint_id: Optional[str] = None,
        location: Optional[str] = None,
        mount_ip_addresses: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        network_features: Optional[str] = None,
        pool_name: Optional[str] = None,
        protocols: Optional[Sequence[str]] = None,
        resource_group_name: Optional[str] = None,
        security_style: Optional[str] = None,
        service_level: Optional[str] = None,
        smb3_protocol_encryption_enabled: Optional[bool] = None,
        smb_access_based_enumeration_enabled: Optional[bool] = None,
        smb_continuous_availability_enabled: Optional[bool] = None,
        smb_non_browsable_enabled: Optional[bool] = None,
        snapshot_directory_visible: Optional[bool] = None,
        storage_quota_in_gb: Optional[int] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        throughput_in_mibps: Optional[float] = None,
        volume_path: Optional[str] = None,
        zone: Optional[str] = None) -> Volume
    func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)
    public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)
    public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountName string
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    AzureVmwareDataStoreEnabled bool
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    CreateFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    DataProtectionBackupPolicy VolumeDataProtectionBackupPolicy
    A data_protection_backup_policy block as defined below.
    DataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    DataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    EncryptionKeySource string
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    ExportPolicyRules List<VolumeExportPolicyRule>
    One or more export_policy_rule block defined below.
    KerberosEnabled bool
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    KeyVaultPrivateEndpointId string
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MountIpAddresses List<string>
    A list of IPv4 Addresses which should be used to mount the volume.
    Name string
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    NetworkFeatures string
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    PoolName string
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    Protocols List<string>
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    ResourceGroupName string
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    SecurityStyle string
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    ServiceLevel string
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    Smb3ProtocolEncryptionEnabled bool
    Enable SMB encryption.
    SmbAccessBasedEnumerationEnabled bool
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    SmbContinuousAvailabilityEnabled bool
    Enable SMB Continuous Availability.
    SmbNonBrowsableEnabled bool
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    SnapshotDirectoryVisible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    StorageQuotaInGb int
    The maximum Storage Quota allowed for a file system in Gigabytes.
    SubnetId string
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    ThroughputInMibps double
    Throughput of this volume in Mibps.
    VolumePath string
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    Zone string
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.
    AccountName string
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    AzureVmwareDataStoreEnabled bool
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    CreateFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    DataProtectionBackupPolicy VolumeDataProtectionBackupPolicyArgs
    A data_protection_backup_policy block as defined below.
    DataProtectionReplication VolumeDataProtectionReplicationArgs
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    DataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicyArgs
    A data_protection_snapshot_policy block as defined below.
    EncryptionKeySource string
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    ExportPolicyRules []VolumeExportPolicyRuleArgs
    One or more export_policy_rule block defined below.
    KerberosEnabled bool
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    KeyVaultPrivateEndpointId string
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MountIpAddresses []string
    A list of IPv4 Addresses which should be used to mount the volume.
    Name string
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    NetworkFeatures string
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    PoolName string
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    Protocols []string
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    ResourceGroupName string
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    SecurityStyle string
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    ServiceLevel string
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    Smb3ProtocolEncryptionEnabled bool
    Enable SMB encryption.
    SmbAccessBasedEnumerationEnabled bool
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    SmbContinuousAvailabilityEnabled bool
    Enable SMB Continuous Availability.
    SmbNonBrowsableEnabled bool
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    SnapshotDirectoryVisible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    StorageQuotaInGb int
    The maximum Storage Quota allowed for a file system in Gigabytes.
    SubnetId string
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    Tags map[string]string

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    ThroughputInMibps float64
    Throughput of this volume in Mibps.
    VolumePath string
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    Zone string
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.
    accountName String
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    azureVmwareDataStoreEnabled Boolean
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    createFromSnapshotResourceId String
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    dataProtectionBackupPolicy VolumeDataProtectionBackupPolicy
    A data_protection_backup_policy block as defined below.
    dataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    dataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    encryptionKeySource String
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    exportPolicyRules List<VolumeExportPolicyRule>
    One or more export_policy_rule block defined below.
    kerberosEnabled Boolean
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    keyVaultPrivateEndpointId String
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mountIpAddresses List<String>
    A list of IPv4 Addresses which should be used to mount the volume.
    name String
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    networkFeatures String
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    poolName String
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    protocols List<String>
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    resourceGroupName String
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    securityStyle String
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    serviceLevel String
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    smb3ProtocolEncryptionEnabled Boolean
    Enable SMB encryption.
    smbAccessBasedEnumerationEnabled Boolean
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    smbContinuousAvailabilityEnabled Boolean
    Enable SMB Continuous Availability.
    smbNonBrowsableEnabled Boolean
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    snapshotDirectoryVisible Boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    storageQuotaInGb Integer
    The maximum Storage Quota allowed for a file system in Gigabytes.
    subnetId String
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    tags Map<String,String>

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    throughputInMibps Double
    Throughput of this volume in Mibps.
    volumePath String
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    zone String
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.
    accountName string
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    azureVmwareDataStoreEnabled boolean
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    createFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    dataProtectionBackupPolicy VolumeDataProtectionBackupPolicy
    A data_protection_backup_policy block as defined below.
    dataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    dataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    encryptionKeySource string
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    exportPolicyRules VolumeExportPolicyRule[]
    One or more export_policy_rule block defined below.
    kerberosEnabled boolean
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    keyVaultPrivateEndpointId string
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mountIpAddresses string[]
    A list of IPv4 Addresses which should be used to mount the volume.
    name string
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    networkFeatures string
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    poolName string
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    protocols string[]
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    resourceGroupName string
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    securityStyle string
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    serviceLevel string
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    smb3ProtocolEncryptionEnabled boolean
    Enable SMB encryption.
    smbAccessBasedEnumerationEnabled boolean
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    smbContinuousAvailabilityEnabled boolean
    Enable SMB Continuous Availability.
    smbNonBrowsableEnabled boolean
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    snapshotDirectoryVisible boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    storageQuotaInGb number
    The maximum Storage Quota allowed for a file system in Gigabytes.
    subnetId string
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    tags {[key: string]: string}

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    throughputInMibps number
    Throughput of this volume in Mibps.
    volumePath string
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    zone string
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.
    account_name str
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    azure_vmware_data_store_enabled bool
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    create_from_snapshot_resource_id str
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    data_protection_backup_policy VolumeDataProtectionBackupPolicyArgs
    A data_protection_backup_policy block as defined below.
    data_protection_replication VolumeDataProtectionReplicationArgs
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    data_protection_snapshot_policy VolumeDataProtectionSnapshotPolicyArgs
    A data_protection_snapshot_policy block as defined below.
    encryption_key_source str
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    export_policy_rules Sequence[VolumeExportPolicyRuleArgs]
    One or more export_policy_rule block defined below.
    kerberos_enabled bool
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    key_vault_private_endpoint_id str
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mount_ip_addresses Sequence[str]
    A list of IPv4 Addresses which should be used to mount the volume.
    name str
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    network_features str
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    pool_name str
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    protocols Sequence[str]
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    resource_group_name str
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    security_style str
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    service_level str
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    smb3_protocol_encryption_enabled bool
    Enable SMB encryption.
    smb_access_based_enumeration_enabled bool
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    smb_continuous_availability_enabled bool
    Enable SMB Continuous Availability.
    smb_non_browsable_enabled bool
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    snapshot_directory_visible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    storage_quota_in_gb int
    The maximum Storage Quota allowed for a file system in Gigabytes.
    subnet_id str
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    tags Mapping[str, str]

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    throughput_in_mibps float
    Throughput of this volume in Mibps.
    volume_path str
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    zone str
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.
    accountName String
    The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
    azureVmwareDataStoreEnabled Boolean
    Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
    createFromSnapshotResourceId String
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.
    dataProtectionBackupPolicy Property Map
    A data_protection_backup_policy block as defined below.
    dataProtectionReplication Property Map
    A data_protection_replication block as defined below. Changing this forces a new resource to be created.
    dataProtectionSnapshotPolicy Property Map
    A data_protection_snapshot_policy block as defined below.
    encryptionKeySource String
    The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.
    exportPolicyRules List<Property Map>
    One or more export_policy_rule block defined below.
    kerberosEnabled Boolean
    Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.
    keyVaultPrivateEndpointId String
    The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mountIpAddresses List<String>
    A list of IPv4 Addresses which should be used to mount the volume.
    name String
    The name of the NetApp Volume. Changing this forces a new resource to be created.
    networkFeatures String
    Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.
    poolName String
    The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
    protocols List<String>
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    resourceGroupName String
    The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
    securityStyle String
    Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.
    serviceLevel String
    The target performance of the file system. Valid values include Premium, Standard, or Ultra. Changing this forces a new resource to be created.
    smb3ProtocolEncryptionEnabled Boolean
    Enable SMB encryption.
    smbAccessBasedEnumerationEnabled Boolean
    Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    smbContinuousAvailabilityEnabled Boolean
    Enable SMB Continuous Availability.
    smbNonBrowsableEnabled Boolean
    Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files
    snapshotDirectoryVisible Boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    storageQuotaInGb Number
    The maximum Storage Quota allowed for a file system in Gigabytes.
    subnetId String
    The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
    tags Map<String>

    A mapping of tags to assign to the resource.

    Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the protocols argument changes to a different protocol type.

    throughputInMibps Number
    Throughput of this volume in Mibps.
    volumePath String
    A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
    zone String
    Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.

    Supporting Types

    VolumeDataProtectionBackupPolicy, VolumeDataProtectionBackupPolicyArgs

    BackupPolicyId string
    Resource ID of the backup policy to apply to the volume.
    BackupVaultId string
    Resource ID of the backup backup vault to associate this volume to.
    PolicyEnabled bool

    Enables the backup policy on the volume, defaults to true.

    For more information on Azure NetApp Files Backup feature please see Understand Azure NetApp Files backup

    BackupPolicyId string
    Resource ID of the backup policy to apply to the volume.
    BackupVaultId string
    Resource ID of the backup backup vault to associate this volume to.
    PolicyEnabled bool

    Enables the backup policy on the volume, defaults to true.

    For more information on Azure NetApp Files Backup feature please see Understand Azure NetApp Files backup

    backupPolicyId String
    Resource ID of the backup policy to apply to the volume.
    backupVaultId String
    Resource ID of the backup backup vault to associate this volume to.
    policyEnabled Boolean

    Enables the backup policy on the volume, defaults to true.

    For more information on Azure NetApp Files Backup feature please see Understand Azure NetApp Files backup

    backupPolicyId string
    Resource ID of the backup policy to apply to the volume.
    backupVaultId string
    Resource ID of the backup backup vault to associate this volume to.
    policyEnabled boolean

    Enables the backup policy on the volume, defaults to true.

    For more information on Azure NetApp Files Backup feature please see Understand Azure NetApp Files backup

    backup_policy_id str
    Resource ID of the backup policy to apply to the volume.
    backup_vault_id str
    Resource ID of the backup backup vault to associate this volume to.
    policy_enabled bool

    Enables the backup policy on the volume, defaults to true.

    For more information on Azure NetApp Files Backup feature please see Understand Azure NetApp Files backup

    backupPolicyId String
    Resource ID of the backup policy to apply to the volume.
    backupVaultId String
    Resource ID of the backup backup vault to associate this volume to.
    policyEnabled Boolean

    Enables the backup policy on the volume, defaults to true.

    For more information on Azure NetApp Files Backup feature please see Understand Azure NetApp Files backup

    VolumeDataProtectionReplication, VolumeDataProtectionReplicationArgs

    RemoteVolumeLocation string
    Location of the primary volume. Changing this forces a new resource to be created.
    RemoteVolumeResourceId string
    Resource ID of the primary volume.
    ReplicationFrequency string

    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.

    A full example of the data_protection_replication attribute can be found in the ./examples/netapp/volume_crr directory within the GitHub Repository

    NOTE: data_protection_replication can be defined only once per secondary volume, adding a second instance of it is not supported.

    EndpointType string
    The endpoint type, default value is dst for destination.
    RemoteVolumeLocation string
    Location of the primary volume. Changing this forces a new resource to be created.
    RemoteVolumeResourceId string
    Resource ID of the primary volume.
    ReplicationFrequency string

    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.

    A full example of the data_protection_replication attribute can be found in the ./examples/netapp/volume_crr directory within the GitHub Repository

    NOTE: data_protection_replication can be defined only once per secondary volume, adding a second instance of it is not supported.

    EndpointType string
    The endpoint type, default value is dst for destination.
    remoteVolumeLocation String
    Location of the primary volume. Changing this forces a new resource to be created.
    remoteVolumeResourceId String
    Resource ID of the primary volume.
    replicationFrequency String

    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.

    A full example of the data_protection_replication attribute can be found in the ./examples/netapp/volume_crr directory within the GitHub Repository

    NOTE: data_protection_replication can be defined only once per secondary volume, adding a second instance of it is not supported.

    endpointType String
    The endpoint type, default value is dst for destination.
    remoteVolumeLocation string
    Location of the primary volume. Changing this forces a new resource to be created.
    remoteVolumeResourceId string
    Resource ID of the primary volume.
    replicationFrequency string

    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.

    A full example of the data_protection_replication attribute can be found in the ./examples/netapp/volume_crr directory within the GitHub Repository

    NOTE: data_protection_replication can be defined only once per secondary volume, adding a second instance of it is not supported.

    endpointType string
    The endpoint type, default value is dst for destination.
    remote_volume_location str
    Location of the primary volume. Changing this forces a new resource to be created.
    remote_volume_resource_id str
    Resource ID of the primary volume.
    replication_frequency str

    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.

    A full example of the data_protection_replication attribute can be found in the ./examples/netapp/volume_crr directory within the GitHub Repository

    NOTE: data_protection_replication can be defined only once per secondary volume, adding a second instance of it is not supported.

    endpoint_type str
    The endpoint type, default value is dst for destination.
    remoteVolumeLocation String
    Location of the primary volume. Changing this forces a new resource to be created.
    remoteVolumeResourceId String
    Resource ID of the primary volume.
    replicationFrequency String

    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.

    A full example of the data_protection_replication attribute can be found in the ./examples/netapp/volume_crr directory within the GitHub Repository

    NOTE: data_protection_replication can be defined only once per secondary volume, adding a second instance of it is not supported.

    endpointType String
    The endpoint type, default value is dst for destination.

    VolumeDataProtectionSnapshotPolicy, VolumeDataProtectionSnapshotPolicyArgs

    SnapshotPolicyId string

    Resource ID of the snapshot policy to apply to the volume.

    A full example of the data_protection_snapshot_policy attribute usage can be found in the ./examples/netapp/nfsv3_volume_with_snapshot_policy directory within the GitHub Repository

    NOTE: data_protection_snapshot_policy block can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.

    SnapshotPolicyId string

    Resource ID of the snapshot policy to apply to the volume.

    A full example of the data_protection_snapshot_policy attribute usage can be found in the ./examples/netapp/nfsv3_volume_with_snapshot_policy directory within the GitHub Repository

    NOTE: data_protection_snapshot_policy block can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.

    snapshotPolicyId String

    Resource ID of the snapshot policy to apply to the volume.

    A full example of the data_protection_snapshot_policy attribute usage can be found in the ./examples/netapp/nfsv3_volume_with_snapshot_policy directory within the GitHub Repository

    NOTE: data_protection_snapshot_policy block can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.

    snapshotPolicyId string

    Resource ID of the snapshot policy to apply to the volume.

    A full example of the data_protection_snapshot_policy attribute usage can be found in the ./examples/netapp/nfsv3_volume_with_snapshot_policy directory within the GitHub Repository

    NOTE: data_protection_snapshot_policy block can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.

    snapshot_policy_id str

    Resource ID of the snapshot policy to apply to the volume.

    A full example of the data_protection_snapshot_policy attribute usage can be found in the ./examples/netapp/nfsv3_volume_with_snapshot_policy directory within the GitHub Repository

    NOTE: data_protection_snapshot_policy block can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.

    snapshotPolicyId String

    Resource ID of the snapshot policy to apply to the volume.

    A full example of the data_protection_snapshot_policy attribute usage can be found in the ./examples/netapp/nfsv3_volume_with_snapshot_policy directory within the GitHub Repository

    NOTE: data_protection_snapshot_policy block can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.

    VolumeExportPolicyRule, VolumeExportPolicyRuleArgs

    AllowedClients List<string>
    A list of allowed clients IPv4 addresses.
    RuleIndex int
    The index number of the rule.
    Kerberos5ReadOnlyEnabled bool
    Is Kerberos 5 read-only access permitted to this volume?
    Kerberos5ReadWriteEnabled bool
    Is Kerberos 5 read/write permitted to this volume?
    Kerberos5iReadOnlyEnabled bool
    Is Kerberos 5i read-only permitted to this volume?
    Kerberos5iReadWriteEnabled bool
    Is Kerberos 5i read/write permitted to this volume?
    Kerberos5pReadOnlyEnabled bool
    Is Kerberos 5p read-only permitted to this volume?
    Kerberos5pReadWriteEnabled bool
    Is Kerberos 5p read/write permitted to this volume?
    ProtocolsEnabled string
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    RootAccessEnabled bool
    Is root access permitted to this volume?
    UnixReadOnly bool
    Is the file system on unix read only?
    UnixReadWrite bool
    Is the file system on unix read and write?
    AllowedClients []string
    A list of allowed clients IPv4 addresses.
    RuleIndex int
    The index number of the rule.
    Kerberos5ReadOnlyEnabled bool
    Is Kerberos 5 read-only access permitted to this volume?
    Kerberos5ReadWriteEnabled bool
    Is Kerberos 5 read/write permitted to this volume?
    Kerberos5iReadOnlyEnabled bool
    Is Kerberos 5i read-only permitted to this volume?
    Kerberos5iReadWriteEnabled bool
    Is Kerberos 5i read/write permitted to this volume?
    Kerberos5pReadOnlyEnabled bool
    Is Kerberos 5p read-only permitted to this volume?
    Kerberos5pReadWriteEnabled bool
    Is Kerberos 5p read/write permitted to this volume?
    ProtocolsEnabled string
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    RootAccessEnabled bool
    Is root access permitted to this volume?
    UnixReadOnly bool
    Is the file system on unix read only?
    UnixReadWrite bool
    Is the file system on unix read and write?
    allowedClients List<String>
    A list of allowed clients IPv4 addresses.
    ruleIndex Integer
    The index number of the rule.
    kerberos5ReadOnlyEnabled Boolean
    Is Kerberos 5 read-only access permitted to this volume?
    kerberos5ReadWriteEnabled Boolean
    Is Kerberos 5 read/write permitted to this volume?
    kerberos5iReadOnlyEnabled Boolean
    Is Kerberos 5i read-only permitted to this volume?
    kerberos5iReadWriteEnabled Boolean
    Is Kerberos 5i read/write permitted to this volume?
    kerberos5pReadOnlyEnabled Boolean
    Is Kerberos 5p read-only permitted to this volume?
    kerberos5pReadWriteEnabled Boolean
    Is Kerberos 5p read/write permitted to this volume?
    protocolsEnabled String
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    rootAccessEnabled Boolean
    Is root access permitted to this volume?
    unixReadOnly Boolean
    Is the file system on unix read only?
    unixReadWrite Boolean
    Is the file system on unix read and write?
    allowedClients string[]
    A list of allowed clients IPv4 addresses.
    ruleIndex number
    The index number of the rule.
    kerberos5ReadOnlyEnabled boolean
    Is Kerberos 5 read-only access permitted to this volume?
    kerberos5ReadWriteEnabled boolean
    Is Kerberos 5 read/write permitted to this volume?
    kerberos5iReadOnlyEnabled boolean
    Is Kerberos 5i read-only permitted to this volume?
    kerberos5iReadWriteEnabled boolean
    Is Kerberos 5i read/write permitted to this volume?
    kerberos5pReadOnlyEnabled boolean
    Is Kerberos 5p read-only permitted to this volume?
    kerberos5pReadWriteEnabled boolean
    Is Kerberos 5p read/write permitted to this volume?
    protocolsEnabled string
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    rootAccessEnabled boolean
    Is root access permitted to this volume?
    unixReadOnly boolean
    Is the file system on unix read only?
    unixReadWrite boolean
    Is the file system on unix read and write?
    allowed_clients Sequence[str]
    A list of allowed clients IPv4 addresses.
    rule_index int
    The index number of the rule.
    kerberos5_read_only_enabled bool
    Is Kerberos 5 read-only access permitted to this volume?
    kerberos5_read_write_enabled bool
    Is Kerberos 5 read/write permitted to this volume?
    kerberos5i_read_only_enabled bool
    Is Kerberos 5i read-only permitted to this volume?
    kerberos5i_read_write_enabled bool
    Is Kerberos 5i read/write permitted to this volume?
    kerberos5p_read_only_enabled bool
    Is Kerberos 5p read-only permitted to this volume?
    kerberos5p_read_write_enabled bool
    Is Kerberos 5p read/write permitted to this volume?
    protocols_enabled str
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    root_access_enabled bool
    Is root access permitted to this volume?
    unix_read_only bool
    Is the file system on unix read only?
    unix_read_write bool
    Is the file system on unix read and write?
    allowedClients List<String>
    A list of allowed clients IPv4 addresses.
    ruleIndex Number
    The index number of the rule.
    kerberos5ReadOnlyEnabled Boolean
    Is Kerberos 5 read-only access permitted to this volume?
    kerberos5ReadWriteEnabled Boolean
    Is Kerberos 5 read/write permitted to this volume?
    kerberos5iReadOnlyEnabled Boolean
    Is Kerberos 5i read-only permitted to this volume?
    kerberos5iReadWriteEnabled Boolean
    Is Kerberos 5i read/write permitted to this volume?
    kerberos5pReadOnlyEnabled Boolean
    Is Kerberos 5p read-only permitted to this volume?
    kerberos5pReadWriteEnabled Boolean
    Is Kerberos 5p read/write permitted to this volume?
    protocolsEnabled String
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    rootAccessEnabled Boolean
    Is root access permitted to this volume?
    unixReadOnly Boolean
    Is the file system on unix read only?
    unixReadWrite Boolean
    Is the file system on unix read and write?

    Import

    NetApp Volumes can be imported using the resource id, e.g.

    $ pulumi import azure:netapp/volume:Volume example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure