1. Packages
  2. Azure Native
  3. API Docs
  4. netapp
  5. getCapacityPoolBucket
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.netapp.getCapacityPoolBucket

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Get the details of the specified volume’s bucket. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.

    Uses Azure REST API version 2025-01-01-preview.

    Using getCapacityPoolBucket

    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 getCapacityPoolBucket(args: GetCapacityPoolBucketArgs, opts?: InvokeOptions): Promise<GetCapacityPoolBucketResult>
    function getCapacityPoolBucketOutput(args: GetCapacityPoolBucketOutputArgs, opts?: InvokeOptions): Output<GetCapacityPoolBucketResult>
    def get_capacity_pool_bucket(account_name: Optional[str] = None,
                                 bucket_name: Optional[str] = None,
                                 pool_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 volume_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetCapacityPoolBucketResult
    def get_capacity_pool_bucket_output(account_name: Optional[pulumi.Input[str]] = None,
                                 bucket_name: Optional[pulumi.Input[str]] = None,
                                 pool_name: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 volume_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetCapacityPoolBucketResult]
    func LookupCapacityPoolBucket(ctx *Context, args *LookupCapacityPoolBucketArgs, opts ...InvokeOption) (*LookupCapacityPoolBucketResult, error)
    func LookupCapacityPoolBucketOutput(ctx *Context, args *LookupCapacityPoolBucketOutputArgs, opts ...InvokeOption) LookupCapacityPoolBucketResultOutput

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

    public static class GetCapacityPoolBucket 
    {
        public static Task<GetCapacityPoolBucketResult> InvokeAsync(GetCapacityPoolBucketArgs args, InvokeOptions? opts = null)
        public static Output<GetCapacityPoolBucketResult> Invoke(GetCapacityPoolBucketInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCapacityPoolBucketResult> getCapacityPoolBucket(GetCapacityPoolBucketArgs args, InvokeOptions options)
    public static Output<GetCapacityPoolBucketResult> getCapacityPoolBucket(GetCapacityPoolBucketArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:netapp:getCapacityPoolBucket
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    The name of the NetApp account
    BucketName string
    The name of the bucket
    PoolName string
    The name of the capacity pool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VolumeName string
    The name of the volume
    AccountName string
    The name of the NetApp account
    BucketName string
    The name of the bucket
    PoolName string
    The name of the capacity pool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VolumeName string
    The name of the volume
    accountName String
    The name of the NetApp account
    bucketName String
    The name of the bucket
    poolName String
    The name of the capacity pool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    volumeName String
    The name of the volume
    accountName string
    The name of the NetApp account
    bucketName string
    The name of the bucket
    poolName string
    The name of the capacity pool
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    volumeName string
    The name of the volume
    account_name str
    The name of the NetApp account
    bucket_name str
    The name of the bucket
    pool_name str
    The name of the capacity pool
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    volume_name str
    The name of the volume
    accountName String
    The name of the NetApp account
    bucketName String
    The name of the bucket
    poolName String
    The name of the capacity pool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    volumeName String
    The name of the volume

    getCapacityPoolBucket Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource
    Status string

    The bucket credentials status. There states:

    "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired.

    SystemData Pulumi.AzureNative.NetApp.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    FileSystemUser Pulumi.AzureNative.NetApp.Outputs.FileSystemUserResponse
    File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both.
    Path string
    The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created.
    Server Pulumi.AzureNative.NetApp.Outputs.BucketServerPropertiesResponse
    Properties of the server managing the lifecycle of volume buckets
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource
    Status string

    The bucket credentials status. There states:

    "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired.

    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    FileSystemUser FileSystemUserResponse
    File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both.
    Path string
    The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created.
    Server BucketServerPropertiesResponse
    Properties of the server managing the lifecycle of volume buckets
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource
    status String

    The bucket credentials status. There states:

    "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired.

    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    fileSystemUser FileSystemUserResponse
    File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both.
    path String
    The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created.
    server BucketServerPropertiesResponse
    Properties of the server managing the lifecycle of volume buckets
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    provisioningState string
    Provisioning state of the resource
    status string

    The bucket credentials status. There states:

    "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired.

    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    fileSystemUser FileSystemUserResponse
    File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both.
    path string
    The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created.
    server BucketServerPropertiesResponse
    Properties of the server managing the lifecycle of volume buckets
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    provisioning_state str
    Provisioning state of the resource
    status str

    The bucket credentials status. There states:

    "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired.

    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    file_system_user FileSystemUserResponse
    File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both.
    path str
    The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created.
    server BucketServerPropertiesResponse
    Properties of the server managing the lifecycle of volume buckets
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource
    status String

    The bucket credentials status. There states:

    "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired.

    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    fileSystemUser Property Map
    File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both.
    path String
    The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created.
    server Property Map
    Properties of the server managing the lifecycle of volume buckets

    Supporting Types

    BucketServerPropertiesResponse

    CertificateCommonName string
    Certificate Common Name taken from the certificate installed on the bucket server
    CertificateExpiryDate string
    The bucket server's certificate expiry date.
    IpAddress string
    The bucket server's IPv4 address
    Fqdn string
    The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate.
    CertificateCommonName string
    Certificate Common Name taken from the certificate installed on the bucket server
    CertificateExpiryDate string
    The bucket server's certificate expiry date.
    IpAddress string
    The bucket server's IPv4 address
    Fqdn string
    The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate.
    certificateCommonName String
    Certificate Common Name taken from the certificate installed on the bucket server
    certificateExpiryDate String
    The bucket server's certificate expiry date.
    ipAddress String
    The bucket server's IPv4 address
    fqdn String
    The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate.
    certificateCommonName string
    Certificate Common Name taken from the certificate installed on the bucket server
    certificateExpiryDate string
    The bucket server's certificate expiry date.
    ipAddress string
    The bucket server's IPv4 address
    fqdn string
    The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate.
    certificate_common_name str
    Certificate Common Name taken from the certificate installed on the bucket server
    certificate_expiry_date str
    The bucket server's certificate expiry date.
    ip_address str
    The bucket server's IPv4 address
    fqdn str
    The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate.
    certificateCommonName String
    Certificate Common Name taken from the certificate installed on the bucket server
    certificateExpiryDate String
    The bucket server's certificate expiry date.
    ipAddress String
    The bucket server's IPv4 address
    fqdn String
    The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate.

    CifsUserResponse

    Username string
    The CIFS user's username
    Username string
    The CIFS user's username
    username String
    The CIFS user's username
    username string
    The CIFS user's username
    username str
    The CIFS user's username
    username String
    The CIFS user's username

    FileSystemUserResponse

    CifsUser Pulumi.AzureNative.NetApp.Inputs.CifsUserResponse
    The effective CIFS username when accessing the volume data.
    NfsUser Pulumi.AzureNative.NetApp.Inputs.NfsUserResponse
    The effective NFS User ID and Group ID when accessing the volume data.
    CifsUser CifsUserResponse
    The effective CIFS username when accessing the volume data.
    NfsUser NfsUserResponse
    The effective NFS User ID and Group ID when accessing the volume data.
    cifsUser CifsUserResponse
    The effective CIFS username when accessing the volume data.
    nfsUser NfsUserResponse
    The effective NFS User ID and Group ID when accessing the volume data.
    cifsUser CifsUserResponse
    The effective CIFS username when accessing the volume data.
    nfsUser NfsUserResponse
    The effective NFS User ID and Group ID when accessing the volume data.
    cifs_user CifsUserResponse
    The effective CIFS username when accessing the volume data.
    nfs_user NfsUserResponse
    The effective NFS User ID and Group ID when accessing the volume data.
    cifsUser Property Map
    The effective CIFS username when accessing the volume data.
    nfsUser Property Map
    The effective NFS User ID and Group ID when accessing the volume data.

    NfsUserResponse

    GroupId double
    The NFS user's GID
    UserId double
    The NFS user's UID
    GroupId float64
    The NFS user's GID
    UserId float64
    The NFS user's UID
    groupId Double
    The NFS user's GID
    userId Double
    The NFS user's UID
    groupId number
    The NFS user's GID
    userId number
    The NFS user's UID
    group_id float
    The NFS user's GID
    user_id float
    The NFS user's UID
    groupId Number
    The NFS user's GID
    userId Number
    The NFS user's UID

    SystemDataResponse

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

    Package Details

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