replicationv_center

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

Overview

Name	replicationv_center
Type	Resource
Id	azure.recovery_services_site_recovery.replicationv_center

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	VCenter related data.
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	VCenter related data.
type	string	Resource Type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	VCenter related 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, fabricName, vcenterName	api-version	Gets the details of a registered vCenter server(Add vCenter server).
list_by_replication_fabrics	select	resourceName, resourceGroupName, subscriptionId, fabricName	api-version	Lists the vCenter servers registered in a fabric.
list	select	resourceName, resourceGroupName, subscriptionId	api-version	Lists the vCenter servers registered in the vault.
create	insert	resourceName, resourceGroupName, subscriptionId, fabricName, vcenterName	api-version	The operation to create a vCenter object..
update	update	resourceName, resourceGroupName, subscriptionId, fabricName, vcenterName	api-version	The operation to update a registered vCenter.
delete	delete	resourceName, resourceGroupName, subscriptionId, fabricName, vcenterName	api-version	The operation to remove(unregister) a registered vCenter server 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.
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.
vcenterName	string	vcenter name.
api-version	string	Client Api Version.

SELECT examples

get

Gets the details of a registered vCenter server(Add vCenter server).

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

list_by_replication_fabrics

Lists the vCenter servers registered in a fabric.

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

list

Lists the vCenter servers registered in the vault.

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

INSERT examples

create

The operation to create a vCenter object..

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

Manifest

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

UPDATE examples

update

The operation to update a registered vCenter.

UPDATE azure.recovery_services_site_recovery.replicationv_center
SET 
data__properties = '{{ properties }}'
WHERE 
resourceName = '{{ resourceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND fabricName = '{{ fabricName }}' --required
AND vcenterName = '{{ vcenterName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
type;

DELETE examples

delete

The operation to remove(unregister) a registered vCenter server from the vault.

DELETE FROM azure.recovery_services_site_recovery.replicationv_center
WHERE resourceName = '{{ resourceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND fabricName = '{{ fabricName }}' --required
AND vcenterName = '{{ vcenterName }}' --required
AND api-version = '{{ api-version }}'
;