web_pub_sub

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

Overview

Name	web_pub_sub
Type	Resource
Id	azure.web_pubsub.web_pub_sub

Fields

The following fields are returned by SELECT queries:

list_replica_skus

Name	Datatype	Description
capacity	object	Describes scaling information of a sku.
resourceType	string	The resource type that this object applies to.
sku	object	The billing information of the resource.

check_name_availability

Name	Datatype	Description
message	string	The message of the operation.
nameAvailable	boolean	Indicates whether the name is available or not.
reason	string	The reason of the availability. Required if name is not available.

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.
disableAadAuth	boolean	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
disableLocalAuth	boolean	DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
externalIP	string	The publicly accessible IP of the resource.
hostName	string	FQDN of the service instance.
hostNamePrefix	string	Deprecated.
identity	object	A class represent managed identities used for request and response.
kind	string	The kind of the service. Known values are: "WebPubSub" and "SocketIO".
liveTraceConfiguration	object	Live trace configuration of a Microsoft.SignalRService resource.
location	string	The geo-location where the resource lives. Required.
networkACLs	object	Network ACLs for the resource.
privateEndpointConnections	array	Private endpoint connections to the resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
publicNetworkAccess	string	Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
publicPort	integer	The publicly accessible port of the resource which is designed for browser/client side usage.
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. This property is replica specific. Disable the regional endpoint without replica is not allowed.
resourceLogConfiguration	object	Resource log configuration of a Microsoft.SignalRService resource.
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.
serverPort	integer	The publicly accessible port of the resource which is designed for customer server side usage.
sharedPrivateLinkResources	array	The list of shared private link resources.
sku	object	The billing information of the resource.
socketIO	object	SocketIO settings for the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tls	object	TLS settings for the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the resource. Probably you need the same or higher version of client SDKs.

list_by_resource_group

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.
disableAadAuth	boolean	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
disableLocalAuth	boolean	DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
externalIP	string	The publicly accessible IP of the resource.
hostName	string	FQDN of the service instance.
hostNamePrefix	string	Deprecated.
identity	object	A class represent managed identities used for request and response.
kind	string	The kind of the service. Known values are: "WebPubSub" and "SocketIO".
liveTraceConfiguration	object	Live trace configuration of a Microsoft.SignalRService resource.
location	string	The geo-location where the resource lives. Required.
networkACLs	object	Network ACLs for the resource.
privateEndpointConnections	array	Private endpoint connections to the resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
publicNetworkAccess	string	Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
publicPort	integer	The publicly accessible port of the resource which is designed for browser/client side usage.
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. This property is replica specific. Disable the regional endpoint without replica is not allowed.
resourceLogConfiguration	object	Resource log configuration of a Microsoft.SignalRService resource.
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.
serverPort	integer	The publicly accessible port of the resource which is designed for customer server side usage.
sharedPrivateLinkResources	array	The list of shared private link resources.
sku	object	The billing information of the resource.
socketIO	object	SocketIO settings for the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tls	object	TLS settings for the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the resource. Probably you need the same or higher version of client SDKs.

list_by_subscription

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.
disableAadAuth	boolean	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
disableLocalAuth	boolean	DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
externalIP	string	The publicly accessible IP of the resource.
hostName	string	FQDN of the service instance.
hostNamePrefix	string	Deprecated.
identity	object	A class represent managed identities used for request and response.
kind	string	The kind of the service. Known values are: "WebPubSub" and "SocketIO".
liveTraceConfiguration	object	Live trace configuration of a Microsoft.SignalRService resource.
location	string	The geo-location where the resource lives. Required.
networkACLs	object	Network ACLs for the resource.
privateEndpointConnections	array	Private endpoint connections to the resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
publicNetworkAccess	string	Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
publicPort	integer	The publicly accessible port of the resource which is designed for browser/client side usage.
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. This property is replica specific. Disable the regional endpoint without replica is not allowed.
resourceLogConfiguration	object	Resource log configuration of a Microsoft.SignalRService resource.
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.
serverPort	integer	The publicly accessible port of the resource which is designed for customer server side usage.
sharedPrivateLinkResources	array	The list of shared private link resources.
sku	object	The billing information of the resource.
socketIO	object	SocketIO settings for the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tls	object	TLS settings for the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the resource. Probably you need the same or higher version of client SDKs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_replica_skus	select	resource_group_name, resource_name, replica_name, subscription_id		List all available skus of the replica resource.
check_name_availability	select	location, subscription_id		Checks that the resource name is valid and is not already in use.
get	select	resource_group_name, resource_name, subscription_id		Get the resource and its properties.
list_by_resource_group	select	resource_group_name, subscription_id		Handles requests to list all resources in a resource group.
list_by_subscription	select	subscription_id		Handles requests to list all resources in a subscription.
create_or_update	insert	resource_group_name, resource_name, subscription_id, location		Create or update a resource.
update	update	resource_group_name, resource_name, subscription_id, location		Operation to update an exiting resource.
create_or_update	replace	resource_group_name, resource_name, subscription_id, location		Create or update a resource.
delete	delete	resource_group_name, resource_name, subscription_id		Operation to delete a resource.
list_keys	exec	resource_group_name, resource_name, subscription_id		Get the access keys of the resource.
list_skus	exec	resource_group_name, resource_name, subscription_id		List all available skus of the resource.
regenerate_key	exec	resource_group_name, resource_name, subscription_id		Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
restart	exec	resource_group_name, resource_name, subscription_id		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. Required.
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

