Azure v6.22.0, Apr 1 25

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.netapp.getVolume

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

NetApp Volume Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.netapp.getVolume({
    resourceGroupName: "acctestRG",
    accountName: "acctestnetappaccount",
    poolName: "acctestnetapppool",
    name: "example-volume",
});
export const netappVolumeId = example.then(example => example.id);

import pulumi
import pulumi_azure as azure

example = azure.netapp.get_volume(resource_group_name="acctestRG",
    account_name="acctestnetappaccount",
    pool_name="acctestnetapppool",
    name="example-volume")
pulumi.export("netappVolumeId", example.id)

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/netapp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := netapp.LookupVolume(ctx, &netapp.LookupVolumeArgs{
			ResourceGroupName: "acctestRG",
			AccountName:       "acctestnetappaccount",
			PoolName:          "acctestnetapppool",
			Name:              "example-volume",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("netappVolumeId", example.Id)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.NetApp.GetVolume.Invoke(new()
    {
        ResourceGroupName = "acctestRG",
        AccountName = "acctestnetappaccount",
        PoolName = "acctestnetapppool",
        Name = "example-volume",
    });

    return new Dictionary<string, object?>
    {
        ["netappVolumeId"] = example.Apply(getVolumeResult => getVolumeResult.Id),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.netapp.NetappFunctions;
import com.pulumi.azure.netapp.inputs.GetVolumeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = NetappFunctions.getVolume(GetVolumeArgs.builder()
            .resourceGroupName("acctestRG")
            .accountName("acctestnetappaccount")
            .poolName("acctestnetapppool")
            .name("example-volume")
            .build());

        ctx.export("netappVolumeId", example.applyValue(getVolumeResult -> getVolumeResult.id()));
    }
}

variables:
  example:
    fn::invoke:
      function: azure:netapp:getVolume
      arguments:
        resourceGroupName: acctestRG
        accountName: acctestnetappaccount
        poolName: acctestnetapppool
        name: example-volume
outputs:
  netappVolumeId: ${example.id}

Using getVolume

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

TypeScript
Python
Go
C#
Java
YAML

function getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOptions): Output<GetVolumeResult>

