Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. netapp
  6. getVolumeBucket

We recommend using Azure Native.

Viewing docs for Azure v6.39.0
published on Tuesday, Jul 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure

azure.netapp.getVolumeBucket

azure logo

We recommend using Azure Native.

Viewing docs for Azure v6.39.0
published on Tuesday, Jul 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure

    Use this data source to access information about an existing NetApp Files Volume Bucket.

    Example Usage

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

const example = azure.netapp.getVolumeBucket({
    name: "example-bucket",
    netappVolumeId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.NetApp/netAppAccounts/example-anfaccount/capacityPools/example-anfpool/volumes/example-anfvolume",
});
export const bucketStatus = example.then(example => example.status);
export const bucketServerIpAddress = example.then(example => example.serverIpAddress);

    import pulumi
import pulumi_azure as azure

example = azure.netapp.get_volume_bucket(name="example-bucket",
    netapp_volume_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.NetApp/netAppAccounts/example-anfaccount/capacityPools/example-anfpool/volumes/example-anfvolume")
pulumi.export("bucketStatus", example.status)
pulumi.export("bucketServerIpAddress", example.server_ip_address)

    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.LookupVolumeBucket(ctx, &netapp.LookupVolumeBucketArgs{
			Name:           "example-bucket",
			NetappVolumeId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.NetApp/netAppAccounts/example-anfaccount/capacityPools/example-anfpool/volumes/example-anfvolume",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("bucketStatus", example.Status)
		ctx.Export("bucketServerIpAddress", example.ServerIpAddress)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Azure.NetApp.GetVolumeBucket.Invoke(new()
    {
        Name = "example-bucket",
        NetappVolumeId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.NetApp/netAppAccounts/example-anfaccount/capacityPools/example-anfpool/volumes/example-anfvolume",
    });

    return new Dictionary<string, object?>
    {
        ["bucketStatus"] = example.Apply(getVolumeBucketResult => getVolumeBucketResult.Status),
        ["bucketServerIpAddress"] = example.Apply(getVolumeBucketResult => getVolumeBucketResult.ServerIpAddress),
    };
});

    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.GetVolumeBucketArgs;
import java.util.ArrayList;
import java.util.Arrays;
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.getVolumeBucket(GetVolumeBucketArgs.builder()
            .name("example-bucket")
            .netappVolumeId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.NetApp/netAppAccounts/example-anfaccount/capacityPools/example-anfpool/volumes/example-anfvolume")
            .build());

        ctx.export("bucketStatus", example.status());
        ctx.export("bucketServerIpAddress", example.serverIpAddress());
    }
}

    variables:
  example:
    fn::invoke:
      function: azure:netapp:getVolumeBucket
      arguments:
        name: example-bucket
        netappVolumeId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.NetApp/netAppAccounts/example-anfaccount/capacityPools/example-anfpool/volumes/example-anfvolume
outputs:
  bucketStatus: ${example.status}
  bucketServerIpAddress: ${example.serverIpAddress}

    pulumi {
  required_providers {
    azure = {
      source = "pulumi/azure"
    }
  }
}

data "azure_netapp_getvolumebucket" "example" {
  name             = "example-bucket"
  netapp_volume_id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.NetApp/netAppAccounts/example-anfaccount/capacityPools/example-anfpool/volumes/example-anfvolume"
}

output "bucketStatus" {
  value = data.azure_netapp_getvolumebucket.example.status
}
output "bucketServerIpAddress" {
  value = data.azure_netapp_getvolumebucket.example.server_ip_address
}

    API Providers

    This data source uses the following Azure API Providers:

    • Microsoft.NetApp - 2026-01-01

    Using getVolumeBucket

    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 getVolumeBucket(args: GetVolumeBucketArgs, opts?: InvokeOptions): Promise<GetVolumeBucketResult>
