replicas

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

Overview

Name	replicas
Type	Resource
Id	azure.web_pubsub.replicas

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding replica.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object
sku	object	The billing information of the resource.
tags	object	Resource tags.

list

Success. The response describes replicas of the resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object
sku	object	The billing information of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, replicaName		Get the replica and its properties.
list	select	subscriptionId, resourceGroupName, resourceName		List all replicas belong to this resource
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, replicaName		Create or update a replica.
update	update	subscriptionId, resourceGroupName, resourceName, replicaName		Operation to update an exiting replica.
delete	delete	subscriptionId, resourceGroupName, resourceName, replicaName		Operation to delete a replica.
restart	exec	subscriptionId, resourceGroupName, resourceName, replicaName		Operation to restart 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
replicaName	string	The name of the replica.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get the replica and its properties.

SELECT
location,
properties,
sku,
tags
FROM azure.web_pubsub.replicas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND replicaName = '{{ replicaName }}' -- required
;

list

List all replicas belong to this resource

SELECT
location,
properties,
sku,
tags
FROM azure.web_pubsub.replicas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

INSERT examples

create_or_update

Create or update a replica.

INSERT INTO azure.web_pubsub.replicas (
data__tags,
data__location,
data__sku,
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
replicaName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ sku }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ replicaName }}'
RETURNING
location,
properties,
sku,
tags
;

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: resourceName
      value: string
      description: Required parameter for the replicas resource.
    - name: replicaName
      value: string
      description: Required parameter for the replicas resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: sku
      value: object
      description: |
        The billing information of the resource.
    - name: properties
      value: object

UPDATE examples

update

Operation to update an exiting replica.

UPDATE azure.web_pubsub.replicas
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__sku = '{{ sku }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND replicaName = '{{ replicaName }}' --required
RETURNING
location,
properties,
sku,
tags;

DELETE examples

delete

Operation to delete a replica.

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

Lifecycle Methods

restart

Operation to restart a replica.

EXEC azure.web_pubsub.replicas.restart 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required, 
@replicaName='{{ replicaName }}' --required
;