scope_maps

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

Overview

Name	scope_maps
Type	Resource
Id	azure.container_registry.scope_maps

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 scope map.
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 scope map.
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, scopeMapName		Gets the properties of the specified scope map.
list	select	subscriptionId, resourceGroupName, registryName		Lists all the scope maps for the specified container registry.
create	insert	subscriptionId, resourceGroupName, registryName, scopeMapName		Creates a scope map for a container registry with the specified parameters.
update	update	subscriptionId, resourceGroupName, registryName, scopeMapName		Updates a scope map with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, registryName, scopeMapName		Deletes a scope map 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
registryName	string	The name of the container registry.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
scopeMapName	string	The name of the scope map.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the properties of the specified scope map.

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

list

Lists all the scope maps for the specified container registry.

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

INSERT examples

create

Creates a scope map for a container registry with the specified parameters.

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

Manifest

# Description fields are for documentation purposes
- name: scope_maps
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the scope_maps resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the scope_maps resource.
    - name: registryName
      value: string
      description: Required parameter for the scope_maps resource.
    - name: scopeMapName
      value: string
      description: Required parameter for the scope_maps resource.
    - name: properties
      value: object
      description: |
        The properties of the scope map.

UPDATE examples

update

Updates a scope map with the specified parameters.

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

DELETE examples

delete

Deletes a scope map from a container registry.

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