private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.time_series_insights.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

The definition of the private endpoint connection was successfully retrieved and is in the response.

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
properties	object	Resource properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_environment

The operation succeeded. The response contains the list of all private endpoint connections for the given environment.

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
properties	object	Resource properties.
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	subscriptionId, resourceGroupName, environmentName, privateEndpointConnectionName		Gets the details of the private endpoint connection of the environment in the given resource group.
list_by_environment	select	subscriptionId, resourceGroupName, environmentName		Gets a list of all private endpoint connections in the given environment.
create_or_update	insert	subscriptionId, resourceGroupName, environmentName, privateEndpointConnectionName		Updates a Private Endpoint connection of the environment in the given resource group.
delete	delete	subscriptionId, resourceGroupName, environmentName, privateEndpointConnectionName		Disconnects the private endpoint connection and deletes it from the environment.

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
environmentName	string	The name of the Time Series Insights environment associated with the specified resource group.
privateEndpointConnectionName	string	The name of the private endpoint connection associated with the Azure resource
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the details of the private endpoint connection of the environment in the given resource group.

SELECT
id,
name,
properties,
type
FROM azure.time_series_insights.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND environmentName = '{{ environmentName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list_by_environment

Gets a list of all private endpoint connections in the given environment.

SELECT
id,
name,
properties,
type
FROM azure.time_series_insights.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND environmentName = '{{ environmentName }}' -- required
;

INSERT examples

create_or_update

Updates a Private Endpoint connection of the environment in the given resource group.

INSERT INTO azure.time_series_insights.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
environmentName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ environmentName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
properties,
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: environmentName
      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: |
        Resource properties.

DELETE examples

delete

Disconnects the private endpoint connection and deletes it from the environment.

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