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

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 private link resource.
actions	array	The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write. Required.
creationDate	string (date-time)	The creation date of scope map.
description	string	The user friendly description of the scope map.
provisioningState	string	Provisioning state of the resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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 private link resource.
actions	array	The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write. Required.
creationDate	string (date-time)	The creation date of scope map.
description	string	The user friendly description of the scope map.
provisioningState	string	Provisioning state of the resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, registry_name, scope_map_name, subscription_id		Gets the properties of the specified scope map.
list	select	resource_group_name, registry_name, subscription_id		Lists all the scope maps for the specified container registry.
create	insert	resource_group_name, registry_name, scope_map_name, subscription_id		Creates a scope map for a container registry with the specified parameters.
update	update	resource_group_name, registry_name, scope_map_name, subscription_id		Updates a scope map with the specified parameters.
delete	delete	resource_group_name, registry_name, scope_map_name, subscription_id		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
registry_name	string	The name of the container registry. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
scope_map_name	string	The name of the scope map. Required.
subscription_id	string

SELECT examples

get

Gets the properties of the specified scope map.

SELECT
id,
name,
actions,
creationDate,
description,
provisioningState,
systemData,
type
FROM azure.container_registry.scope_maps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND scope_map_name = '{{ scope_map_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the scope maps for the specified container registry.

SELECT
id,
name,
actions,
creationDate,
description,
provisioningState,
systemData,
type
FROM azure.container_registry.scope_maps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.container_registry.scope_maps (
properties,
resource_group_name,
registry_name,
scope_map_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ registry_name }}',
'{{ scope_map_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: scope_maps
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the scope_maps resource.
  - name: registry_name
    value: "{{ registry_name }}"
    description: Required parameter for the scope_maps resource.
  - name: scope_map_name
    value: "{{ scope_map_name }}"
    description: Required parameter for the scope_maps resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the scope_maps resource.
  - name: properties
    description: |
      The properties of the scope map.
    value:
      description: "{{ description }}"
      type: "{{ type }}"
      creationDate: "{{ creationDate }}"
      provisioningState: "{{ provisioningState }}"
      actions:
        - "{{ actions }}"

UPDATE examples

update

Updates a scope map with the specified parameters.

UPDATE azure.container_registry.scope_maps
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND scope_map_name = '{{ scope_map_name }}' --required
AND subscription_id = '{{ subscription_id }}' --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 resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND scope_map_name = '{{ scope_map_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;