private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.relay.private_endpoint_connections

Fields

vw_private_endpoint_connections

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	text	The name of the resource
location	text	The geo-location where the resource lives
namespaceName	text	field from the properties object
privateEndpointConnectionName	text	field from the properties object
private_endpoint	text	field from the properties object
private_link_service_connection_state	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

private_endpoint_connections

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 private endpoint connection resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	namespaceName, privateEndpointConnectionName, resourceGroupName, subscriptionId	Gets a description for the specified Private Endpoint Connection name.
list	SELECT	namespaceName, resourceGroupName, subscriptionId	Gets the available PrivateEndpointConnections within a namespace.
create_or_update	INSERT	namespaceName, privateEndpointConnectionName, resourceGroupName, subscriptionId	Creates or updates PrivateEndpointConnections of service namespace.
delete	DELETE	namespaceName, privateEndpointConnectionName, resourceGroupName, subscriptionId	Deletes an existing namespace. This operation also removes all associated resources under the namespace.

SELECT examples

Gets the available PrivateEndpointConnections within a namespace.

vw_private_endpoint_connections

SELECT
id,
name,
location,
namespaceName,
privateEndpointConnectionName,
private_endpoint,
private_link_service_connection_state,
provisioning_state,
resourceGroupName,
subscriptionId,
system_data,
type
FROM azure.relay.vw_private_endpoint_connections
WHERE namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

private_endpoint_connections

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

INSERT example

Use the following StackQL query and manifest file to create a new private_endpoint_connections resource.

All Properties

/*+ create */
INSERT INTO azure.relay.private_endpoint_connections (
namespaceName,
privateEndpointConnectionName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ namespaceName }}',
'{{ privateEndpointConnectionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: properties
      value:
        - name: privateEndpoint
          value:
            - name: id
              value: string
        - name: privateLinkServiceConnectionState
          value:
            - name: status
              value: string
            - name: description
              value: string
        - name: provisioningState
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

DELETE example

Deletes the specified private_endpoint_connections resource.

/*+ delete */
DELETE FROM azure.relay.private_endpoint_connections
WHERE namespaceName = '{{ namespaceName }}'
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';