private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.notification_hubs.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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
groupIds	array	List of group ids. For Notification Hubs, it always contains a single "namespace" element.
privateEndpoint	object	Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.
privateLinkServiceConnectionState	object	State of the Private Link Service connection.
provisioningState	string	State of Private Endpoint Connection. Known values are: "Unknown", "Succeeded", "Creating", "Updating", "UpdatingByProxy", "Deleting", "DeletingByProxy", and "Deleted".
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".

get_group_id

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
groupId	string	A Group Id for Private Link. For Notification Hubs, it is always set to "namespace".
requiredMembers	array	Required members. For Notification Hubs, it's always a collection with a single "namespace" item.
requiredZoneNames	array	Required DNS zone names. For Notification Hubs, it contains two CNames for Service Bus and Notification Hubs zones.
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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
groupIds	array	List of group ids. For Notification Hubs, it always contains a single "namespace" element.
privateEndpoint	object	Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.
privateLinkServiceConnectionState	object	State of the Private Link Service connection.
provisioningState	string	State of Private Endpoint Connection. Known values are: "Unknown", "Succeeded", "Creating", "Updating", "UpdatingByProxy", "Deleting", "DeletingByProxy", and "Deleted".
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, namespace_name, private_endpoint_connection_name, subscription_id		Returns a Private Endpoint Connection with a given name. This is a public API that can be called directly by Notification Hubs users. Returns a Private Endpoint Connection with a given name. This is a public API that can be called directly by Notification Hubs users.
get_group_id	select	resource_group_name, namespace_name, sub_resource_name, subscription_id		Returns Group Id response. This is a public API required by the Networking RP contract. It can be used directly by Notification Hubs users. Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called. That's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.
list	select	resource_group_name, namespace_name, subscription_id		Returns all Private Endpoint Connections that belong to the given Notification Hubs namespace. This is a public API that can be called directly by Notification Hubs users. Returns all Private Endpoint Connections that belong to the given Notification Hubs namespace. This is a public API that can be called directly by Notification Hubs users.
update	update	resource_group_name, namespace_name, private_endpoint_connection_name, subscription_id		Approves or rejects Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users. Approves or rejects Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.
delete	delete	resource_group_name, namespace_name, private_endpoint_connection_name, subscription_id		Deletes the Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users. Deletes the Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.
list_group_ids	exec	resource_group_name, namespace_name, subscription_id		Returns all Group Ids supported by the Notification Hubs RP. This is a public API required by the Networking RP contract. It can be used directly by Notification Hubs users. Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called. That's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.

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
namespace_name	string	Namespace name. Required.
private_endpoint_connection_name	string	Private Endpoint Connection Name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sub_resource_name	string	Name of the Private Link sub-resource. The only supported sub-resource is "namespace". Required.
subscription_id	string

SELECT examples

get

Returns a Private Endpoint Connection with a given name. This is a public API that can be called directly by Notification Hubs users. Returns a Private Endpoint Connection with a given name. This is a public API that can be called directly by Notification Hubs users.

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

get_group_id

Returns Group Id response. This is a public API required by the Networking RP contract. It can be used directly by Notification Hubs users. Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called. That's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.

SELECT
id,
name,
groupId,
requiredMembers,
requiredZoneNames,
systemData,
type
FROM azure.notification_hubs.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND sub_resource_name = '{{ sub_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns all Private Endpoint Connections that belong to the given Notification Hubs namespace. This is a public API that can be called directly by Notification Hubs users. Returns all Private Endpoint Connections that belong to the given Notification Hubs namespace. This is a public API that can be called directly by Notification Hubs users.

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

UPDATE examples

update

Approves or rejects Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users. Approves or rejects Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.

UPDATE azure.notification_hubs.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_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

Deletes the Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users. Deletes the Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.

DELETE FROM azure.notification_hubs.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_group_ids

Returns all Group Ids supported by the Notification Hubs RP. This is a public API required by the Networking RP contract. It can be used directly by Notification Hubs users. Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called. That's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.

EXEC azure.notification_hubs.private_endpoint_connections.list_group_ids 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;