replication_protection_intents

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

Overview

Name	replication_protection_intents
Type	Resource
Id	azure.recovery_services_site_recovery.replication_protection_intents

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.
creationTimeUTC	string	The creation time in UTC.
friendlyName	string	The name.
isActive	boolean	A value indicating whether the intent object is active.
jobId	string	The job Id.
jobState	string	The job state.
location	string	Resource Location.
providerSpecificDetails	object	The Replication provider custom settings.
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 resource.
creationTimeUTC	string	The creation time in UTC.
friendlyName	string	The name.
isActive	boolean	A value indicating whether the intent object is active.
jobId	string	The job Id.
jobState	string	The job state.
location	string	Resource Location.
providerSpecificDetails	object	The Replication provider custom settings.
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, resource_name, intent_object_name, subscription_id		Gets the details of a Replication protection intent item. Gets the details of an ASR replication protection intent.
list	select	resource_group_name, resource_name, subscription_id	skipToken, takeToken	Gets the list of replication protection intent objects. Gets the list of ASR replication protection intent objects in the vault.
create	insert	resource_group_name, resource_name, intent_object_name, subscription_id		Create protection intent Resource. The operation to create an ASR replication protection intent 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
intent_object_name	string	Replication protection intent name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Vault. Required.
subscription_id	string
skipToken	string	The pagination token. Default value is None.
takeToken	string	The page size. Default value is None.

SELECT examples

get

Gets the details of a Replication protection intent item. Gets the details of an ASR replication protection intent.

SELECT
id,
name,
creationTimeUTC,
friendlyName,
isActive,
jobId,
jobState,
location,
providerSpecificDetails,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_protection_intents
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND intent_object_name = '{{ intent_object_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of replication protection intent objects. Gets the list of ASR replication protection intent objects in the vault.

SELECT
id,
name,
creationTimeUTC,
friendlyName,
isActive,
jobId,
jobState,
location,
providerSpecificDetails,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_protection_intents
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND skipToken = '{{ skipToken }}'
AND takeToken = '{{ takeToken }}'
;

INSERT examples

create

Create protection intent Resource. The operation to create an ASR replication protection intent item.

INSERT INTO azure.recovery_services_site_recovery.replication_protection_intents (
properties,
resource_group_name,
resource_name,
intent_object_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ intent_object_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_protection_intents
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_protection_intents resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_protection_intents resource.
  - name: intent_object_name
    value: "{{ intent_object_name }}"
    description: Required parameter for the replication_protection_intents resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_protection_intents resource.
  - name: properties
    description: |
      Create protection intent input properties.
    value:
      providerSpecificDetails:
        instanceType: "{{ instanceType }}"