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	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
type	string	Resource Type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
type	string	Resource Type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceName, resourceGroupName, subscriptionId, intentObjectName	api-version	Gets the details of an ASR replication protection intent.
list	select	resourceName, resourceGroupName, subscriptionId	api-version, skipToken, takeToken	Gets the list of ASR replication protection intent objects in the vault.
create	insert	resourceName, resourceGroupName, subscriptionId, intentObjectName	api-version	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
intentObjectName	string	A name for the replication protection item.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
resourceName	string	The name of the recovery services vault.
subscriptionId	string	The subscription Id.
api-version	string	Client Api Version.
skipToken	string	The pagination token.
takeToken	string	The page size.

SELECT examples

get

Gets the details of an ASR replication protection intent.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_protection_intents
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND intentObjectName = '{{ intentObjectName }}' -- required
AND api-version = '{{ api-version }}'
;

list

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

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_protection_intents
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND skipToken = '{{ skipToken }}'
AND takeToken = '{{ takeToken }}'
;

INSERT examples

create

The operation to create an ASR replication protection intent item.

INSERT INTO azure.recovery_services_site_recovery.replication_protection_intents (
data__properties,
resourceName,
resourceGroupName,
subscriptionId,
intentObjectName,
api-version
)
SELECT 
'{{ properties }}',
'{{ resourceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ intentObjectName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_protection_intents
  props:
    - name: resourceName
      value: string
      description: Required parameter for the replication_protection_intents resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_protection_intents resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_protection_intents resource.
    - name: intentObjectName
      value: string
      description: Required parameter for the replication_protection_intents resource.
    - name: properties
      value: object
      description: |
        Create protection intent input properties.
    - name: api-version
      value: string
      description: Client Api Version.