cache_rules

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

Overview

Name	cache_rules
Type	Resource
Id	azure.container_registry.cache_rules

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The properties of the cache rule.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The properties of the cache rule.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, registryName, cacheRuleName		Gets the properties of the specified cache rule resource.
list	select	subscriptionId, resourceGroupName, registryName		Lists all cache rule resources for the specified container registry.
create	insert	subscriptionId, resourceGroupName, registryName, cacheRuleName		Creates a cache rule for a container registry with the specified parameters.
update	update	subscriptionId, resourceGroupName, registryName, cacheRuleName		Updates a cache rule for a container registry with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, registryName, cacheRuleName		Deletes a cache rule resource from a container registry.

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
cacheRuleName	string	The name of the cache rule.
registryName	string	The name of the container registry.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the properties of the specified cache rule resource.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.container_registry.cache_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
AND cacheRuleName = '{{ cacheRuleName }}' -- required
;

list

Lists all cache rule resources for the specified container registry.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.container_registry.cache_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
;

INSERT examples

create

Creates a cache rule for a container registry with the specified parameters.

INSERT INTO azure.container_registry.cache_rules (
data__properties,
subscriptionId,
resourceGroupName,
registryName,
cacheRuleName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ registryName }}',
'{{ cacheRuleName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: cache_rules
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the cache_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cache_rules resource.
    - name: registryName
      value: string
      description: Required parameter for the cache_rules resource.
    - name: cacheRuleName
      value: string
      description: Required parameter for the cache_rules resource.
    - name: properties
      value: object
      description: |
        The properties of the cache rule.

UPDATE examples

update

Updates a cache rule for a container registry with the specified parameters.

UPDATE azure.container_registry.cache_rules
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND cacheRuleName = '{{ cacheRuleName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a cache rule resource from a container registry.

DELETE FROM azure.container_registry.cache_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND cacheRuleName = '{{ cacheRuleName }}' --required
;