def get_volume(account_name: Optional[str] = None,
               name: Optional[str] = None,
               pool_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               security_style: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(account_name: Optional[pulumi.Input[str]] = None,
               name: Optional[pulumi.Input[str]] = None,
               pool_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               security_style: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]

func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput

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

public static class GetVolume 
{
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)

fn::invoke:
  function: azure:netapp/getVolume:getVolume
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountName string: The name of the NetApp account where the NetApp pool exists.
Name string: The name of the NetApp Volume.
PoolName string: The name of the NetApp pool where the NetApp volume exists.
ResourceGroupName string: The Name of the Resource Group where the NetApp Volume exists.
SecurityStyle string: Volume security style

AccountName string: The name of the NetApp account where the NetApp pool exists.
Name string: The name of the NetApp Volume.
PoolName string: The name of the NetApp pool where the NetApp volume exists.
ResourceGroupName string: The Name of the Resource Group where the NetApp Volume exists.
SecurityStyle string: Volume security style

accountName String: The name of the NetApp account where the NetApp pool exists.
name String: The name of the NetApp Volume.
poolName String: The name of the NetApp pool where the NetApp volume exists.
resourceGroupName String: The Name of the Resource Group where the NetApp Volume exists.
securityStyle String: Volume security style

accountName string: The name of the NetApp account where the NetApp pool exists.
name string: The name of the NetApp Volume.
poolName string: The name of the NetApp pool where the NetApp volume exists.
resourceGroupName string: The Name of the Resource Group where the NetApp Volume exists.
securityStyle string: Volume security style

account_name str: The name of the NetApp account where the NetApp pool exists.
name str: The name of the NetApp Volume.
pool_name str: The name of the NetApp pool where the NetApp volume exists.
resource_group_name str: The Name of the Resource Group where the NetApp Volume exists.
security_style str: Volume security style

accountName String: The name of the NetApp account where the NetApp pool exists.
name String: The name of the NetApp Volume.
poolName String: The name of the NetApp pool where the NetApp volume exists.
resourceGroupName String: The Name of the Resource Group where the NetApp Volume exists.
securityStyle String: Volume security style

getVolume Result

The following output properties are available:

AccountName string
DataProtectionBackupPolicies List<GetVolumeDataProtectionBackupPolicy>: A data protecion backup policy block
DataProtectionReplications List<GetVolumeDataProtectionReplication>: Volume data protection replication block
EncryptionKeySource string
Id string: The provider-assigned unique ID for this managed resource.
KeyVaultPrivateEndpointId string
Location string: The Azure Region where the NetApp Volume exists.
MountIpAddresses List<string>: A list of IPv4 Addresses which should be used to mount the volume.
Name string
NetworkFeatures string: Network features in use Basic or Standard.
PoolName string
Protocols List<string>: A list of protocol types enabled on volume.
ResourceGroupName string
ServiceLevel string: The service level of the file system.
SmbAccessBasedEnumerationEnabled bool: Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share.
SmbNonBrowsableEnabled bool: Limits clients from browsing for an SMB share.
StorageQuotaInGb int: The maximum Storage Quota in Gigabytes allowed for a file system.
SubnetId string: The ID of a Subnet in which the NetApp Volume resides.
VolumePath string: The unique file path of the volume.
Zone string: The Availability Zone in which the Volume is located.
SecurityStyle string: Volume security style

AccountName string
DataProtectionBackupPolicies []GetVolumeDataProtectionBackupPolicy: A data protecion backup policy block
DataProtectionReplications []GetVolumeDataProtectionReplication: Volume data protection replication block
EncryptionKeySource string
Id string: The provider-assigned unique ID for this managed resource.
KeyVaultPrivateEndpointId string
Location string: The Azure Region where the NetApp Volume exists.
MountIpAddresses []string: A list of IPv4 Addresses which should be used to mount the volume.
Name string
NetworkFeatures string: Network features in use Basic or Standard.
PoolName string
Protocols []string: A list of protocol types enabled on volume.
ResourceGroupName string
ServiceLevel string: The service level of the file system.
SmbAccessBasedEnumerationEnabled bool: Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share.
SmbNonBrowsableEnabled bool: Limits clients from browsing for an SMB share.
StorageQuotaInGb int: The maximum Storage Quota in Gigabytes allowed for a file system.
SubnetId string: The ID of a Subnet in which the NetApp Volume resides.
VolumePath string: The unique file path of the volume.
Zone string: The Availability Zone in which the Volume is located.
SecurityStyle string: Volume security style

accountName String
dataProtectionBackupPolicies List<GetVolumeDataProtectionBackupPolicy>: A data protecion backup policy block
dataProtectionReplications List<GetVolumeDataProtectionReplication>: Volume data protection replication block
encryptionKeySource String
id String: The provider-assigned unique ID for this managed resource.
keyVaultPrivateEndpointId String
location String: The Azure Region where the NetApp Volume exists.
mountIpAddresses List<String>: A list of IPv4 Addresses which should be used to mount the volume.
name String
networkFeatures String: Network features in use Basic or Standard.
poolName String
protocols List<String>: A list of protocol types enabled on volume.
resourceGroupName String
serviceLevel String: The service level of the file system.
smbAccessBasedEnumerationEnabled Boolean: Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share.
smbNonBrowsableEnabled Boolean: Limits clients from browsing for an SMB share.
storageQuotaInGb Integer: The maximum Storage Quota in Gigabytes allowed for a file system.
subnetId String: The ID of a Subnet in which the NetApp Volume resides.
volumePath String: The unique file path of the volume.
zone String: The Availability Zone in which the Volume is located.
securityStyle String: Volume security style

accountName string
dataProtectionBackupPolicies GetVolumeDataProtectionBackupPolicy[]: A data protecion backup policy block
dataProtectionReplications GetVolumeDataProtectionReplication[]: Volume data protection replication block
encryptionKeySource string
id string: The provider-assigned unique ID for this managed resource.
keyVaultPrivateEndpointId string
location string: The Azure Region where the NetApp Volume exists.
mountIpAddresses string[]: A list of IPv4 Addresses which should be used to mount the volume.
name string
networkFeatures string: Network features in use Basic or Standard.
poolName string
protocols string[]: A list of protocol types enabled on volume.
resourceGroupName string
serviceLevel string: The service level of the file system.
smbAccessBasedEnumerationEnabled boolean: Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share.
smbNonBrowsableEnabled boolean: Limits clients from browsing for an SMB share.
storageQuotaInGb number: The maximum Storage Quota in Gigabytes allowed for a file system.
subnetId string: The ID of a Subnet in which the NetApp Volume resides.
volumePath string: The unique file path of the volume.
zone string: The Availability Zone in which the Volume is located.
securityStyle string: Volume security style

account_name str
data_protection_backup_policies Sequence[GetVolumeDataProtectionBackupPolicy]: A data protecion backup policy block
data_protection_replications Sequence[GetVolumeDataProtectionReplication]: Volume data protection replication block
encryption_key_source str
id str: The provider-assigned unique ID for this managed resource.
key_vault_private_endpoint_id str
location str: The Azure Region where the NetApp Volume exists.
mount_ip_addresses Sequence[str]: A list of IPv4 Addresses which should be used to mount the volume.
name str
network_features str: Network features in use Basic or Standard.
pool_name str
protocols Sequence[str]: A list of protocol types enabled on volume.
resource_group_name str
service_level str: The service level of the file system.
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.
smb_non_browsable_enabled bool: Limits clients from browsing for an SMB share.
storage_quota_in_gb int: The maximum Storage Quota in Gigabytes allowed for a file system.
subnet_id str: The ID of a Subnet in which the NetApp Volume resides.
volume_path str: The unique file path of the volume.
zone str: The Availability Zone in which the Volume is located.
security_style str: Volume security style

accountName String
dataProtectionBackupPolicies List<Property Map>: A data protecion backup policy block
dataProtectionReplications List<Property Map>: Volume data protection replication block
encryptionKeySource String
id String: The provider-assigned unique ID for this managed resource.
keyVaultPrivateEndpointId String
location String: The Azure Region where the NetApp Volume exists.
mountIpAddresses List<String>: A list of IPv4 Addresses which should be used to mount the volume.
name String
networkFeatures String: Network features in use Basic or Standard.
poolName String
protocols List<String>: A list of protocol types enabled on volume.
resourceGroupName String
serviceLevel String: The service level of the file system.
smbAccessBasedEnumerationEnabled Boolean: Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share.
smbNonBrowsableEnabled Boolean: Limits clients from browsing for an SMB share.
storageQuotaInGb Number: The maximum Storage Quota in Gigabytes allowed for a file system.
subnetId String: The ID of a Subnet in which the NetApp Volume resides.
volumePath String: The unique file path of the volume.
zone String: The Availability Zone in which the Volume is located.
securityStyle String: Volume security style

Supporting Types

GetVolumeDataProtectionBackupPolicy

BackupPolicyId string: The Resource ID of the backup policy.
BackupVaultId string: The Resource ID of the backup backup vault.
PolicyEnabled bool: Backup policy is enabled or not.

BackupPolicyId string: The Resource ID of the backup policy.
BackupVaultId string: The Resource ID of the backup backup vault.
PolicyEnabled bool: Backup policy is enabled or not.

backupPolicyId String: The Resource ID of the backup policy.
backupVaultId String: The Resource ID of the backup backup vault.
policyEnabled Boolean: Backup policy is enabled or not.

backupPolicyId string: The Resource ID of the backup policy.
backupVaultId string: The Resource ID of the backup backup vault.
policyEnabled boolean: Backup policy is enabled or not.

backup_policy_id str: The Resource ID of the backup policy.
backup_vault_id str: The Resource ID of the backup backup vault.
policy_enabled bool: Backup policy is enabled or not.

backupPolicyId String: The Resource ID of the backup policy.
backupVaultId String: The Resource ID of the backup backup vault.
policyEnabled Boolean: Backup policy is enabled or not.

GetVolumeDataProtectionReplication

EndpointType string: The endpoint type.
RemoteVolumeLocation string: Location of the primary volume.
RemoteVolumeResourceId string: Resource ID of the primary volume.
ReplicationFrequency string: Frequency of replication.

EndpointType string: The endpoint type.
RemoteVolumeLocation string: Location of the primary volume.
RemoteVolumeResourceId string: Resource ID of the primary volume.
ReplicationFrequency string: Frequency of replication.

endpointType String: The endpoint type.
remoteVolumeLocation String: Location of the primary volume.
remoteVolumeResourceId String: Resource ID of the primary volume.
replicationFrequency String: Frequency of replication.

endpointType string: The endpoint type.
remoteVolumeLocation string: Location of the primary volume.
remoteVolumeResourceId string: Resource ID of the primary volume.
replicationFrequency string: Frequency of replication.

endpoint_type str: The endpoint type.
remote_volume_location str: Location of the primary volume.
remote_volume_resource_id str: Resource ID of the primary volume.
replication_frequency str: Frequency of replication.

endpointType String: The endpoint type.
remoteVolumeLocation String: Location of the primary volume.
remoteVolumeResourceId String: Resource ID of the primary volume.
replicationFrequency String: Frequency of replication.

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

azure.netapp.getVolume

On this page

On this page

NetApp Volume Usage

Using getVolume

getVolume Result

Supporting Types

GetVolumeDataProtectionBackupPolicy

GetVolumeDataProtectionReplication

Package Details

On this page

On this page