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

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
linkIdentifier	string	The consumer link id.
privateEndpoint	object	The resource of private end point.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider.
provisioningState	string	The provisioning state of the application gateway private endpoint connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
linkIdentifier	string	The consumer link id.
privateEndpoint	object	The resource of private end point.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider.
provisioningState	string	The provisioning state of the application gateway private endpoint connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, application_gateway_name, connection_name, subscription_id		Gets the specified private endpoint connection on application gateway.
list	select	resource_group_name, application_gateway_name, subscription_id		Lists all private endpoint connections on an application gateway.
update	update	resource_group_name, application_gateway_name, connection_name, subscription_id		Updates the specified private endpoint connection on application gateway.
delete	delete	resource_group_name, application_gateway_name, connection_name, subscription_id		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
application_gateway_name	string	The name of the application gateway. Required.
connection_name	string	Name of the private endpoint connection on an application gateway. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified private endpoint connection on application gateway.

SELECT
id,
name,
etag,
linkIdentifier,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
type
FROM azure.network.application_gateway_private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND application_gateway_name = '{{ application_gateway_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all private endpoint connections on an application gateway.

SELECT
id,
name,
etag,
linkIdentifier,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
type
FROM azure.network.application_gateway_private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND application_gateway_name = '{{ application_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Updates the specified private endpoint connection on application gateway.

UPDATE azure.network.application_gateway_private_endpoint_connections
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_gateway_name = '{{ application_gateway_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --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 resource_group_name = '{{ resource_group_name }}' --required
AND application_gateway_name = '{{ application_gateway_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;