private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.powerbi_privatelinks.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Specifies the id of the resource.
name	string	Specifies the name of the resource.
properties	object	Specifies the properties of the private endpoint connection. (title: PrivateEndpointConnectionProperties)
systemData	object	The system meta data relating to this resource.
type	string	Specifies the type of the resource.

list_by_resource

Success. The response describes the list of private endpoint connections in the private endpoint resource.

Name	Datatype	Description
id	string	Specifies the id of the resource.
name	string	Specifies the name of the resource.
properties	object	Specifies the properties of the private endpoint connection. (title: PrivateEndpointConnectionProperties)
systemData	object	The system meta data relating to this resource.
type	string	Specifies the type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, azureResourceName, privateEndpointName		Get a specific private endpoint connection for Power BI by private endpoint name.
list_by_resource	select	subscriptionId, resourceGroupName, azureResourceName		Gets private endpoint connection for Power BI.
create	insert	subscriptionId, resourceGroupName, azureResourceName, privateEndpointName		Updates the status of Private Endpoint Connection object. Used to approve or reject a connection.
delete	delete	subscriptionId, resourceGroupName, azureResourceName, privateEndpointName		Deletes a private endpoint connection for Power BI by private endpoint name.

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
azureResourceName	string	The name of the Azure resource.
privateEndpointName	string	The name of the private endpoint.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

SELECT examples

get

Get a specific private endpoint connection for Power BI by private endpoint name.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.powerbi_privatelinks.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND azureResourceName = '{{ azureResourceName }}' -- required
AND privateEndpointName = '{{ privateEndpointName }}' -- required
;

list_by_resource

Gets private endpoint connection for Power BI.

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

INSERT examples

create

Updates the status of Private Endpoint Connection object. Used to approve or reject a connection.

INSERT INTO azure.powerbi_privatelinks.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
azureResourceName,
privateEndpointName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ azureResourceName }}',
'{{ privateEndpointName }}'
RETURNING
id,
name,
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: azureResourceName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: privateEndpointName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: properties
      value: object
      description: |
        Specifies the properties of the private endpoint connection.

DELETE examples

delete

Deletes a private endpoint connection for Power BI by private endpoint name.

DELETE FROM azure.powerbi_privatelinks.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND azureResourceName = '{{ azureResourceName }}' --required
AND privateEndpointName = '{{ privateEndpointName }}' --required
;