application_gateway_private_endpoint_connections

Creates, updates, deletes, gets or lists an application_gateway_private_endpoint_connections resource.

Overview

Name	application_gateway_private_endpoint_connections
Type	Resource
Id	azure.network.application_gateway_private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns an application gateway private endpoint connection.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the private endpoint connection on an application gateway.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the application gateway private endpoint connection.
type	string	Type of the resource.

list

Success. The operation returns a list of private endpoint connections on application gateway.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the private endpoint connection on an application gateway.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the application gateway private endpoint connection.
type	string	Type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, applicationGatewayName, connectionName, subscriptionId		Gets the specified private endpoint connection on application gateway.
list	select	resourceGroupName, applicationGatewayName, subscriptionId		Lists all private endpoint connections on an application gateway.
update	replace	resourceGroupName, applicationGatewayName, connectionName, subscriptionId		Updates the specified private endpoint connection on application gateway.
delete	delete	resourceGroupName, applicationGatewayName, connectionName, subscriptionId		Deletes the specified private endpoint connection on application gateway.

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
applicationGatewayName	string	The name of the application gateway.
connectionName	string	The name of the application gateway private endpoint connection.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the specified private endpoint connection on application gateway.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.application_gateway_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND applicationGatewayName = '{{ applicationGatewayName }}' -- required
AND connectionName = '{{ connectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all private endpoint connections on an application gateway.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.application_gateway_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND applicationGatewayName = '{{ applicationGatewayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

REPLACE examples

update

Updates the specified private endpoint connection on application gateway.

REPLACE azure.network.application_gateway_private_endpoint_connections
SET 
data__properties = '{{ properties }}',
data__name = '{{ name }}',
data__id = '{{ id }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND applicationGatewayName = '{{ applicationGatewayName }}' --required
AND connectionName = '{{ connectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes the specified private endpoint connection on application gateway.

DELETE FROM azure.network.application_gateway_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND applicationGatewayName = '{{ applicationGatewayName }}' --required
AND connectionName = '{{ connectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;