private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.event_hub.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.
location	string	The geo-location where the resource lives.
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".
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

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.
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".
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	resource_group_name, namespace_name, private_endpoint_connection_name, subscription_id		Gets a description for the specified Private Endpoint Connection name. .. seealso:: - https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx
list	select	resource_group_name, namespace_name, subscription_id		Gets the available PrivateEndpointConnections within a namespace. .. seealso:: - https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx
create_or_update	insert	resource_group_name, namespace_name, private_endpoint_connection_name, subscription_id		Creates or updates PrivateEndpointConnections of service namespace. .. seealso:: - https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx
create_or_update	replace	resource_group_name, namespace_name, private_endpoint_connection_name, subscription_id		Creates or updates PrivateEndpointConnections of service namespace. .. seealso:: - https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx
delete	delete	resource_group_name, namespace_name, private_endpoint_connection_name, subscription_id		Deletes a Private Endpoint Connection. .. seealso:: - https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx

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	The Namespace name. Required.
private_endpoint_connection_name	string	The PrivateEndpointConnection name. Required.
resource_group_name	string	Name of the resource group within the azure subscription. Required.
subscription_id	string

SELECT examples

get

Gets a description for the specified Private Endpoint Connection name. .. seealso:: - https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx

SELECT
id,
name,
location,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.event_hub.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
;

list

Gets the available PrivateEndpointConnections within a namespace. .. seealso:: - https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx

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

INSERT examples

create_or_update

Creates or updates PrivateEndpointConnections of service namespace. .. seealso:: - https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx

INSERT INTO azure.event_hub.private_endpoint_connections (
properties,
resource_group_name,
namespace_name,
private_endpoint_connection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ private_endpoint_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: private_endpoint_connection_name
    value: "{{ private_endpoint_connection_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: properties
    value:
      privateEndpoint:
        id: "{{ id }}"
      privateLinkServiceConnectionState:
        status: "{{ status }}"
        description: "{{ description }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates PrivateEndpointConnections of service namespace. .. seealso:: - https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx

REPLACE azure.event_hub.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,
location,
properties,
systemData,
type;

DELETE examples

delete

Deletes a Private Endpoint Connection. .. seealso:: - https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx

DELETE FROM azure.event_hub.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
;