private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure_extras.time_series_insights.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.
groupIds	array	The provisioning state of the private endpoint connection resource.
privateEndpoint	object	The resource of private end point.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider.
provisioningState	string	Provisioning state of the private endpoint connection. Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_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.
groupIds	array	The provisioning state of the private endpoint connection resource.
privateEndpoint	object	The resource of private end point.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider.
provisioningState	string	Provisioning state of the private endpoint connection. Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
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, environment_name, private_endpoint_connection_name, subscription_id		Gets the details of the private endpoint connection of the environment in the given resource group.
list_by_environment	select	resource_group_name, environment_name, subscription_id		Gets a list of all private endpoint connections in the given environment.
create_or_update	insert	resource_group_name, environment_name, private_endpoint_connection_name, subscription_id		Updates a Private Endpoint connection of the environment in the given resource group.
create_or_update	replace	resource_group_name, environment_name, private_endpoint_connection_name, subscription_id		Updates a Private Endpoint connection of the environment in the given resource group.
delete	delete	resource_group_name, environment_name, private_endpoint_connection_name, subscription_id		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
environment_name	string	The name of the Time Series Insights environment associated with the specified resource group. Required.
private_endpoint_connection_name	string	The name of the private endpoint connection associated with the Azure resource. Required.
resource_group_name	string	Name of an Azure Resource group. Required.
subscription_id	string

SELECT examples

get

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

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
type
FROM azure_extras.time_series_insights.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_environment

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

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
type
FROM azure_extras.time_series_insights.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.time_series_insights.private_endpoint_connections (
properties,
resource_group_name,
environment_name,
private_endpoint_connection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ environment_name }}',
'{{ private_endpoint_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
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: environment_name
    value: "{{ environment_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 }}"
      groupIds:
        - "{{ groupIds }}"
      privateLinkServiceConnectionState:
        status: "{{ status }}"
        description: "{{ description }}"
        actionsRequired: "{{ actionsRequired }}"

REPLACE examples

create_or_update

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

REPLACE azure_extras.time_series_insights.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

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

DELETE FROM azure_extras.time_series_insights.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;