list_replica_skus

List all available skus of the replica resource.

SELECT
capacity,
resourceType,
sku
FROM azure.web_pubsub.web_pub_sub
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
;

check_name_availability

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

SELECT
message,
nameAvailable,
reason
FROM azure.web_pubsub.web_pub_sub
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get the resource and its properties.

SELECT
id,
name,
disableAadAuth,
disableLocalAuth,
externalIP,
hostName,
hostNamePrefix,
identity,
kind,
liveTraceConfiguration,
location,
networkACLs,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
publicPort,
regionEndpointEnabled,
resourceLogConfiguration,
resourceStopped,
serverPort,
sharedPrivateLinkResources,
sku,
socketIO,
systemData,
tags,
tls,
type,
version
FROM azure.web_pubsub.web_pub_sub
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Handles requests to list all resources in a resource group.

SELECT
id,
name,
disableAadAuth,
disableLocalAuth,
externalIP,
hostName,
hostNamePrefix,
identity,
kind,
liveTraceConfiguration,
location,
networkACLs,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
publicPort,
regionEndpointEnabled,
resourceLogConfiguration,
resourceStopped,
serverPort,
sharedPrivateLinkResources,
sku,
socketIO,
systemData,
tags,
tls,
type,
version
FROM azure.web_pubsub.web_pub_sub
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Handles requests to list all resources in a subscription.

SELECT
id,
name,
disableAadAuth,
disableLocalAuth,
externalIP,
hostName,
hostNamePrefix,
identity,
kind,
liveTraceConfiguration,
location,
networkACLs,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
publicPort,
regionEndpointEnabled,
resourceLogConfiguration,
resourceStopped,
serverPort,
sharedPrivateLinkResources,
sku,
socketIO,
systemData,
tags,
tls,
type,
version
FROM azure.web_pubsub.web_pub_sub
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a resource.

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

Manifest

# Description fields are for documentation purposes
- name: web_pub_sub
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the web_pub_sub resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the web_pub_sub resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the web_pub_sub 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: kind
    value: "{{ kind }}"
    description: |
      The kind of the service. Known values are: "WebPubSub" and "SocketIO".
  - name: identity
    description: |
      A class represent managed identities used for request and response.
    value:
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
  - name: properties
    value:
      tls:
        clientCertEnabled: {{ clientCertEnabled }}
      liveTraceConfiguration:
        enabled: "{{ enabled }}"
        categories:
          - name: "{{ name }}"
            enabled: "{{ enabled }}"
      resourceLogConfiguration:
        categories:
          - name: "{{ name }}"
            enabled: "{{ enabled }}"
      networkACLs:
        defaultAction: "{{ defaultAction }}"
        publicNetwork:
          allow:
            - "{{ allow }}"
          deny:
            - "{{ deny }}"
        privateEndpoints:
          - allow: "{{ allow }}"
            deny: "{{ deny }}"
            name: "{{ name }}"
        ipRules:
          - value: "{{ value }}"
            action: "{{ action }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      disableLocalAuth: {{ disableLocalAuth }}
      disableAadAuth: {{ disableAadAuth }}
      regionEndpointEnabled: "{{ regionEndpointEnabled }}"
      resourceStopped: "{{ resourceStopped }}"
      socketIO:
        serviceMode: "{{ serviceMode }}"

UPDATE examples

update

Operation to update an exiting resource.

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

REPLACE examples

create_or_update

Create or update a resource.

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

DELETE examples

delete

Operation to delete a resource.

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

Lifecycle Methods

list_keys

Get the access keys of the resource.

EXEC azure.web_pubsub.web_pub_sub.list_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_skus

List all available skus of the resource.

EXEC azure.web_pubsub.web_pub_sub.list_skus 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

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_sub.regenerate_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;

restart

Operation to restart a resource.

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