replicas

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

Overview

Name	replicas
Type	Resource
Id	azure.app_configuration.replicas

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the replica.
location	string	The location of the replica.
properties	object	All replica properties.
systemData	object	Resource system metadata.
type	string	The type of the resource.

list_by_configuration_store

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the replica.
location	string	The location of the replica.
properties	object	All replica properties.
systemData	object	Resource system metadata.
type	string	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, configStoreName, replicaName		Gets the properties of the specified replica.
list_by_configuration_store	select	subscriptionId, resourceGroupName, configStoreName	$skipToken	Lists the replicas for a given configuration store.
create	insert	subscriptionId, resourceGroupName, configStoreName, replicaName		Creates a replica with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, configStoreName, replicaName		Deletes a replica.

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
configStoreName	string	The name of the configuration store.
replicaName	string	The name of the replica.
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.
$skipToken	string	A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

SELECT examples

get

Gets the properties of the specified replica.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.app_configuration.replicas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND configStoreName = '{{ configStoreName }}' -- required
AND replicaName = '{{ replicaName }}' -- required
;

list_by_configuration_store

Lists the replicas for a given configuration store.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.app_configuration.replicas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND configStoreName = '{{ configStoreName }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

Creates a replica with the specified parameters.

INSERT INTO azure.app_configuration.replicas (
data__location,
subscriptionId,
resourceGroupName,
configStoreName,
replicaName
)
SELECT 
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ configStoreName }}',
'{{ replicaName }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replicas
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the replicas resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replicas resource.
    - name: configStoreName
      value: string
      description: Required parameter for the replicas resource.
    - name: replicaName
      value: string
      description: Required parameter for the replicas resource.
    - name: location
      value: string
      description: |
        The location of the replica.

DELETE examples

delete

Deletes a replica.

DELETE FROM azure.app_configuration.replicas
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND configStoreName = '{{ configStoreName }}' --required
AND replicaName = '{{ replicaName }}' --required
;