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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowedScenarios	array	The scenarios allowed on this provider.
authenticationIdentityDetails	object	The authentication identity details.
biosId	string	The Bios Id.
connectionStatus	string	A value indicating whether DRA is responsive.
dataPlaneAuthenticationIdentityDetails	object	The data plane authentication identity details.
draIdentifier	string	The DRA Id.
fabricFriendlyName	string	The fabric friendly name.
fabricType	string	Type of the site.
friendlyName	string	Friendly name of the DRA.
healthErrorDetails	array	The recovery services provider health error details.
lastHeartBeat	string (date-time)	Time when last heartbeat was sent by the DRA.
location	string	Resource Location.
machineId	string	The machine Id.
machineName	string	The machine name.
protectedItemCount	integer	Number of protected VMs currently managed by the DRA.
providerVersion	string	The provider version.
providerVersionDetails	object	The provider version details.
providerVersionExpiryDate	string (date-time)	Expiry date of the version.
providerVersionState	string	DRA version status.
resourceAccessIdentityDetails	object	The resource access identity details.
serverVersion	string	The fabric provider.
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_by_replication_fabrics

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.
allowedScenarios	array	The scenarios allowed on this provider.
authenticationIdentityDetails	object	The authentication identity details.
biosId	string	The Bios Id.
connectionStatus	string	A value indicating whether DRA is responsive.
dataPlaneAuthenticationIdentityDetails	object	The data plane authentication identity details.
draIdentifier	string	The DRA Id.
fabricFriendlyName	string	The fabric friendly name.
fabricType	string	Type of the site.
friendlyName	string	Friendly name of the DRA.
healthErrorDetails	array	The recovery services provider health error details.
lastHeartBeat	string (date-time)	Time when last heartbeat was sent by the DRA.
location	string	Resource Location.
machineId	string	The machine Id.
machineName	string	The machine name.
protectedItemCount	integer	Number of protected VMs currently managed by the DRA.
providerVersion	string	The provider version.
providerVersionDetails	object	The provider version details.
providerVersionExpiryDate	string (date-time)	Expiry date of the version.
providerVersionState	string	DRA version status.
resourceAccessIdentityDetails	object	The resource access identity details.
serverVersion	string	The fabric provider.
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.
allowedScenarios	array	The scenarios allowed on this provider.
authenticationIdentityDetails	object	The authentication identity details.
biosId	string	The Bios Id.
connectionStatus	string	A value indicating whether DRA is responsive.
dataPlaneAuthenticationIdentityDetails	object	The data plane authentication identity details.
draIdentifier	string	The DRA Id.
fabricFriendlyName	string	The fabric friendly name.
fabricType	string	Type of the site.
friendlyName	string	Friendly name of the DRA.
healthErrorDetails	array	The recovery services provider health error details.
lastHeartBeat	string (date-time)	Time when last heartbeat was sent by the DRA.
location	string	Resource Location.
machineId	string	The machine Id.
machineName	string	The machine name.
protectedItemCount	integer	Number of protected VMs currently managed by the DRA.
providerVersion	string	The provider version.
providerVersionDetails	object	The provider version details.
providerVersionExpiryDate	string (date-time)	Expiry date of the version.
providerVersionState	string	DRA version status.
resourceAccessIdentityDetails	object	The resource access identity details.
serverVersion	string	The fabric provider.
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, fabric_name, provider_name, subscription_id		Gets the details of a recovery services provider. Gets the details of registered recovery services provider.
list_by_replication_fabrics	select	resource_group_name, resource_name, fabric_name, subscription_id		Gets the list of registered recovery services providers for the fabric. Lists the registered recovery services providers for the specified fabric.
list	select	resource_group_name, resource_name, subscription_id		Gets the list of registered recovery services providers in the vault. This is a view only api. Lists the registered recovery services providers in the vault.
create	insert	resource_group_name, resource_name, fabric_name, provider_name, subscription_id, properties		Adds a recovery services provider. The operation to add a recovery services provider.
delete	delete	resource_group_name, resource_name, fabric_name, provider_name, subscription_id		Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object "deleteRspInput" is used (if the object is empty we assume that it is old client and continue the old behavior). The operation to removes/delete(unregister) a recovery services provider from the vault.
purge	exec	resource_group_name, resource_name, fabric_name, provider_name, subscription_id		Purges recovery service provider from fabric. The operation to purge(force delete) a recovery services provider from the vault.
refresh_provider	exec	resource_group_name, resource_name, fabric_name, provider_name, subscription_id		Refresh details from the recovery services provider. The operation to refresh the information from the recovery services provider.

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
fabric_name	string	Fabric name. Required.
provider_name	string	Recovery services provider 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

