1. Packages
  2. Azure Classic
  3. API Docs
  4. netapp
  5. getVolume

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Uses this data source to access information about an existing NetApp Volume.

    NetApp Volume Usage

    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)
    
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var example = Output.Create(Azure.NetApp.GetVolume.InvokeAsync(new Azure.NetApp.GetVolumeArgs
            {
                ResourceGroupName = "acctestRG",
                AccountName = "acctestnetappaccount",
                PoolName = "acctestnetapppool",
                Name = "example-volume",
            }));
            this.NetappVolumeId = example.Apply(example => example.Id);
        }
    
        [Output("netappVolumeId")]
        public Output<string> NetappVolumeId { get; set; }
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/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 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.

    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
    DataProtectionReplications List<GetVolumeDataProtectionReplication>
    Volume data protection block *
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    PoolName string
    Protocols List<string>
    A list of protocol types enabled on volume.
    ResourceGroupName string
    ServiceLevel string
    The service level of the file system.
    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.
    SecurityStyle string
    Volume security style
    AccountName string
    DataProtectionReplications []GetVolumeDataProtectionReplication
    Volume data protection block *
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    PoolName string
    Protocols []string
    A list of protocol types enabled on volume.
    ResourceGroupName string
    ServiceLevel string
    The service level of the file system.
    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.
    SecurityStyle string
    Volume security style
    accountName String
    dataProtectionReplications List<GetVolumeDataProtectionReplication>
    Volume data protection block *
    id String
    The provider-assigned unique ID for this managed resource.
    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
    poolName String
    protocols List<String>
    A list of protocol types enabled on volume.
    resourceGroupName String
    serviceLevel String
    The service level of the file system.
    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.
    securityStyle String
    Volume security style
    accountName string
    dataProtectionReplications GetVolumeDataProtectionReplication[]
    Volume data protection block *
    id string
    The provider-assigned unique ID for this managed resource.
    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
    poolName string
    protocols string[]
    A list of protocol types enabled on volume.
    resourceGroupName string
    serviceLevel string
    The service level of the file system.
    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.
    securityStyle string
    Volume security style
    account_name str
    data_protection_replications Sequence[GetVolumeDataProtectionReplication]
    Volume data protection block *
    id str
    The provider-assigned unique ID for this managed resource.
    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
    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.
    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.
    security_style str
    Volume security style
    accountName String
    dataProtectionReplications List<Property Map>
    Volume data protection block *
    id String
    The provider-assigned unique ID for this managed resource.
    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
    poolName String
    protocols List<String>
    A list of protocol types enabled on volume.
    resourceGroupName String
    serviceLevel String
    The service level of the file system.
    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.
    securityStyle String
    Volume security style

    Supporting Types

    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.
    ReplicationSchedule string

    Deprecated: This property is not in use and will be removed in version 3.0 of the provider. Please use replication_frequency instead

    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.
    ReplicationSchedule string

    Deprecated: This property is not in use and will be removed in version 3.0 of the provider. Please use replication_frequency instead

    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.
    replicationSchedule String

    Deprecated: This property is not in use and will be removed in version 3.0 of the provider. Please use replication_frequency instead

    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.
    replicationSchedule string

    Deprecated: This property is not in use and will be removed in version 3.0 of the provider. Please use replication_frequency instead

    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.
    replication_schedule str

    Deprecated: This property is not in use and will be removed in version 3.0 of the provider. Please use replication_frequency instead

    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.
    replicationSchedule String

    Deprecated: This property is not in use and will be removed in version 3.0 of the provider. Please use replication_frequency instead

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.