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 resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
groupIds	array	GroupIds from the private link service resource.
privateEndpoint	object	The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState	object	Details about the state of the connection.
provisioningState	string	Provisioning state of the Private Endpoint Connection. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
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_by_resource

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
groupIds	array	GroupIds from the private link service resource.
privateEndpoint	object	The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState	object	Details about the state of the connection.
provisioningState	string	Provisioning state of the Private Endpoint Connection. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
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	resource_group_name, parent_type, parent_name, private_endpoint_connection_name, subscription_id		Get a specific private endpoint connection. Get a specific private endpoint connection under a topic, domain, or partner namespace or namespace.
list_by_resource	select	resource_group_name, parent_type, parent_name, subscription_id	$filter, $top	Lists all private endpoint connections under a resource. Get all private endpoint connections under a topic, domain, or partner namespace or namespace.
update	update	resource_group_name, parent_type, parent_name, private_endpoint_connection_name, subscription_id		Update a specific private endpoint connection. Update a specific private endpoint connection under a topic, domain or partner namespace.
delete	delete	resource_group_name, parent_type, parent_name, private_endpoint_connection_name, subscription_id		Delete a specific private endpoint connection. 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
parent_name	string	The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name). Required.
parent_type	string	The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\' or \'namespaces\'. Known values are: "topics", "domains", "partnerNamespaces", and "namespaces". Required.
private_endpoint_connection_name	string	The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$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'. Default value is None.
$top	integer	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. Default value is None.

SELECT examples

get

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

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.event_grid.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND parent_type = '{{ parent_type }}' -- required
AND parent_name = '{{ parent_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource

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

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.event_grid.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND parent_type = '{{ parent_type }}' -- required
AND parent_name = '{{ parent_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

UPDATE examples

update

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

UPDATE azure.event_grid.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND parent_type = '{{ parent_type }}' --required
AND parent_name = '{{ parent_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

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

DELETE FROM azure.event_grid.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND parent_type = '{{ parent_type }}' --required
AND parent_name = '{{ parent_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;