power_bi_resources

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

Overview

Name	power_bi_resources
Type	Resource
Id	azure.powerbi_privatelinks.power_bi_resources

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	subscriptionId, resourceGroupName, azureResourceName	x-ms-client-tenant-id	Creates or updates a Private Link Service Resource for Power BI.
update	update	subscriptionId, resourceGroupName, azureResourceName	x-ms-client-tenant-id	Creates or updates a Private Link Service Resource for Power BI.
delete	delete	subscriptionId, resourceGroupName, azureResourceName		Deletes a Private Link Service Resource for Power BI.
list_by_resource_name	exec	subscriptionId, resourceGroupName, azureResourceName		Gets all the private link resources for the given Azure resource.

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.
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).
x-ms-client-tenant-id	string	The client tenant id in header. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

INSERT examples

create

Creates or updates a Private Link Service Resource for Power BI.

INSERT INTO azure.powerbi_privatelinks.power_bi_resources (
data__location,
data__properties,
data__tags,
subscriptionId,
resourceGroupName,
azureResourceName,
x-ms-client-tenant-id
)
SELECT 
'{{ location }}',
'{{ properties }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ azureResourceName }}',
'{{ x-ms-client-tenant-id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: power_bi_resources
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the power_bi_resources resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the power_bi_resources resource.
    - name: azureResourceName
      value: string
      description: Required parameter for the power_bi_resources resource.
    - name: location
      value: string
      description: |
        Specifies the location of the resource.
    - name: properties
      value: object
      description: |
        Specifies the properties of the resource.
    - name: tags
      value: object
      description: |
        Specifies the tags of the resource.
    - name: x-ms-client-tenant-id
      value: string
      description: The client tenant id in header. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

UPDATE examples

update

Creates or updates a Private Link Service Resource for Power BI.

UPDATE azure.powerbi_privatelinks.power_bi_resources
SET 
data__location = '{{ location }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND azureResourceName = '{{ azureResourceName }}' --required
AND x-ms-client-tenant-id = '{{ x-ms-client-tenant-id}}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Private Link Service Resource for Power BI.

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

Lifecycle Methods

list_by_resource_name

Gets all the private link resources for the given Azure resource.

EXEC azure.powerbi_privatelinks.power_bi_resources.list_by_resource_name 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@azureResourceName='{{ azureResourceName }}' --required
;