web_pub_sub_private_endpoint_connections

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

Overview

Name	web_pub_sub_private_endpoint_connections
Type	Resource
Id	azure.web_pubsub.web_pub_sub_private_endpoint_connections

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.
groupIds	array	Group IDs.
privateEndpoint	object	Private endpoint.
privateLinkServiceConnectionState	object	Connection state of the private endpoint connection.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
groupIds	array	Group IDs.
privateEndpoint	object	Private endpoint.
privateLinkServiceConnectionState	object	Connection state of the private endpoint connection.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	private_endpoint_connection_name, resource_group_name, resource_name, subscription_id		Get the specified private endpoint connection.
list	select	resource_group_name, resource_name, subscription_id		List private endpoint connections.
update	update	private_endpoint_connection_name, resource_group_name, resource_name, subscription_id		Update the state of specified private endpoint connection.
delete	delete	private_endpoint_connection_name, resource_group_name, resource_name, subscription_id		Delete the specified private endpoint connection.

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
private_endpoint_connection_name	string	The name of the private endpoint connection associated with the Azure resource. 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 specified private endpoint connection.

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.web_pubsub.web_pub_sub_private_endpoint_connections
WHERE private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List private endpoint connections.

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.web_pubsub.web_pub_sub_private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Update the state of specified private endpoint connection.

UPDATE azure.web_pubsub.web_pub_sub_private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the specified private endpoint connection.

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