protected_items

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

Overview

Name	protected_items
Type	Resource
Id	azure.data_replication.protected_items

Fields

The following fields are returned by SELECT queries:

get

Returns ProtectedItem Model on success.

Name	Datatype	Description
id	string	Gets or sets the Id of the resource.
name	string	Gets or sets the name of the resource.
properties	object	Protected item model properties.
systemData	object	System data required to be defined for Azure resources.
type	string	Gets or sets the type of the resource.

list

Returns ProtectedItem Model Collection on success.

Name	Datatype	Description
id	string	Gets or sets the Id of the resource.
name	string	Gets or sets the name of the resource.
properties	object	Protected item model properties.
systemData	object	System data required to be defined for Azure resources.
type	string	Gets or sets 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, vaultName, protectedItemName		Gets the details of the protected item.
list	select	subscriptionId, resourceGroupName, vaultName		Gets the list of protected items in the given vault.
create	insert	subscriptionId, resourceGroupName, vaultName, protectedItemName, data__properties		Creates the protected item.
delete	delete	subscriptionId, resourceGroupName, vaultName, protectedItemName	forceDelete	Removes the protected item.
planned_failover	exec	subscriptionId, resourceGroupName, vaultName, protectedItemName, properties		Performs the planned failover on the protected item.

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
protectedItemName	string	The protected item name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vaultName	string	The vault name.
forceDelete	boolean	A flag indicating whether to do force delete or not.

SELECT examples

get

Gets the details of the protected item.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_replication.protected_items
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND protectedItemName = '{{ protectedItemName }}' -- required
;

list

Gets the list of protected items in the given vault.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_replication.protected_items
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

INSERT examples

create

Creates the protected item.

INSERT INTO azure.data_replication.protected_items (
data__properties,
subscriptionId,
resourceGroupName,
vaultName,
protectedItemName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}',
'{{ protectedItemName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: protected_items
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the protected_items resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the protected_items resource.
    - name: vaultName
      value: string
      description: Required parameter for the protected_items resource.
    - name: protectedItemName
      value: string
      description: Required parameter for the protected_items resource.
    - name: properties
      value: object
      description: |
        Protected item model properties.

DELETE examples

delete

Removes the protected item.

DELETE FROM azure.data_replication.protected_items
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
AND protectedItemName = '{{ protectedItemName }}' --required
AND forceDelete = '{{ forceDelete }}'
;

Lifecycle Methods

planned_failover

Performs the planned failover on the protected item.

EXEC azure.data_replication.protected_items.planned_failover 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@protectedItemName='{{ protectedItemName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;