private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.event_grid.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the PrivateEndpointConnection.
type	string	Type of the resource.

list_by_resource

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the PrivateEndpointConnection.
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	subscriptionId, resourceGroupName, parentType, parentName, privateEndpointConnectionName		Get a specific private endpoint connection under a topic, domain, or partner namespace or namespace.
list_by_resource	select	subscriptionId, resourceGroupName, parentType, parentName	$filter, $top	Get all private endpoint connections under a topic, domain, or partner namespace or namespace.
update	replace	subscriptionId, resourceGroupName, parentType, parentName, privateEndpointConnectionName		Update a specific private endpoint connection under a topic, domain or partner namespace.
delete	delete	subscriptionId, resourceGroupName, parentType, parentName, privateEndpointConnectionName		Delete a specific private endpoint connection under a topic, domain, or partner namespace or namespace.

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
parentName	string	The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name).
parentType	string	The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'.
privateEndpointConnectionName	string	The name of the private endpoint connection connection.
resourceGroupName	string	The name of the resource group within the user's subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$filter	string	The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.
$top	integer (int32)	The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

SELECT examples

get

Get a specific private endpoint connection under a topic, domain, or partner namespace or namespace.

SELECT
id,
name,
properties,
type
FROM azure.event_grid.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND parentType = '{{ parentType }}' -- required
AND parentName = '{{ parentName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list_by_resource

Get all private endpoint connections under a topic, domain, or partner namespace or namespace.

SELECT
id,
name,
properties,
type
FROM azure.event_grid.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND parentType = '{{ parentType }}' -- required
AND parentName = '{{ parentName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

REPLACE examples

update

Update a specific private endpoint connection under a topic, domain or partner namespace.

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

DELETE examples

delete

Delete a specific private endpoint connection under a topic, domain, or partner namespace or namespace.

DELETE FROM azure.event_grid.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND parentType = '{{ parentType }}' --required
AND parentName = '{{ parentName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;