replicas

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

Overview

Name	replicas
Type	Resource
Id	azure.web_pubsub.replicas

Fields

vw_replicas

Name	Datatype	Description
location	text	The geo-location where the resource lives
provisioning_state	text	field from the properties object
region_endpoint_enabled	text	field from the properties object
replicaName	text	field from the properties object
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
resource_stopped	text	field from the properties object
sku	text	The billing information of the resource.
subscriptionId	text	field from the properties object
tags	text	Resource tags.

replicas

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

Name	Accessible by	Required Params	Description
get	SELECT	replicaName, resourceGroupName, resourceName, subscriptionId	Get the replica and its properties.
list	SELECT	resourceGroupName, resourceName, subscriptionId	List all replicas belong to this resource
create_or_update	INSERT	replicaName, resourceGroupName, resourceName, subscriptionId	Create or update a replica.
delete	DELETE	replicaName, resourceGroupName, resourceName, subscriptionId	Operation to delete a replica.
update	UPDATE	replicaName, resourceGroupName, resourceName, subscriptionId	Operation to update an exiting replica.
restart	EXEC	replicaName, resourceGroupName, resourceName, subscriptionId	Operation to restart a replica.

SELECT examples

List all replicas belong to this resource

vw_replicas

SELECT
location,
provisioning_state,
region_endpoint_enabled,
replicaName,
resourceGroupName,
resourceName,
resource_stopped,
sku,
subscriptionId,
tags
FROM azure.web_pubsub.vw_replicas
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

replicas

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

INSERT example

Use the following StackQL query and manifest file to create a new replicas resource.

All Properties

/*+ create */
INSERT INTO azure.web_pubsub.replicas (
replicaName,
resourceGroupName,
resourceName,
subscriptionId,
tags,
location,
sku,
properties
)
SELECT 
'{{ replicaName }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ sku }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: []
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: regionEndpointEnabled
          value: string
        - name: resourceStopped
          value: string

UPDATE example

Updates a replicas resource.

/*+ update */
UPDATE azure.web_pubsub.replicas
SET 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
replicaName = '{{ replicaName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified replicas resource.

/*+ delete */
DELETE FROM azure.web_pubsub.replicas
WHERE replicaName = '{{ replicaName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';