Skip to main content

caches

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

Overview​

Namecaches
TypeResource
Idazure.netapp.caches

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
actualThroughputMibpsnumberActual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel.
cacheStatestringAzure NetApp Files Cache lifecycle management. Known values are: "ClusterPeeringOfferSent", "VserverPeeringOfferSent", "Creating", "Succeeded", and "Failed". (ClusterPeeringOfferSent, VserverPeeringOfferSent, Creating, Succeeded, Failed)
cacheSubnetResourceIdstringThe Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. Required.
cifsChangeNotificationsstringFlag indicating whether a CIFS change notification is enabled for the cache. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
encryptionstringSpecifies if the cache is encryption or not. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
encryptionKeySourcestringSource of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'. Required. Known values are: "Microsoft.NetApp" and "Microsoft.KeyVault". (Microsoft.NetApp, Microsoft.KeyVault)
etagstring"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
exportPolicyobjectSet of export policy rules.
fileAccessLogsstringFlag indicating whether file access logs are enabled for the Cache, based on active diagnostic settings present on the Cache. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
filePathstringThe file path of the Cache. Required.
globalFileLockingstringFlag indicating whether the global file lock is enabled for the cache. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
kerberosstringDescribe if a cache is Kerberos enabled. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
keyVaultPrivateEndpointResourceIdstringThe resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
languagestringLanguage supported for volume. Known values are: "c.utf-8", "utf8mb4", "ar", "ar.utf-8", "hr", "hr.utf-8", "cs", "cs.utf-8", "da", "da.utf-8", "nl", "nl.utf-8", "en", "en.utf-8", "fi", "fi.utf-8", "fr", "fr.utf-8", "de", "de.utf-8", "he", "he.utf-8", "hu", "hu.utf-8", "it", "it.utf-8", "ja", "ja.utf-8", "ja-v1", "ja-v1.utf-8", "ja-jp.pck", "ja-jp.pck.utf-8", "ja-jp.932", "ja-jp.932.utf-8", "ja-jp.pck-v2", "ja-jp.pck-v2.utf-8", "ko", "ko.utf-8", "no", "no.utf-8", "pl", "pl.utf-8", "pt", "pt.utf-8", "c", "ro", "ro.utf-8", "ru", "ru.utf-8", "zh", "zh.utf-8", "zh.gbk", "zh.gbk.utf-8", "zh-tw.big5", "zh-tw.big5.utf-8", "zh-tw", "zh-tw.utf-8", "sk", "sk.utf-8", "sl", "sl.utf-8", "es", "es.utf-8", "sv", "sv.utf-8", "tr", "tr.utf-8", "en-us", and "en-us.utf-8". (c.utf-8, utf8mb4, ar, ar.utf-8, hr, hr.utf-8, cs, cs.utf-8, da, da.utf-8, nl, nl.utf-8, en, en.utf-8, fi, fi.utf-8, fr, fr.utf-8, de, de.utf-8, he, he.utf-8, hu, hu.utf-8, it, it.utf-8, ja, ja.utf-8, ja-v1, ja-v1.utf-8, ja-jp.pck, ja-jp.pck.utf-8, ja-jp.932, ja-jp.932.utf-8, ja-jp.pck-v2, ja-jp.pck-v2.utf-8, ko, ko.utf-8, no, no.utf-8, pl, pl.utf-8, pt, pt.utf-8, c, ro, ro.utf-8, ru, ru.utf-8, zh, zh.utf-8, zh.gbk, zh.gbk.utf-8, zh-tw.big5, zh-tw.big5.utf-8, zh-tw, zh-tw.utf-8, sk, sk.utf-8, sl, sl.utf-8, es, es.utf-8, sv, sv.utf-8, tr, tr.utf-8, en-us, en-us.utf-8)
ldapstringSpecifies whether LDAP is enabled or not for flexcache volume. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
ldapServerTypestringSpecifies the type of LDAP server for flexcache volume. Known values are: "ActiveDirectory" and "OpenLDAP". (ActiveDirectory, OpenLDAP)
locationstringThe geo-location where the resource lives. Required.
maximumNumberOfFilesintegerMaximum number of files allowed.
mountTargetsarrayList of mount targets that can be used to mount this cache.
originClusterInformationobjectOrigin cluster information. Required.
peeringSubnetResourceIdstringThe Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. Required.
protocolTypesarraySet of supported protocol types, which include NFSv3, NFSv4 and SMB protocol.
provisioningStatestringAzure lifecycle management. Known values are: "Creating", "Updating", "Deleting", "Failed", "Succeeded", and "Canceled". (Creating, Updating, Deleting, Failed, Succeeded, Canceled)
sizeintegerMaximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. Required.
smbSettingsobjectSMB information for the cache.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectResource tags.
throughputMibpsnumberMaximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
writeBackstringFlag indicating whether writeback is enabled for the cache. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
zonesarrayThe availability zones.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, account_name, pool_name, cache_name, subscription_idGet the details of the specified Cache.
listselectresource_group_name, account_name, pool_name, subscription_idList all Caches within the Capacity Pool.
create_or_updateinsertresource_group_name, account_name, pool_name, cache_name, subscription_id, location, propertiesCreate or update the specified Cache within the Capacity Pool.
updateupdateresource_group_name, account_name, pool_name, cache_name, subscription_idPatch the specified Cache.
create_or_updatereplaceresource_group_name, account_name, pool_name, cache_name, subscription_id, location, propertiesCreate or update the specified Cache within the Capacity Pool.
deletedeleteresource_group_name, account_name, pool_name, cache_name, subscription_idDelete the specified cache.
list_peering_passphrasesexecresource_group_name, account_name, pool_name, cache_name, subscription_idThis operation will list the cluster peering command, cluster peering passphrase and the vserver peering command.
pool_changeexecresource_group_name, account_name, pool_name, cache_name, subscription_id, newPoolResourceIdMoves Cache to another Capacity Pool.
reset_smb_passwordexecresource_group_name, account_name, pool_name, cache_name, subscription_idResets the SMB password for the cache.

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.

NameDatatypeDescription
account_namestringThe name of the NetApp account. Required.
cache_namestringThe name of the cache resource. Required.
pool_namestringThe name of the capacity pool. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples​

Get the details of the specified Cache.

SELECT
id,
name,
actualThroughputMibps,
cacheState,
cacheSubnetResourceId,
cifsChangeNotifications,
encryption,
encryptionKeySource,
etag,
exportPolicy,
fileAccessLogs,
filePath,
globalFileLocking,
kerberos,
keyVaultPrivateEndpointResourceId,
language,
ldap,
ldapServerType,
location,
maximumNumberOfFiles,
mountTargets,
originClusterInformation,
peeringSubnetResourceId,
protocolTypes,
provisioningState,
size,
smbSettings,
systemData,
tags,
throughputMibps,
type,
writeBack,
zones
FROM azure.netapp.caches
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND cache_name = '{{ cache_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create or update the specified Cache within the Capacity Pool.

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

UPDATE examples​

Patch the specified Cache.

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

REPLACE examples​

Create or update the specified Cache within the Capacity Pool.

REPLACE azure.netapp.caches
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND cache_name = '{{ cache_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type,
zones;

DELETE examples​

Delete the specified cache.

DELETE FROM azure.netapp.caches
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND cache_name = '{{ cache_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods​

This operation will list the cluster peering command, cluster peering passphrase and the vserver peering command.

EXEC azure.netapp.caches.list_peering_passphrases 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@cache_name='{{ cache_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;