web_pub_subs

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

Overview

Name	web_pub_subs
Type	Resource
Id	azure.web_pubsub.web_pub_subs

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding resource.

Name	Datatype	Description
identity	object	A class represent managed identities used for request and response
kind	string	The kind of the service
location	string	The geo-location where the resource lives
properties	object	A class that describes the properties of the resource
sku	object	The billing information of the resource.
tags	object	Resource tags.

list_by_resource_group

Success. The response describes the list of resources in a resourceGroup.

Name	Datatype	Description
identity	object	A class represent managed identities used for request and response
kind	string	The kind of the service
location	string	The geo-location where the resource lives
properties	object	A class that describes the properties of the resource
sku	object	The billing information of the resource.
tags	object	Resource tags.

list_by_subscription

Success. The response describes the list of resources in the subscription.

Name	Datatype	Description
identity	object	A class represent managed identities used for request and response
kind	string	The kind of the service
location	string	The geo-location where the resource lives
properties	object	A class that describes the properties of the resource
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		Get the resource and its properties.
list_by_resource_group	select	subscriptionId, resourceGroupName		Handles requests to list all resources in a resource group.
list_by_subscription	select	subscriptionId		Handles requests to list all resources in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName		Create or update a resource.
update	update	subscriptionId, resourceGroupName, resourceName		Operation to update an exiting resource.
delete	delete	subscriptionId, resourceGroupName, resourceName		Operation to delete a resource.
check_name_availability	exec	location, subscriptionId, name, type		Checks that the resource name is valid and is not already in use.
regenerate_key	exec	subscriptionId, resourceGroupName, resourceName		Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
restart	exec	subscriptionId, resourceGroupName, resourceName		Operation to restart a resource.

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
location	string	the region
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 resource and its properties.

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

list_by_resource_group

Handles requests to list all resources in a resource group.

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

list_by_subscription

Handles requests to list all resources in a subscription.

SELECT
identity,
kind,
location,
properties,
sku,
tags
FROM azure.web_pubsub.web_pub_subs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update a resource.

INSERT INTO azure.web_pubsub.web_pub_subs (
data__tags,
data__location,
data__sku,
data__properties,
data__kind,
data__identity,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ sku }}',
'{{ properties }}',
'{{ kind }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
identity,
kind,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: web_pub_subs
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the web_pub_subs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the web_pub_subs resource.
    - name: resourceName
      value: string
      description: Required parameter for the web_pub_subs 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
      description: |
        A class that describes the properties of the resource
    - name: kind
      value: string
      description: |
        The kind of the service
      valid_values: ['WebPubSub', 'SocketIO']
    - name: identity
      value: object
      description: |
        A class represent managed identities used for request and response

UPDATE examples

update

Operation to update an exiting resource.

UPDATE azure.web_pubsub.web_pub_subs
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__sku = '{{ sku }}',
data__properties = '{{ properties }}',
data__kind = '{{ kind }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
identity,
kind,
location,
properties,
sku,
tags;

DELETE examples

delete

Operation to delete a resource.

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

Lifecycle Methods

check_name_availability

Checks that the resource name is valid and is not already in use.

EXEC azure.web_pubsub.web_pub_subs.check_name_availability 
@location='{{ location }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"type": "{{ type }}", 
"name": "{{ name }}"
}'
;

regenerate_key

Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

EXEC azure.web_pubsub.web_pub_subs.regenerate_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;

restart

Operation to restart a resource.

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