azure-native.netapp.getCapacityPoolBucket
Explore with Pulumi AI
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:
- Account
Name string - The name of the NetApp account
- Bucket
Name string - The name of the bucket
- Pool
Name string - The name of the capacity pool
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Volume
Name string - The name of the volume
- Account
Name string - The name of the NetApp account
- Bucket
Name string - The name of the bucket
- Pool
Name string - The name of the capacity pool
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Volume
Name string - The name of the volume
- account
Name String - The name of the NetApp account
- bucket
Name String - The name of the bucket
- pool
Name String - The name of the capacity pool
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- volume
Name String - The name of the volume
- account
Name string - The name of the NetApp account
- bucket
Name string - The name of the bucket
- pool
Name string - The name of the capacity pool
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- volume
Name 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_ strname - The name of the resource group. The name is case insensitive.
- volume_
name str - The name of the volume
- account
Name String - The name of the NetApp account
- bucket
Name String - The name of the bucket
- pool
Name String - The name of the capacity pool
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- volume
Name String - The name of the volume
getCapacityPoolBucket Result
The following output properties are available:
- Azure
Api stringVersion - 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
- Provisioning
State 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.
- System
Data Pulumi.Azure Native. Net App. Outputs. System Data Response - 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"
- File
System Pulumi.User Azure Native. Net App. Outputs. File System User Response - 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.
Azure Native. Net App. Outputs. Bucket Server Properties Response - Properties of the server managing the lifecycle of volume buckets
- Azure
Api stringVersion - 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
- Provisioning
State 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.
- System
Data SystemData Response - 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"
- File
System FileUser System User Response - 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
Bucket
Server Properties Response - Properties of the server managing the lifecycle of volume buckets
- azure
Api StringVersion - 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
- provisioning
State 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.
- system
Data SystemData Response - 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"
- file
System FileUser System User Response - 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
Bucket
Server Properties Response - Properties of the server managing the lifecycle of volume buckets
- azure
Api stringVersion - 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
- provisioning
State 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.
- system
Data SystemData Response - 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"
- file
System FileUser System User Response - 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
Bucket
Server Properties Response - Properties of the server managing the lifecycle of volume buckets
- azure_
api_ strversion - 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 SystemData Response - 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_ Fileuser System User Response - 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
Bucket
Server Properties Response - Properties of the server managing the lifecycle of volume buckets
- azure
Api StringVersion - 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
- provisioning
State 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.
- system
Data 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"
- file
System Property MapUser - 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
- Certificate
Common stringName - Certificate Common Name taken from the certificate installed on the bucket server
- Certificate
Expiry stringDate - The bucket server's certificate expiry date.
- Ip
Address 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 stringName - Certificate Common Name taken from the certificate installed on the bucket server
- Certificate
Expiry stringDate - The bucket server's certificate expiry date.
- Ip
Address 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 StringName - Certificate Common Name taken from the certificate installed on the bucket server
- certificate
Expiry StringDate - The bucket server's certificate expiry date.
- ip
Address 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 stringName - Certificate Common Name taken from the certificate installed on the bucket server
- certificate
Expiry stringDate - The bucket server's certificate expiry date.
- ip
Address 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_ strname - Certificate Common Name taken from the certificate installed on the bucket server
- certificate_
expiry_ strdate - 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.
- certificate
Common StringName - Certificate Common Name taken from the certificate installed on the bucket server
- certificate
Expiry StringDate - The bucket server's certificate expiry date.
- ip
Address 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
- Cifs
User Pulumi.Azure Native. Net App. Inputs. Cifs User Response - The effective CIFS username when accessing the volume data.
- Nfs
User Pulumi.Azure Native. Net App. Inputs. Nfs User Response - The effective NFS User ID and Group ID when accessing the volume data.
- Cifs
User CifsUser Response - The effective CIFS username when accessing the volume data.
- Nfs
User NfsUser Response - The effective NFS User ID and Group ID when accessing the volume data.
- cifs
User CifsUser Response - The effective CIFS username when accessing the volume data.
- nfs
User NfsUser Response - The effective NFS User ID and Group ID when accessing the volume data.
- cifs
User CifsUser Response - The effective CIFS username when accessing the volume data.
- nfs
User NfsUser Response - The effective NFS User ID and Group ID when accessing the volume data.
- cifs_
user CifsUser Response - The effective CIFS username when accessing the volume data.
- nfs_
user NfsUser Response - The effective NFS User ID and Group ID when accessing the volume data.
- cifs
User Property Map - The effective CIFS username when accessing the volume data.
- nfs
User Property Map - The effective NFS User ID and Group ID when accessing the volume data.
NfsUserResponse
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0