volume_quota_rules

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

Overview

Name	volume_quota_rules
Type	Resource
Id	azure.netapp.volume_quota_rules

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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Gets the status of the VolumeQuotaRule at the time the operation was called. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
quotaSizeInKiBs	integer	Size of quota.
quotaTarget	string	UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running .
quotaType	string	Type of quota. Known values are: "DefaultUserQuota", "DefaultGroupQuota", "IndividualUserQuota", and "IndividualGroupQuota". (DefaultUserQuota, DefaultGroupQuota, IndividualUserQuota, IndividualGroupQuota)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_volume

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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Gets the status of the VolumeQuotaRule at the time the operation was called. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
quotaSizeInKiBs	integer	Size of quota.
quotaTarget	string	UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running .
quotaType	string	Type of quota. Known values are: "DefaultUserQuota", "DefaultGroupQuota", "IndividualUserQuota", and "IndividualGroupQuota". (DefaultUserQuota, DefaultGroupQuota, IndividualUserQuota, IndividualGroupQuota)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, volume_quota_rule_name, subscription_id		Get details of the specified quota rule.
list_by_volume	select	resource_group_name, account_name, pool_name, volume_name, subscription_id		List all quota rules associated with the volume.
create	insert	resource_group_name, account_name, pool_name, volume_name, volume_quota_rule_name, subscription_id, location		Create the specified quota rule within the given volume.
update	update	resource_group_name, account_name, pool_name, volume_name, volume_quota_rule_name, subscription_id		Patch a quota rule.
delete	delete	resource_group_name, account_name, pool_name, volume_name, volume_quota_rule_name, subscription_id		Delete quota rule.

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.
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.
volume_quota_rule_name	string	The name of volume quota rule. Required.

SELECT examples

get

Get details of the specified quota rule.

SELECT
id,
name,
location,
provisioningState,
quotaSizeInKiBs,
quotaTarget,
quotaType,
systemData,
tags,
type
FROM azure.netapp.volume_quota_rules
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 volume_quota_rule_name = '{{ volume_quota_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_volume

List all quota rules associated with the volume.

SELECT
id,
name,
location,
provisioningState,
quotaSizeInKiBs,
quotaTarget,
quotaType,
systemData,
tags,
type
FROM azure.netapp.volume_quota_rules
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

Create the specified quota rule within the given volume.

INSERT INTO azure.netapp.volume_quota_rules (
tags,
location,
properties,
resource_group_name,
account_name,
pool_name,
volume_name,
volume_quota_rule_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ pool_name }}',
'{{ volume_name }}',
'{{ volume_quota_rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: volume_quota_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the volume_quota_rules resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the volume_quota_rules resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the volume_quota_rules resource.
  - name: volume_name
    value: "{{ volume_name }}"
    description: Required parameter for the volume_quota_rules resource.
  - name: volume_quota_rule_name
    value: "{{ volume_quota_rule_name }}"
    description: Required parameter for the volume_quota_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the volume_quota_rules resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Volume Quota Rule Properties.
    value:
      provisioningState: "{{ provisioningState }}"
      quotaSizeInKiBs: {{ quotaSizeInKiBs }}
      quotaType: "{{ quotaType }}"
      quotaTarget: "{{ quotaTarget }}"

UPDATE examples

update

Patch a quota rule.

UPDATE azure.netapp.volume_quota_rules
SET 
tags = '{{ tags }}',
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 volume_quota_rule_name = '{{ volume_quota_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete quota rule.

DELETE FROM azure.netapp.volume_quota_rules
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 volume_quota_rule_name = '{{ volume_quota_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;