SELECT examples

get

Gets the details of a recovery services provider. Gets the details of registered recovery services provider.

SELECT
id,
name,
allowedScenarios,
authenticationIdentityDetails,
biosId,
connectionStatus,
dataPlaneAuthenticationIdentityDetails,
draIdentifier,
fabricFriendlyName,
fabricType,
friendlyName,
healthErrorDetails,
lastHeartBeat,
location,
machineId,
machineName,
protectedItemCount,
providerVersion,
providerVersionDetails,
providerVersionExpiryDate,
providerVersionState,
resourceAccessIdentityDetails,
serverVersion,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_recovery_services_providers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND provider_name = '{{ provider_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_replication_fabrics

Gets the list of registered recovery services providers for the fabric. Lists the registered recovery services providers for the specified fabric.

SELECT
id,
name,
allowedScenarios,
authenticationIdentityDetails,
biosId,
connectionStatus,
dataPlaneAuthenticationIdentityDetails,
draIdentifier,
fabricFriendlyName,
fabricType,
friendlyName,
healthErrorDetails,
lastHeartBeat,
location,
machineId,
machineName,
protectedItemCount,
providerVersion,
providerVersionDetails,
providerVersionExpiryDate,
providerVersionState,
resourceAccessIdentityDetails,
serverVersion,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_recovery_services_providers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of registered recovery services providers in the vault. This is a view only api. Lists the registered recovery services providers in the vault.

SELECT
id,
name,
allowedScenarios,
authenticationIdentityDetails,
biosId,
connectionStatus,
dataPlaneAuthenticationIdentityDetails,
draIdentifier,
fabricFriendlyName,
fabricType,
friendlyName,
healthErrorDetails,
lastHeartBeat,
location,
machineId,
machineName,
protectedItemCount,
providerVersion,
providerVersionDetails,
providerVersionExpiryDate,
providerVersionState,
resourceAccessIdentityDetails,
serverVersion,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_recovery_services_providers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Adds a recovery services provider. The operation to add a recovery services provider.

INSERT INTO azure.recovery_services_site_recovery.replication_recovery_services_providers (
properties,
resource_group_name,
resource_name,
fabric_name,
provider_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ fabric_name }}',
'{{ provider_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_recovery_services_providers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_recovery_services_providers resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_recovery_services_providers resource.
  - name: fabric_name
    value: "{{ fabric_name }}"
    description: Required parameter for the replication_recovery_services_providers resource.
  - name: provider_name
    value: "{{ provider_name }}"
    description: Required parameter for the replication_recovery_services_providers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_recovery_services_providers resource.
  - name: properties
    description: |
      The properties of an add provider request. Required.
    value:
      machineName: "{{ machineName }}"
      machineId: "{{ machineId }}"
      biosId: "{{ biosId }}"
      authenticationIdentityInput:
        tenantId: "{{ tenantId }}"
        applicationId: "{{ applicationId }}"
        objectId: "{{ objectId }}"
        audience: "{{ audience }}"
        aadAuthority: "{{ aadAuthority }}"
      resourceAccessIdentityInput:
        tenantId: "{{ tenantId }}"
        applicationId: "{{ applicationId }}"
        objectId: "{{ objectId }}"
        audience: "{{ audience }}"
        aadAuthority: "{{ aadAuthority }}"
      dataPlaneAuthenticationIdentityInput:
        tenantId: "{{ tenantId }}"
        applicationId: "{{ applicationId }}"
        objectId: "{{ objectId }}"
        audience: "{{ audience }}"
        aadAuthority: "{{ aadAuthority }}"

DELETE examples

delete

Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object "deleteRspInput" is used (if the object is empty we assume that it is old client and continue the old behavior). The operation to removes/delete(unregister) a recovery services provider from the vault.

DELETE FROM azure.recovery_services_site_recovery.replication_recovery_services_providers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND fabric_name = '{{ fabric_name }}' --required
AND provider_name = '{{ provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

purge

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

EXEC azure.recovery_services_site_recovery.replication_recovery_services_providers.purge 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@provider_name='{{ provider_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

refresh_provider

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

EXEC azure.recovery_services_site_recovery.replication_recovery_services_providers.refresh_provider 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@provider_name='{{ provider_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;