replication_vault_settings

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

Overview

Name	replication_vault_settings
Type	Resource
Id	azure.recovery_services_site_recovery.replication_vault_settings

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

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The vault setting 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, vaultSettingName	api-version	Gets the vault setting. This includes the Migration Hub connection settings.
list	select	resourceName, resourceGroupName, subscriptionId	api-version	Gets the list of vault setting. This includes the Migration Hub connection settings.
create	insert	resourceName, resourceGroupName, subscriptionId, vaultSettingName, data__properties	api-version	The operation to configure vault setting.

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
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.
vaultSettingName	string	Vault setting name.
api-version	string	Client Api Version.

SELECT examples

get

Gets the vault setting. This includes the Migration Hub connection settings.

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

list

Gets the list of vault setting. This includes the Migration Hub connection settings.

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

INSERT examples

create

The operation to configure vault setting.

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

Manifest

# Description fields are for documentation purposes
- name: replication_vault_settings
  props:
    - name: resourceName
      value: string
      description: Required parameter for the replication_vault_settings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_vault_settings resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_vault_settings resource.
    - name: vaultSettingName
      value: string
      description: Required parameter for the replication_vault_settings resource.
    - name: properties
      value: object
      description: |
        Vault setting creation input properties.
    - name: api-version
      value: string
      description: Client Api Version.