replication_vault_setting

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

Overview

Name	replication_vault_setting
Type	Resource
Id	azure.recovery_services_site_recovery.replication_vault_setting

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.
location	string	Resource Location.
migrationSolutionId	string	The migration solution ARM Id.
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".
vmwareToAzureProviderType	string	VMware to Azure provider type.

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.
location	string	Resource Location.
migrationSolutionId	string	The migration solution ARM Id.
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".
vmwareToAzureProviderType	string	VMware to Azure provider type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, vault_setting_name, subscription_id		Gets the vault setting. Gets the vault setting. This includes the Migration Hub connection settings.
list	select	resource_group_name, resource_name, subscription_id		Gets the list of vault setting. Gets the list of vault setting. This includes the Migration Hub connection settings.
create	insert	resource_group_name, resource_name, vault_setting_name, subscription_id, properties		Updates vault setting. A vault setting object is a singleton per vault and it is always present by default. 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
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
vault_setting_name	string	Vault setting name. Required.

SELECT examples

get

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

SELECT
id,
name,
location,
migrationSolutionId,
systemData,
type,
vmwareToAzureProviderType
FROM azure.recovery_services_site_recovery.replication_vault_setting
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND vault_setting_name = '{{ vault_setting_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
location,
migrationSolutionId,
systemData,
type,
vmwareToAzureProviderType
FROM azure.recovery_services_site_recovery.replication_vault_setting
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Updates vault setting. A vault setting object is a singleton per vault and it is always present by default. The operation to configure vault setting.

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

Manifest

# Description fields are for documentation purposes
- name: replication_vault_setting
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_vault_setting resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_vault_setting resource.
  - name: vault_setting_name
    value: "{{ vault_setting_name }}"
    description: Required parameter for the replication_vault_setting resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_vault_setting resource.
  - name: properties
    description: |
      Vault setting creation input properties. Required.
    value:
      migrationSolutionId: "{{ migrationSolutionId }}"
      vmwareToAzureProviderType: "{{ vmwareToAzureProviderType }}"