replication_extensions

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

Overview

Name	replication_extensions
Type	Resource
Id	azure.data_replication.replication_extensions

Fields

The following fields are returned by SELECT queries:

get

Returns Replication extension Model on success.

Name	Datatype	Description
id	string	Gets or sets the Id of the resource.
name	string	Gets or sets the name of the resource.
properties	object	Replication extension model properties.
systemData	object	System data required to be defined for Azure resources.
type	string	Gets or sets the type of the resource.

list

Returns Replication extension Model Collection on success.

Name	Datatype	Description
id	string	Gets or sets the Id of the resource.
name	string	Gets or sets the name of the resource.
properties	object	Replication extension model properties.
systemData	object	System data required to be defined for Azure resources.
type	string	Gets or sets the type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName, replicationExtensionName		Gets the details of the replication extension.
list	select	subscriptionId, resourceGroupName, vaultName		Gets the list of replication extensions in the given vault.
create	insert	subscriptionId, resourceGroupName, vaultName, replicationExtensionName, data__properties		Creates the replication extension in the given vault.
delete	delete	subscriptionId, resourceGroupName, vaultName, replicationExtensionName		Deletes the replication extension in the given 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
replicationExtensionName	string	The replication extension name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vaultName	string	The vault name.

SELECT examples

get

Gets the details of the replication extension.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_replication.replication_extensions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND replicationExtensionName = '{{ replicationExtensionName }}' -- required
;

list

Gets the list of replication extensions in the given vault.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_replication.replication_extensions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

INSERT examples

create

Creates the replication extension in the given vault.

INSERT INTO azure.data_replication.replication_extensions (
data__properties,
subscriptionId,
resourceGroupName,
vaultName,
replicationExtensionName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}',
'{{ replicationExtensionName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_extensions
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the replication_extensions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_extensions resource.
    - name: vaultName
      value: string
      description: Required parameter for the replication_extensions resource.
    - name: replicationExtensionName
      value: string
      description: Required parameter for the replication_extensions resource.
    - name: properties
      value: object
      description: |
        Replication extension model properties.

DELETE examples

delete

Deletes the replication extension in the given vault.

DELETE FROM azure.data_replication.replication_extensions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
AND replicationExtensionName = '{{ replicationExtensionName }}' --required
;