buckets

Creates, updates, deletes, gets or lists a buckets resource.

Overview

Name	buckets
Type	Resource
Id	azure.netapp.buckets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
akvDetails	object	Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials Notes: 1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property. 2. These properties are mutually exclusive with the server.certificateObject property.
fileSystemUser	object	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.
permissions	string	Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. Known values are: "ReadOnly" and "ReadWrite". (ReadOnly, ReadWrite)
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
server	object	Properties of the server managing the lifecycle of volume buckets.
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. Known values are: "NoCredentialsSet", "CredentialsExpired", and "Active". (NoCredentialsSet, CredentialsExpired, Active)
systemData	object	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".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
akvDetails	object	Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials Notes: 1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property. 2. These properties are mutually exclusive with the server.certificateObject property.
fileSystemUser	object	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.
permissions	string	Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. Known values are: "ReadOnly" and "ReadWrite". (ReadOnly, ReadWrite)
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
server	object	Properties of the server managing the lifecycle of volume buckets.
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. Known values are: "NoCredentialsSet", "CredentialsExpired", and "Active". (NoCredentialsSet, CredentialsExpired, Active)
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, pool_name, volume_name, bucket_name, subscription_id		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.
list	select	resource_group_name, account_name, pool_name, volume_name, subscription_id		Describes all buckets belonging to a volume. Buckets allow additional services, such as AI services, connect to the volume data contained in those buckets.
create_or_update	insert	resource_group_name, account_name, pool_name, volume_name, bucket_name, subscription_id		Creates or updates a bucket for a volume. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.
update	update	resource_group_name, account_name, pool_name, volume_name, bucket_name, subscription_id		Updates the details of a volume bucket.
create_or_update	replace	resource_group_name, account_name, pool_name, volume_name, bucket_name, subscription_id		Creates or updates a bucket for a volume. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.
delete	delete	resource_group_name, account_name, pool_name, volume_name, bucket_name, subscription_id		Delete a volume's bucket.
generate_credentials	exec	resource_group_name, account_name, pool_name, volume_name, bucket_name, subscription_id		Generate the access key and secret key used for accessing the specified volume bucket. Also return expiry date and time of key pair (in UTC).
generate_akv_credentials	exec	resource_group_name, account_name, pool_name, volume_name, bucket_name, subscription_id		Generate the access key and secret key used for accessing the specified volume bucket and store in Azure Key Vault.
refresh_certificate	exec	resource_group_name, account_name, pool_name, volume_name, bucket_name, subscription_id		This operation will fetch the certificate from Azure Key Vault and install it on the bucket server.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	The name of the NetApp account. Required.
bucket_name	string	The name of the bucket. Required.
pool_name	string	The name of the capacity pool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
volume_name	string	The name of the volume. Required.

SELECT examples

get

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.

SELECT
id,
name,
akvDetails,
fileSystemUser,
path,
permissions,
provisioningState,
server,
status,
systemData,
type
FROM azure.netapp.buckets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND volume_name = '{{ volume_name }}' -- required
AND bucket_name = '{{ bucket_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Describes all buckets belonging to a volume. Buckets allow additional services, such as AI services, connect to the volume data contained in those buckets.

SELECT
id,
name,
akvDetails,
fileSystemUser,
path,
permissions,
provisioningState,
server,
status,
systemData,
type
FROM azure.netapp.buckets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND volume_name = '{{ volume_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a bucket for a volume. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.

INSERT INTO azure.netapp.buckets (
properties,
resource_group_name,
account_name,
pool_name,
volume_name,
bucket_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ pool_name }}',
'{{ volume_name }}',
'{{ bucket_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: buckets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the buckets resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the buckets resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the buckets resource.
  - name: volume_name
    value: "{{ volume_name }}"
    description: Required parameter for the buckets resource.
  - name: bucket_name
    value: "{{ bucket_name }}"
    description: Required parameter for the buckets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the buckets resource.
  - name: properties
    description: |
      Bucket properties.
    value:
      path: "{{ path }}"
      fileSystemUser:
        nfsUser:
          userId: {{ userId }}
          groupId: {{ groupId }}
        cifsUser:
          username: "{{ username }}"
      provisioningState: "{{ provisioningState }}"
      status: "{{ status }}"
      server:
        fqdn: "{{ fqdn }}"
        certificateCommonName: "{{ certificateCommonName }}"
        certificateExpiryDate: "{{ certificateExpiryDate }}"
        ipAddress: "{{ ipAddress }}"
        certificateObject: "{{ certificateObject }}"
        onCertificateConflictAction: "{{ onCertificateConflictAction }}"
      permissions: "{{ permissions }}"
      akvDetails:
        certificateAkvDetails:
          certificateKeyVaultUri: "{{ certificateKeyVaultUri }}"
          certificateName: "{{ certificateName }}"
          userAssignedIdentity: "{{ userAssignedIdentity }}"
        credentialsAkvDetails:
          credentialsKeyVaultUri: "{{ credentialsKeyVaultUri }}"
          secretName: "{{ secretName }}"
          userAssignedIdentity: "{{ userAssignedIdentity }}"

UPDATE examples

update

Updates the details of a volume bucket.

UPDATE azure.netapp.buckets
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND bucket_name = '{{ bucket_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a bucket for a volume. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.

REPLACE azure.netapp.buckets
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND bucket_name = '{{ bucket_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a volume's bucket.

DELETE FROM azure.netapp.buckets
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND bucket_name = '{{ bucket_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

generate_credentials

Generate the access key and secret key used for accessing the specified volume bucket. Also return expiry date and time of key pair (in UTC).

EXEC azure.netapp.buckets.generate_credentials 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@volume_name='{{ volume_name }}' --required, 
@bucket_name='{{ bucket_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyPairExpiryDays": {{ keyPairExpiryDays }}
}'
;

generate_akv_credentials

Generate the access key and secret key used for accessing the specified volume bucket and store in Azure Key Vault.

EXEC azure.netapp.buckets.generate_akv_credentials 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@volume_name='{{ volume_name }}' --required, 
@bucket_name='{{ bucket_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyPairExpiryDays": {{ keyPairExpiryDays }}
}'
;

refresh_certificate

This operation will fetch the certificate from Azure Key Vault and install it on the bucket server.

EXEC azure.netapp.buckets.refresh_certificate 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@volume_name='{{ volume_name }}' --required, 
@bucket_name='{{ bucket_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;