private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.web_pubsub.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes a private endpoint connection.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Resource properties.
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

Success. The response describes a list of private endpoint connections.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Resource properties.
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	privateEndpointConnectionName, subscriptionId, resourceGroupName, resourceName		Get the specified private endpoint connection
list	select	subscriptionId, resourceGroupName, resourceName		List private endpoint connections
update	replace	privateEndpointConnectionName, subscriptionId, resourceGroupName, resourceName		Update the state of specified private endpoint connection
delete	delete	privateEndpointConnectionName, subscriptionId, resourceGroupName, resourceName		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
privateEndpointConnectionName	string	The name of the private endpoint connection associated with the Azure resource.
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 specified private endpoint connection

SELECT
id,
name,
properties,
systemData,
type
FROM azure.web_pubsub.private_endpoint_connections
WHERE privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list

List private endpoint connections

SELECT
id,
name,
properties,
systemData,
type
FROM azure.web_pubsub.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

REPLACE examples

update

Update the state of specified private endpoint connection

REPLACE azure.web_pubsub.private_endpoint_connections
SET 
data__properties = '{{ properties }}'
WHERE 
privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the specified private endpoint connection

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