backup_resource_vault_configs

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

Overview

Name	backup_resource_vault_configs
Type	Resource
Id	azure.recovery_services_backup.backup_resource_vault_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.
enhancedSecurityState	string	Enabled or Disabled. Known values are: "Invalid", "Enabled", and "Disabled". (Invalid, Enabled, Disabled)
isSoftDeleteFeatureStateEditable	boolean	This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault.
location	string	The geo-location where the resource lives.
resourceGuardOperationRequests	array	ResourceGuard Operation Requests.
softDeleteFeatureState	string	Soft Delete feature state. Known values are: "Invalid", "Enabled", "Disabled", and "AlwaysON". (Invalid, Enabled, Disabled, AlwaysON)
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days.
storageModelType	string	Storage type. Known values are: "Invalid", "GeoRedundant", "LocallyRedundant", "ZoneRedundant", and "ReadAccessGeoZoneRedundant". (Invalid, GeoRedundant, LocallyRedundant, ZoneRedundant, ReadAccessGeoZoneRedundant)
storageType	string	Storage type. Known values are: "Invalid", "GeoRedundant", "LocallyRedundant", "ZoneRedundant", and "ReadAccessGeoZoneRedundant". (Invalid, GeoRedundant, LocallyRedundant, ZoneRedundant, ReadAccessGeoZoneRedundant)
storageTypeState	string	Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. Known values are: "Invalid", "Locked", and "Unlocked". (Invalid, Locked, Unlocked)
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".

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 resource vault config.
update	update	vault_name, resource_group_name, subscription_id	x-ms-authorization-auxiliary	Updates vault security config.
put	exec	vault_name, resource_group_name, subscription_id	x-ms-authorization-auxiliary	Updates vault security 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.
x-ms-authorization-auxiliary	string	Default value is None.

SELECT examples

get

Fetches resource vault config.

SELECT
id,
name,
eTag,
enhancedSecurityState,
isSoftDeleteFeatureStateEditable,
location,
resourceGuardOperationRequests,
softDeleteFeatureState,
softDeleteRetentionPeriodInDays,
storageModelType,
storageType,
storageTypeState,
systemData,
tags,
type
FROM azure.recovery_services_backup.backup_resource_vault_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 security config.

UPDATE azure.recovery_services_backup.backup_resource_vault_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
AND x-ms-authorization-auxiliary = '{{ x-ms-authorization-auxiliary}}'
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type;

Lifecycle Methods

put

Updates vault security config.

EXEC azure.recovery_services_backup.backup_resource_vault_configs.put 
@vault_name='{{ vault_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}' 
@@json=
'{
"properties": "{{ properties }}", 
"tags": "{{ tags }}", 
"location": "{{ location }}", 
"eTag": "{{ eTag }}"
}'
;