private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.event_hubs.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Private Endpoint Connection successfully returned.

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
location	string	The geo-location where the resource lives
properties	object	Properties of the PrivateEndpointConnection.
systemData	object	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

list

PrivateEndpointConnections successfully returned.

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
location	string	The geo-location where the resource lives
properties	object	Properties of the PrivateEndpointConnection.
systemData	object	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, privateEndpointConnectionName, subscriptionId		Gets a description for the specified Private Endpoint Connection name.
list	select	resourceGroupName, namespaceName, subscriptionId		Gets the available PrivateEndpointConnections within a namespace.
create_or_update	insert	subscriptionId, resourceGroupName, namespaceName, privateEndpointConnectionName		Creates or updates PrivateEndpointConnections of service namespace.
delete	delete	resourceGroupName, namespaceName, subscriptionId, privateEndpointConnectionName		Deletes an existing namespace. This operation also removes all associated resources under the 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
namespaceName	string	The Namespace name
privateEndpointConnectionName	string	The PrivateEndpointConnection name
resourceGroupName	string	Name of the resource group within the azure subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets a description for the specified Private Endpoint Connection name.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.event_hubs.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets the available PrivateEndpointConnections within a namespace.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.event_hubs.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates PrivateEndpointConnections of service namespace.

INSERT INTO azure.event_hubs.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
namespaceName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: namespaceName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: privateEndpointConnectionName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: properties
      value: object
      description: |
        Properties of the PrivateEndpointConnection.

DELETE examples

delete

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

DELETE FROM azure.event_hubs.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;