function getVolumeBucketOutput(args: GetVolumeBucketOutputArgs, opts?: InvokeOptions): Output<GetVolumeBucketResult>
    def get_volume_bucket(name: Optional[str] = None,
                      netapp_volume_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetVolumeBucketResult
def get_volume_bucket_output(name: pulumi.Input[Optional[str]] = None,
                      netapp_volume_id: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetVolumeBucketResult]
    func LookupVolumeBucket(ctx *Context, args *LookupVolumeBucketArgs, opts ...InvokeOption) (*LookupVolumeBucketResult, error)
func LookupVolumeBucketOutput(ctx *Context, args *LookupVolumeBucketOutputArgs, opts ...InvokeOption) LookupVolumeBucketResultOutput

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

    public static class GetVolumeBucket 
{
    public static Task<GetVolumeBucketResult> InvokeAsync(GetVolumeBucketArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeBucketResult> Invoke(GetVolumeBucketInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVolumeBucketResult> getVolumeBucket(GetVolumeBucketArgs args, InvokeOptions options)
public static Output<GetVolumeBucketResult> getVolumeBucket(GetVolumeBucketArgs args, InvokeOptions options)

    fn::invoke:
  function: azure:netapp/getVolumeBucket:getVolumeBucket
  arguments:
    # arguments dictionary
    data "azure_netapp_get_volume_bucket" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    The name of the NetApp Volume Bucket.
    NetappVolumeId string
    The ARM ID of the parent NetApp Volume.
    Name string
    The name of the NetApp Volume Bucket.
    NetappVolumeId string
    The ARM ID of the parent NetApp Volume.
    name string
    The name of the NetApp Volume Bucket.
    netapp_volume_id string
    The ARM ID of the parent NetApp Volume.
    name String
    The name of the NetApp Volume Bucket.
    netappVolumeId String
    The ARM ID of the parent NetApp Volume.
    name string
    The name of the NetApp Volume Bucket.
    netappVolumeId string
    The ARM ID of the parent NetApp Volume.
    name str
    The name of the NetApp Volume Bucket.
    netapp_volume_id str
    The ARM ID of the parent NetApp Volume.
    name String
    The name of the NetApp Volume Bucket.
    netappVolumeId String
    The ARM ID of the parent NetApp Volume.

    getVolumeBucket Result

    The following output properties are available:

    FileSystemCifsUsername string
    The CIFS username used by the bucket (only set when the bucket is configured for CIFS).
    FileSystemNfsUsers List<GetVolumeBucketFileSystemNfsUser>
    A fileSystemNfsUser block as defined below (only set when the bucket is configured for NFS).
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyVaults List<GetVolumeBucketKeyVault>
    A keyVault block as defined below (populated only when the bucket is configured against Azure Key Vault).
    Name string
    NetappVolumeId string
    Path string
    The volume sub-path mounted inside the bucket.
    Permissions string
    The bucket permission level (ReadOnly or ReadWrite).
    ServerCertificateCommonName string
    The Common Name (CN) of the bucket server certificate.
    ServerCertificateExpiryDate string
    The expiry date of the bucket server certificate, in RFC3339 format.
    ServerIpAddress string
    The IP address that backs the bucket endpoint.
    Status string
    The credentials status of the bucket. Possible values are NoCredentialsSet, CredentialsExpired and Active.
    FileSystemCifsUsername string
    The CIFS username used by the bucket (only set when the bucket is configured for CIFS).
    FileSystemNfsUsers []GetVolumeBucketFileSystemNfsUser
    A fileSystemNfsUser block as defined below (only set when the bucket is configured for NFS).
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyVaults []GetVolumeBucketKeyVault
    A keyVault block as defined below (populated only when the bucket is configured against Azure Key Vault).
    Name string
    NetappVolumeId string
    Path string
    The volume sub-path mounted inside the bucket.
    Permissions string
    The bucket permission level (ReadOnly or ReadWrite).
    ServerCertificateCommonName string
    The Common Name (CN) of the bucket server certificate.
    ServerCertificateExpiryDate string
    The expiry date of the bucket server certificate, in RFC3339 format.
    ServerIpAddress string
    The IP address that backs the bucket endpoint.
    Status string
    The credentials status of the bucket. Possible values are NoCredentialsSet, CredentialsExpired and Active.
    file_system_cifs_username string
    The CIFS username used by the bucket (only set when the bucket is configured for CIFS).
    file_system_nfs_users list(object)
    A fileSystemNfsUser block as defined below (only set when the bucket is configured for NFS).
    id string
    The provider-assigned unique ID for this managed resource.
    key_vaults list(object)
    A keyVault block as defined below (populated only when the bucket is configured against Azure Key Vault).
    name string
    netapp_volume_id string
    path string
    The volume sub-path mounted inside the bucket.
    permissions string
    The bucket permission level (ReadOnly or ReadWrite).
    server_certificate_common_name string
    The Common Name (CN) of the bucket server certificate.
    server_certificate_expiry_date string
    The expiry date of the bucket server certificate, in RFC3339 format.
    server_ip_address string
    The IP address that backs the bucket endpoint.
    status string
    The credentials status of the bucket. Possible values are NoCredentialsSet, CredentialsExpired and Active.
    fileSystemCifsUsername String
    The CIFS username used by the bucket (only set when the bucket is configured for CIFS).
    fileSystemNfsUsers List<GetVolumeBucketFileSystemNfsUser>
    A fileSystemNfsUser block as defined below (only set when the bucket is configured for NFS).
    id String
    The provider-assigned unique ID for this managed resource.
    keyVaults List<GetVolumeBucketKeyVault>
    A keyVault block as defined below (populated only when the bucket is configured against Azure Key Vault).
    name String
    netappVolumeId String
    path String
    The volume sub-path mounted inside the bucket.
    permissions String
    The bucket permission level (ReadOnly or ReadWrite).
    serverCertificateCommonName String
    The Common Name (CN) of the bucket server certificate.
    serverCertificateExpiryDate String
    The expiry date of the bucket server certificate, in RFC3339 format.
    serverIpAddress String
    The IP address that backs the bucket endpoint.
    status String
    The credentials status of the bucket. Possible values are NoCredentialsSet, CredentialsExpired and Active.
    fileSystemCifsUsername string
    The CIFS username used by the bucket (only set when the bucket is configured for CIFS).
    fileSystemNfsUsers GetVolumeBucketFileSystemNfsUser[]
    A fileSystemNfsUser block as defined below (only set when the bucket is configured for NFS).
    id string
    The provider-assigned unique ID for this managed resource.
    keyVaults GetVolumeBucketKeyVault[]
    A keyVault block as defined below (populated only when the bucket is configured against Azure Key Vault).
    name string
    netappVolumeId string
    path string
    The volume sub-path mounted inside the bucket.
    permissions string
    The bucket permission level (ReadOnly or ReadWrite).
    serverCertificateCommonName string
    The Common Name (CN) of the bucket server certificate.
    serverCertificateExpiryDate string
    The expiry date of the bucket server certificate, in RFC3339 format.
    serverIpAddress string
    The IP address that backs the bucket endpoint.
    status string
    The credentials status of the bucket. Possible values are NoCredentialsSet, CredentialsExpired and Active.
    file_system_cifs_username str
    The CIFS username used by the bucket (only set when the bucket is configured for CIFS).
    file_system_nfs_users Sequence[GetVolumeBucketFileSystemNfsUser]
    A fileSystemNfsUser block as defined below (only set when the bucket is configured for NFS).
    id str
    The provider-assigned unique ID for this managed resource.
    key_vaults Sequence[GetVolumeBucketKeyVault]
    A keyVault block as defined below (populated only when the bucket is configured against Azure Key Vault).
    name str
    netapp_volume_id str
    path str
    The volume sub-path mounted inside the bucket.
    permissions str
    The bucket permission level (ReadOnly or ReadWrite).
    server_certificate_common_name str
    The Common Name (CN) of the bucket server certificate.
    server_certificate_expiry_date str
    The expiry date of the bucket server certificate, in RFC3339 format.
    server_ip_address str
    The IP address that backs the bucket endpoint.
    status str
    The credentials status of the bucket. Possible values are NoCredentialsSet, CredentialsExpired and Active.
    fileSystemCifsUsername String
    The CIFS username used by the bucket (only set when the bucket is configured for CIFS).
    fileSystemNfsUsers List<Property Map>
    A fileSystemNfsUser block as defined below (only set when the bucket is configured for NFS).
    id String
    The provider-assigned unique ID for this managed resource.
    keyVaults List<Property Map>
    A keyVault block as defined below (populated only when the bucket is configured against Azure Key Vault).
    name String
    netappVolumeId String
    path String
    The volume sub-path mounted inside the bucket.
    permissions String
    The bucket permission level (ReadOnly or ReadWrite).
    serverCertificateCommonName String
    The Common Name (CN) of the bucket server certificate.
    serverCertificateExpiryDate String
    The expiry date of the bucket server certificate, in RFC3339 format.
    serverIpAddress String
    The IP address that backs the bucket endpoint.
    status String
    The credentials status of the bucket. Possible values are NoCredentialsSet, CredentialsExpired and Active.

    Supporting Types

    GetVolumeBucketFileSystemNfsUser

    GroupId int
    The POSIX group ID used by the bucket.
    UserId int
    The POSIX user ID used by the bucket.
    GroupId int
    The POSIX group ID used by the bucket.
    UserId int
    The POSIX user ID used by the bucket.
    group_id number
    The POSIX group ID used by the bucket.
    user_id number
    The POSIX user ID used by the bucket.
    groupId Integer
    The POSIX group ID used by the bucket.
    userId Integer
    The POSIX user ID used by the bucket.
    groupId number
    The POSIX group ID used by the bucket.
    userId number
    The POSIX user ID used by the bucket.
    group_id int
    The POSIX group ID used by the bucket.
    user_id int
    The POSIX user ID used by the bucket.
    groupId Number
    The POSIX group ID used by the bucket.
    userId Number
    The POSIX user ID used by the bucket.

    GetVolumeBucketKeyVault

    CertificateKeyVaultUri string
    The URI of the Azure Key Vault that stores the bucket server certificate.
    CertificateName string
    The name of the certificate object inside the Key Vault.
    CredentialsKeyVaultUri string
    The URI of the Azure Key Vault used to store the generated bucket access and secret keys.
    CredentialsSecretName string
    The name of the secret in credentialsKeyVaultUri that stores the generated bucket credentials.
    CertificateKeyVaultUri string
    The URI of the Azure Key Vault that stores the bucket server certificate.
    CertificateName string
    The name of the certificate object inside the Key Vault.
    CredentialsKeyVaultUri string
    The URI of the Azure Key Vault used to store the generated bucket access and secret keys.
    CredentialsSecretName string
    The name of the secret in credentialsKeyVaultUri that stores the generated bucket credentials.
    certificate_key_vault_uri string
    The URI of the Azure Key Vault that stores the bucket server certificate.
    certificate_name string
    The name of the certificate object inside the Key Vault.
    credentials_key_vault_uri string
    The URI of the Azure Key Vault used to store the generated bucket access and secret keys.
    credentials_secret_name string
    The name of the secret in credentialsKeyVaultUri that stores the generated bucket credentials.
    certificateKeyVaultUri String
    The URI of the Azure Key Vault that stores the bucket server certificate.
    certificateName String
    The name of the certificate object inside the Key Vault.
    credentialsKeyVaultUri String
    The URI of the Azure Key Vault used to store the generated bucket access and secret keys.
    credentialsSecretName String
    The name of the secret in credentialsKeyVaultUri that stores the generated bucket credentials.
    certificateKeyVaultUri string
    The URI of the Azure Key Vault that stores the bucket server certificate.
    certificateName string
    The name of the certificate object inside the Key Vault.
    credentialsKeyVaultUri string
    The URI of the Azure Key Vault used to store the generated bucket access and secret keys.
    credentialsSecretName string
    The name of the secret in credentialsKeyVaultUri that stores the generated bucket credentials.
    certificate_key_vault_uri str
    The URI of the Azure Key Vault that stores the bucket server certificate.
    certificate_name str
    The name of the certificate object inside the Key Vault.
    credentials_key_vault_uri str
    The URI of the Azure Key Vault used to store the generated bucket access and secret keys.
    credentials_secret_name str
    The name of the secret in credentialsKeyVaultUri that stores the generated bucket credentials.
    certificateKeyVaultUri String
    The URI of the Azure Key Vault that stores the bucket server certificate.
    certificateName String
    The name of the certificate object inside the Key Vault.
    credentialsKeyVaultUri String
    The URI of the Azure Key Vault used to store the generated bucket access and secret keys.
    credentialsSecretName String
    The name of the secret in credentialsKeyVaultUri that stores the generated bucket credentials.

    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 v6.39.0
    published on Tuesday, Jul 14, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial