encryption_scopes

Creates, updates, deletes, gets or lists an encryption_scopes resource.

Overview

Name	encryption_scopes
Type	Resource
Id	azure.storage.encryption_scopes

Fields

The following fields are returned by SELECT queries:

get

OK -- Get encryption scope operation completed successfully.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Properties of the encryption scope. (x-ms-client-name: EncryptionScopeProperties)
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

OK -- List encryption scopes operation completed successfully.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Properties of the encryption scope. (x-ms-client-name: EncryptionScopeProperties)
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	resourceGroupName, accountName, subscriptionId, encryptionScopeName		Returns the properties for the specified encryption scope.
list	select	resourceGroupName, accountName, subscriptionId	$maxpagesize, $filter, $include	Lists all the encryption scopes available under the specified storage account.
patch	update	resourceGroupName, accountName, subscriptionId, encryptionScopeName		Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.
put	replace	resourceGroupName, accountName, subscriptionId, encryptionScopeName		Synchronously creates or updates an encryption scope under the specified storage account. If an encryption scope is already created and a subsequent request is issued with different properties, the encryption scope properties will be updated per the specified request.

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
accountName	string	The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
encryptionScopeName	string	The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$filter	string	Optional. When specified, only encryption scope names starting with the filter will be listed.
$include	string	Optional, when specified, will list encryption scopes with the specific state. Defaults to All
$maxpagesize	integer (int32)	Optional, specifies the maximum number of encryption scopes that will be included in the list response.

SELECT examples

get

Returns the properties for the specified encryption scope.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.encryption_scopes
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND encryptionScopeName = '{{ encryptionScopeName }}' -- required
;

list

Lists all the encryption scopes available under the specified storage account.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.storage.encryption_scopes
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $maxpagesize = '{{ $maxpagesize }}'
AND $filter = '{{ $filter }}'
AND $include = '{{ $include }}'
;

UPDATE examples

patch

Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.

UPDATE azure.storage.encryption_scopes
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND encryptionScopeName = '{{ encryptionScopeName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

put

Synchronously creates or updates an encryption scope under the specified storage account. If an encryption scope is already created and a subsequent request is issued with different properties, the encryption scope properties will be updated per the specified request.

REPLACE azure.storage.encryption_scopes
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND encryptionScopeName = '{{ encryptionScopeName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;