web_pub_sub_replicas

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

Overview

Name	web_pub_sub_replicas
Type	Resource
Id	azure.web_pubsub.web_pub_sub_replicas

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
regionEndpointEnabled	string	Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.
resourceStopped	string	Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started.
sku	object	The billing information of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
regionEndpointEnabled	string	Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.
resourceStopped	string	Stop or start the resource. Default to "false". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started.
sku	object	The billing information of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, resource_name, replica_name, subscription_id		Get the replica and its properties.
list	select	resource_group_name, resource_name, subscription_id		List all replicas belong to this resource.
create_or_update	insert	resource_group_name, resource_name, replica_name, subscription_id, location		Create or update a replica.
update	update	resource_group_name, resource_name, replica_name, subscription_id, location		Operation to update an exiting replica.
create_or_update	replace	resource_group_name, resource_name, replica_name, subscription_id, location		Create or update a replica.
delete	delete	resource_group_name, resource_name, replica_name, subscription_id		Operation to delete a replica.
restart	exec	resource_group_name, resource_name, replica_name, subscription_id		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
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.
resource_name	string	The name of the resource. Required.
subscription_id	string

SELECT examples

get

Get the replica and its properties.

SELECT
id,
name,
location,
provisioningState,
regionEndpointEnabled,
resourceStopped,
sku,
systemData,
tags,
type
FROM azure.web_pubsub.web_pub_sub_replicas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND replica_name = '{{ replica_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all replicas belong to this resource.

SELECT
id,
name,
location,
provisioningState,
regionEndpointEnabled,
resourceStopped,
sku,
systemData,
tags,
type
FROM azure.web_pubsub.web_pub_sub_replicas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a replica.

INSERT INTO azure.web_pubsub.web_pub_sub_replicas (
tags,
location,
sku,
properties,
resource_group_name,
resource_name,
replica_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ sku }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ replica_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: web_pub_sub_replicas
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the web_pub_sub_replicas resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the web_pub_sub_replicas resource.
  - name: replica_name
    value: "{{ replica_name }}"
    description: Required parameter for the web_pub_sub_replicas resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the web_pub_sub_replicas resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: sku
    description: |
      The billing information of the resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}
  - name: properties
    value:
      regionEndpointEnabled: "{{ regionEndpointEnabled }}"
      resourceStopped: "{{ resourceStopped }}"

UPDATE examples

update

Operation to update an exiting replica.

UPDATE azure.web_pubsub.web_pub_sub_replicas
SET 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND replica_name = '{{ replica_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a replica.

REPLACE azure.web_pubsub.web_pub_sub_replicas
SET 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND replica_name = '{{ replica_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Operation to delete a replica.

DELETE FROM azure.web_pubsub.web_pub_sub_replicas
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND replica_name = '{{ replica_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

restart

Operation to restart a replica.

EXEC azure.web_pubsub.web_pub_sub_replicas.restart 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@replica_name='{{ replica_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;