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

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.
endpoint	string	The URI of the replica where the replica API will be available.
location	string	The location of the replica.
provisioningState	string	The provisioning state of the replica. Known values are: "Creating", "Succeeded", "Deleting", "Failed", and "Canceled". (Creating, Succeeded, Deleting, Failed, Canceled)
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_configuration_store

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.
endpoint	string	The URI of the replica where the replica API will be available.
location	string	The location of the replica.
provisioningState	string	The provisioning state of the replica. Known values are: "Creating", "Succeeded", "Deleting", "Failed", and "Canceled". (Creating, Succeeded, Deleting, Failed, Canceled)
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, config_store_name, replica_name, subscription_id		Gets the properties of the specified replica.
list_by_configuration_store	select	resource_group_name, config_store_name, subscription_id	$skipToken	Lists the replicas for a given configuration store.
create	insert	resource_group_name, config_store_name, replica_name, subscription_id		Creates a replica with the specified parameters.
delete	delete	resource_group_name, config_store_name, replica_name, subscription_id		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
config_store_name	string	The name of the configuration store. Required.
replica_name	string	The name of the replica. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$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. Default value is None.

SELECT examples

get

Gets the properties of the specified replica.

SELECT
id,
name,
endpoint,
location,
provisioningState,
systemData,
type
FROM azure.app_configuration.replicas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND config_store_name = '{{ config_store_name }}' -- required
AND replica_name = '{{ replica_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_configuration_store

Lists the replicas for a given configuration store.

SELECT
id,
name,
endpoint,
location,
provisioningState,
systemData,
type
FROM azure.app_configuration.replicas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND config_store_name = '{{ config_store_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

Creates a replica with the specified parameters.

INSERT INTO azure.app_configuration.replicas (
properties,
location,
resource_group_name,
config_store_name,
replica_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ resource_group_name }}',
'{{ config_store_name }}',
'{{ replica_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replicas
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replicas resource.
  - name: config_store_name
    value: "{{ config_store_name }}"
    description: Required parameter for the replicas resource.
  - name: replica_name
    value: "{{ replica_name }}"
    description: Required parameter for the replicas resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replicas resource.
  - name: properties
    description: |
      All replica properties.
    value:
      endpoint: "{{ endpoint }}"
      provisioningState: "{{ provisioningState }}"
  - name: location
    value: "{{ location }}"
    description: |
      The location of the replica.

DELETE examples

delete

Deletes a replica.

DELETE FROM azure.app_configuration.replicas
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND config_store_name = '{{ config_store_name }}' --required
AND replica_name = '{{ replica_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;