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

vw_web_pub_subs

Name	Datatype	Description
application_firewall	text	field from the properties object
disable_aad_auth	text	field from the properties object
disable_local_auth	text	field from the properties object
external_ip	text	field from the properties object
host_name	text	field from the properties object
host_name_prefix	text	field from the properties object
identity	text	A class represent managed identities used for request and response
kind	text	The kind of the service
live_trace_configuration	text	field from the properties object
location	text	The geo-location where the resource lives
network_ac_ls	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
public_port	text	field from the properties object
region_endpoint_enabled	text	field from the properties object
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
resource_log_configuration	text	field from the properties object
resource_stopped	text	field from the properties object
server_port	text	field from the properties object
shared_private_link_resources	text	field from the properties object
sku	text	The billing information of the resource.
socket_io	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
tls	text	field from the properties object
version	text	field from the properties object

web_pub_subs

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

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, resourceName, subscriptionId	Get the resource and its properties.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	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	resourceGroupName, resourceName, subscriptionId	Create or update a resource.
delete	DELETE	resourceGroupName, resourceName, subscriptionId	Operation to delete a resource.
update	UPDATE	resourceGroupName, resourceName, subscriptionId	Operation to update an exiting resource.
check_name_availability	EXEC	location, subscriptionId, data__name, data__type	Checks that the resource name is valid and is not already in use.
regenerate_key	EXEC	resourceGroupName, resourceName, subscriptionId	Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
restart	EXEC	resourceGroupName, resourceName, subscriptionId	Operation to restart a resource.

SELECT examples

Handles requests to list all resources in a subscription.

vw_web_pub_subs

SELECT
application_firewall,
disable_aad_auth,
disable_local_auth,
external_ip,
host_name,
host_name_prefix,
identity,
kind,
live_trace_configuration,
location,
network_ac_ls,
private_endpoint_connections,
provisioning_state,
public_network_access,
public_port,
region_endpoint_enabled,
resourceGroupName,
resourceName,
resource_log_configuration,
resource_stopped,
server_port,
shared_private_link_resources,
sku,
socket_io,
subscriptionId,
tags,
tls,
version
FROM azure.web_pubsub.vw_web_pub_subs
WHERE subscriptionId = '{{ subscriptionId }}';

web_pub_subs

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

INSERT example

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

All Properties

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

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: externalIP
          value: string
        - name: hostName
          value: string
        - name: publicPort
          value: integer
        - name: serverPort
          value: integer
        - name: version
          value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: groupIds
                    value:
                      - string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
        - name: sharedPrivateLinkResources
          value:
            - - name: properties
                value:
                  - name: groupId
                    value: string
                  - name: privateLinkResourceId
                    value: string
                  - name: requestMessage
                    value: string
                  - name: fqdns
                    value:
                      - string
                  - name: status
                    value: []
        - name: tls
          value:
            - name: clientCertEnabled
              value: boolean
        - name: hostNamePrefix
          value: string
        - name: liveTraceConfiguration
          value:
            - name: enabled
              value: string
            - name: categories
              value:
                - - name: name
                    value: string
                  - name: enabled
                    value: string
        - name: resourceLogConfiguration
          value:
            - name: categories
              value:
                - - name: name
                    value: string
                  - name: enabled
                    value: string
        - name: networkACLs
          value:
            - name: defaultAction
              value: []
            - name: publicNetwork
              value:
                - name: allow
                  value:
                    - []
                - name: deny
                  value:
                    - []
            - name: privateEndpoints
              value:
                - - name: allow
                    value:
                      - []
                  - name: deny
                    value:
                      - []
                  - name: name
                    value: string
            - name: ipRules
              value:
                - - name: value
                    value: string
        - name: applicationFirewall
          value:
            - name: clientConnectionCountRules
              value:
                - - name: type
                    value: string
        - name: publicNetworkAccess
          value: string
        - name: disableLocalAuth
          value: boolean
        - name: disableAadAuth
          value: boolean
        - name: regionEndpointEnabled
          value: string
        - name: resourceStopped
          value: string
        - name: socketIO
          value:
            - name: serviceMode
              value: string
    - name: kind
      value: []
    - name: identity
      value:
        - name: type
          value: []
        - name: userAssignedIdentities
          value: object
        - name: principalId
          value: string
        - name: tenantId
          value: string

UPDATE example

Updates a web_pub_subs resource.

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

DELETE example

Deletes the specified web_pub_subs resource.

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