replication_vcenters

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

Overview

Name	replication_vcenters
Type	Resource
Id	azure.recovery_services_site_recovery.replication_vcenters

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.
discoveryStatus	string	The VCenter discovery status.
fabricArmResourceName	string	The ARM resource name of the fabric containing this VCenter.
friendlyName	string	Friendly name of the vCenter.
healthErrors	array	The health errors for this VCenter.
infrastructureId	string	The infrastructure Id of vCenter.
internalId	string	VCenter internal ID.
ipAddress	string	The IP address of the vCenter.
lastHeartbeat	string (date-time)	The time when the last heartbeat was received by vCenter.
location	string	Resource Location.
port	string	The port number for discovery.
processServerId	string	The process server Id.
runAsAccountId	string	The account Id which has privileges to discover the vCenter.
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.
discoveryStatus	string	The VCenter discovery status.
fabricArmResourceName	string	The ARM resource name of the fabric containing this VCenter.
friendlyName	string	Friendly name of the vCenter.
healthErrors	array	The health errors for this VCenter.
infrastructureId	string	The infrastructure Id of vCenter.
internalId	string	VCenter internal ID.
ipAddress	string	The IP address of the vCenter.
lastHeartbeat	string (date-time)	The time when the last heartbeat was received by vCenter.
location	string	Resource Location.
port	string	The port number for discovery.
processServerId	string	The process server Id.
runAsAccountId	string	The account Id which has privileges to discover the vCenter.
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.
discoveryStatus	string	The VCenter discovery status.
fabricArmResourceName	string	The ARM resource name of the fabric containing this VCenter.
friendlyName	string	Friendly name of the vCenter.
healthErrors	array	The health errors for this VCenter.
infrastructureId	string	The infrastructure Id of vCenter.
internalId	string	VCenter internal ID.
ipAddress	string	The IP address of the vCenter.
lastHeartbeat	string (date-time)	The time when the last heartbeat was received by vCenter.
location	string	Resource Location.
port	string	The port number for discovery.
processServerId	string	The process server Id.
runAsAccountId	string	The account Id which has privileges to discover the vCenter.
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, vcenter_name, subscription_id		Gets the details of a vCenter. Gets the details of a registered vCenter server(Add vCenter server).
list_by_replication_fabrics	select	resource_group_name, resource_name, fabric_name, subscription_id		Gets the list of vCenter registered under a fabric. Lists the vCenter servers registered in a fabric.
list	select	resource_group_name, resource_name, subscription_id		Gets the list of vCenter registered under the vault. Lists the vCenter servers registered in the vault.
create	insert	resource_group_name, resource_name, fabric_name, vcenter_name, subscription_id		Add vCenter. The operation to create a vCenter object..
update	update	resource_group_name, resource_name, fabric_name, vcenter_name, subscription_id		Update vCenter operation. The operation to update a registered vCenter.
delete	delete	resource_group_name, resource_name, fabric_name, vcenter_name, subscription_id		Remove vcenter operation. 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
fabric_name	string	Fabric 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
vcenter_name	string	vcenter name. Required.

SELECT examples

get

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

SELECT
id,
name,
discoveryStatus,
fabricArmResourceName,
friendlyName,
healthErrors,
infrastructureId,
internalId,
ipAddress,
lastHeartbeat,
location,
port,
processServerId,
runAsAccountId,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_vcenters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND vcenter_name = '{{ vcenter_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_replication_fabrics

Gets the list of vCenter registered under a fabric. Lists the vCenter servers registered in a fabric.

SELECT
id,
name,
discoveryStatus,
fabricArmResourceName,
friendlyName,
healthErrors,
infrastructureId,
internalId,
ipAddress,
lastHeartbeat,
location,
port,
processServerId,
runAsAccountId,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_vcenters
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 vCenter registered under the vault. Lists the vCenter servers registered in the vault.

SELECT
id,
name,
discoveryStatus,
fabricArmResourceName,
friendlyName,
healthErrors,
infrastructureId,
internalId,
ipAddress,
lastHeartbeat,
location,
port,
processServerId,
runAsAccountId,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_vcenters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Add vCenter. The operation to create a vCenter object..

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

Manifest

# Description fields are for documentation purposes
- name: replication_vcenters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_vcenters resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_vcenters resource.
  - name: fabric_name
    value: "{{ fabric_name }}"
    description: Required parameter for the replication_vcenters resource.
  - name: vcenter_name
    value: "{{ vcenter_name }}"
    description: Required parameter for the replication_vcenters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_vcenters resource.
  - name: properties
    description: |
      The properties of an add vCenter request.
    value:
      friendlyName: "{{ friendlyName }}"
      ipAddress: "{{ ipAddress }}"
      processServerId: "{{ processServerId }}"
      port: "{{ port }}"
      runAsAccountId: "{{ runAsAccountId }}"

UPDATE examples

update

Update vCenter operation. The operation to update a registered vCenter.

UPDATE azure.recovery_services_site_recovery.replication_vcenters
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND fabric_name = '{{ fabric_name }}' --required
AND vcenter_name = '{{ vcenter_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

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

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