hubs

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

Overview

Name	hubs
Type	Resource
Id	azure.web_pubsub.hubs

Fields

The following fields are returned by SELECT queries:

get

Success. The response describe the corresponding hub setting.

Name	Datatype	Description
properties	object	Properties of a hub.

list

Success. The response describes hub settings of the resource.

Name	Datatype	Description
properties	object	Properties of a hub.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	hubName, subscriptionId, resourceGroupName, resourceName		Get a hub setting.
list	select	subscriptionId, resourceGroupName, resourceName		List hub settings.
create_or_update	insert	hubName, subscriptionId, resourceGroupName, resourceName, data__properties		Create or update a hub setting.
delete	delete	hubName, subscriptionId, resourceGroupName, resourceName		Delete a hub setting.

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
hubName	string	The hub name.
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 a hub setting.

SELECT
properties
FROM azure.web_pubsub.hubs
WHERE hubName = '{{ hubName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list

List hub settings.

SELECT
properties
FROM azure.web_pubsub.hubs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

INSERT examples

create_or_update

Create or update a hub setting.

INSERT INTO azure.web_pubsub.hubs (
data__properties,
hubName,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ properties }}' /* required */,
'{{ hubName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: hubs
  props:
    - name: hubName
      value: string
      description: Required parameter for the hubs resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the hubs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the hubs resource.
    - name: resourceName
      value: string
      description: Required parameter for the hubs resource.
    - name: properties
      value: object
      description: |
        Properties of a hub.

DELETE examples

delete

Delete a hub setting.

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