caches

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

Overview

Name	caches
Type	Resource
Id	azure.storage_cache.caches

Fields

Name	Datatype	Description
id	string	A fully qualified URL.
name	string	Schema for the name of resources served by this provider. Note that objects will contain an odata @id annotation as appropriate. This will contain the complete resource id of the object. These names are case-preserving, but not case sensitive.
identity	object	Cache identity properties.
location	string	Region name string.
properties	object	Properties of the cache.
sku	object	SKU for the cache.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Type of the cache; Microsoft.StorageCache/Cache

Methods

Name	Accessible by	Required Params	Description
get	SELECT	cacheName, resourceGroupName, subscriptionId	Returns a cache.
list	SELECT	subscriptionId	Returns all caches the user has access to under a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Returns all caches the user has access to under a resource group.
create_or_update	INSERT	cacheName, resourceGroupName, subscriptionId	Create or update a cache.
delete	DELETE	cacheName, resourceGroupName, subscriptionId	Schedules a cache for deletion.
update	UPDATE	cacheName, resourceGroupName, subscriptionId	Update a cache instance.
debug_info	EXEC	cacheName, resourceGroupName, subscriptionId	Tells a cache to write generate debug info for support to process.
flush	EXEC	cacheName, resourceGroupName, subscriptionId	Tells a cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.
pause_priming_job	EXEC	cacheName, resourceGroupName, subscriptionId, data__primingJobId	Schedule a priming job to be paused.
resume_priming_job	EXEC	cacheName, resourceGroupName, subscriptionId, data__primingJobId	Resumes a paused priming job.
space_allocation	EXEC	cacheName, resourceGroupName, subscriptionId	Update cache space allocation.
start	EXEC	cacheName, resourceGroupName, subscriptionId	Tells a Stopped state cache to transition to Active state.
start_priming_job	EXEC	cacheName, resourceGroupName, subscriptionId, data__primingJobName, data__primingManifestUrl	Create a priming job. This operation is only allowed when the cache is healthy.
stop	EXEC	cacheName, resourceGroupName, subscriptionId	Tells an Active cache to transition to Stopped state.
stop_priming_job	EXEC	cacheName, resourceGroupName, subscriptionId, data__primingJobId	Schedule a priming job for deletion.
upgrade_firmware	EXEC	cacheName, resourceGroupName, subscriptionId	Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.

SELECT examples

Returns all caches the user has access to under a subscription.

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.storage_cache.caches
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new caches resource.

All Properties

/*+ create */
INSERT INTO azure.storage_cache.caches (
cacheName,
resourceGroupName,
subscriptionId,
tags,
location,
identity,
properties,
sku
)
SELECT 
'{{ cacheName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ properties }}',
'{{ sku }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: id
      value: []
    - name: location
      value: string
    - name: name
      value: []
    - name: type
      value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: object
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: cacheSizeGB
          value: integer
        - name: health
          value:
            - name: state
              value: string
            - name: statusDescription
              value: string
            - name: conditions
              value:
                - - name: timestamp
                    value: string
                  - name: message
                    value: string
        - name: mountAddresses
          value:
            - string
        - name: provisioningState
          value: string
        - name: upgradeStatus
          value:
            - name: currentFirmwareVersion
              value: string
            - name: firmwareUpdateStatus
              value: string
            - name: firmwareUpdateDeadline
              value: string
            - name: lastFirmwareUpdate
              value: string
            - name: pendingFirmwareVersion
              value: string
        - name: upgradeSettings
          value:
            - name: upgradeScheduleEnabled
              value: boolean
            - name: scheduledTime
              value: string
        - name: networkSettings
          value:
            - name: mtu
              value: integer
            - name: utilityAddresses
              value:
                - string
            - name: dnsServers
              value:
                - string
            - name: dnsSearchDomain
              value: string
            - name: ntpServer
              value: string
        - name: encryptionSettings
          value:
            - name: keyEncryptionKey
              value:
                - name: keyUrl
                  value: string
                - name: sourceVault
                  value:
                    - name: id
                      value: string
            - name: rotationToLatestKeyVersionEnabled
              value: boolean
        - name: securitySettings
          value:
            - name: accessPolicies
              value:
                - - name: name
                    value: string
                  - name: accessRules
                    value:
                      - - name: scope
                          value: string
                        - name: filter
                          value: string
                        - name: access
                          value: string
                        - name: suid
                          value: boolean
                        - name: submountAccess
                          value: boolean
                        - name: rootSquash
                          value: boolean
                        - name: anonymousUID
                          value: string
                        - name: anonymousGID
                          value: string
        - name: directoryServicesSettings
          value:
            - name: activeDirectory
              value:
                - name: primaryDnsIpAddress
                  value: string
                - name: secondaryDnsIpAddress
                  value: string
                - name: domainName
                  value: string
                - name: domainNetBiosName
                  value: string
                - name: cacheNetBiosName
                  value: string
                - name: domainJoined
                  value: string
                - name: credentials
                  value:
                    - name: username
                      value: string
                    - name: password
                      value: string
            - name: usernameDownload
              value:
                - name: extendedGroups
                  value: boolean
                - name: usernameSource
                  value: string
                - name: groupFileURI
                  value: string
                - name: userFileURI
                  value: string
                - name: ldapServer
                  value: string
                - name: ldapBaseDN
                  value: string
                - name: encryptLdapConnection
                  value: boolean
                - name: requireValidCertificate
                  value: boolean
                - name: autoDownloadCertificate
                  value: boolean
                - name: caCertificateURI
                  value: string
                - name: usernameDownloaded
                  value: string
                - name: credentials
                  value:
                    - name: bindDn
                      value: string
                    - name: bindPassword
                      value: string
        - name: zones
          value:
            - string
        - name: primingJobs
          value: []
        - name: spaceAllocation
          value: []
    - name: sku
      value:
        - name: name
          value: string

UPDATE example

Updates a caches resource.

/*+ update */
UPDATE azure.storage_cache.caches
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
cacheName = '{{ cacheName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified caches resource.

/*+ delete */
DELETE FROM azure.storage_cache.caches
WHERE cacheName = '{{ cacheName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';