backup_resource_encryption_configs

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

Overview

Name	backup_resource_encryption_configs
Type	Resource
Id	azure.recovery_services_backup.backup_resource_encryption_configs

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 resource.
eTag	string	Optional ETag.
encryptionAtRestType	string	Encryption At Rest Type. Known values are: "Invalid", "MicrosoftManaged", and "CustomerManaged". (Invalid, MicrosoftManaged, CustomerManaged)
infrastructureEncryptionState	string	Known values are: "Invalid", "Disabled", and "Enabled". (Invalid, Disabled, Enabled)
keyUri	string	Key Vault Key URI.
lastUpdateStatus	string	Known values are: "Invalid", "NotEnabled", "PartiallySucceeded", "PartiallyFailed", "Failed", "Succeeded", "Initialized", and "FirstInitialization". (Invalid, NotEnabled, PartiallySucceeded, PartiallyFailed, Failed, Succeeded, Initialized, FirstInitialization)
location	string	The geo-location where the resource lives.
subscriptionId	string	Key Vault Subscription Id.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
useSystemAssignedIdentity	boolean	bool to indicate whether to use system Assigned Identity or not.
userAssignedIdentity	string	User Assigned Identity Id.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	vault_name, resource_group_name, subscription_id		Fetches Vault Encryption config.
update	update	vault_name, resource_group_name, subscription_id		Updates Vault encryption config.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The name of the VaultResource. Required.

SELECT examples

get

Fetches Vault Encryption config.

SELECT
id,
name,
eTag,
encryptionAtRestType,
infrastructureEncryptionState,
keyUri,
lastUpdateStatus,
location,
subscriptionId,
systemData,
tags,
type,
useSystemAssignedIdentity,
userAssignedIdentity
FROM azure.recovery_services_backup.backup_resource_encryption_configs
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Updates Vault encryption config.

UPDATE azure.recovery_services_backup.backup_resource_encryption_configs
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}',
eTag = '{{ eTag }}'
WHERE 
vault_name = '{{ vault_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required;