replication_recovery_services_providers

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

Overview

Name	replication_recovery_services_providers
Type	Resource
Id	azure.recovery_services_site_recovery.replication_recovery_services_providers

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	Provider properties.
type	string	Resource Type

list_by_replication_fabrics

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	Provider properties.
type	string	Resource Type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	Provider properties.
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, fabricName, providerName	api-version	Gets the details of registered recovery services provider.
list_by_replication_fabrics	select	resourceName, resourceGroupName, subscriptionId, fabricName	api-version	Lists the registered recovery services providers for the specified fabric.
list	select	resourceName, resourceGroupName, subscriptionId	api-version	Lists the registered recovery services providers in the vault.
create	insert	resourceName, resourceGroupName, subscriptionId, fabricName, providerName, data__properties	api-version	The operation to add a recovery services provider.
purge	exec	resourceName, resourceGroupName, subscriptionId, fabricName, providerName	api-version	The operation to purge(force delete) a recovery services provider from the vault.
refresh_provider	exec	resourceName, resourceGroupName, subscriptionId, fabricName, providerName	api-version	The operation to refresh the information from the recovery services provider.
delete	exec	resourceName, resourceGroupName, subscriptionId, fabricName, providerName	api-version	The operation to removes/delete(unregister) a recovery services provider from the vault.

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
fabricName	string	Fabric name.
providerName	string	Recovery services provider name.
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.

SELECT examples

get

Gets the details of registered recovery services provider.

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

list_by_replication_fabrics

Lists the registered recovery services providers for the specified fabric.

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

list

Lists the registered recovery services providers in the vault.

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

INSERT examples

create

The operation to add a recovery services provider.

INSERT INTO azure.recovery_services_site_recovery.replication_recovery_services_providers (
data__properties,
resourceName,
resourceGroupName,
subscriptionId,
fabricName,
providerName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ fabricName }}',
'{{ providerName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_recovery_services_providers
  props:
    - name: resourceName
      value: string
      description: Required parameter for the replication_recovery_services_providers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_recovery_services_providers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_recovery_services_providers resource.
    - name: fabricName
      value: string
      description: Required parameter for the replication_recovery_services_providers resource.
    - name: providerName
      value: string
      description: Required parameter for the replication_recovery_services_providers resource.
    - name: properties
      value: object
      description: |
        The properties of an add provider request.
    - name: api-version
      value: string
      description: Client Api Version.

Lifecycle Methods

purge

The operation to purge(force delete) a recovery services provider from the vault.

EXEC azure.recovery_services_site_recovery.replication_recovery_services_providers.purge 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@providerName='{{ providerName }}' --required, 
@api-version='{{ api-version }}'
;

refresh_provider

The operation to refresh the information from the recovery services provider.

EXEC azure.recovery_services_site_recovery.replication_recovery_services_providers.refresh_provider 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@providerName='{{ providerName }}' --required, 
@api-version='{{ api-version }}'
;

delete

The operation to removes/delete(unregister) a recovery services provider from the vault.

EXEC azure.recovery_services_site_recovery.replication_recovery_services_providers.delete 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@providerName='{{ providerName }}' --required, 
@api-version='{{ api-version }}'
;