Microsoft.PowerBI privateLinkServicesForPowerBI

ARM template resource definition

The privateLinkServicesForPowerBI resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.PowerBI/privateLinkServicesForPowerBI resource, add the following JSON to your template.

{
  "type": "Microsoft.PowerBI/privateLinkServicesForPowerBI",
  "apiVersion": "2020-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "tenantId": "string"
  }
}

Property values

privateLinkServicesForPowerBI

Name Description Value
type The resource type 'Microsoft.PowerBI/privateLinkServicesForPowerBI'
apiVersion The resource api version '2020-06-01'
name The resource name string (required)
location Specifies the location of the resource. string
tags Specifies the tags of the resource. Dictionary of tag names and values. See Tags in templates
properties Specifies the properties of the resource. TenantProperties

TenantProperties

Name Description Value
privateEndpointConnections Specifies the private endpoint connections of the resource. PrivateEndpointConnection[]
tenantId Specifies the tenant id of the resource. string

PrivateEndpointConnection

Name Description Value
properties Specifies the properties of the private endpoint connection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Specifies the private endpoint. PrivateEndpoint
privateLinkServiceConnectionState Specifies the connection state. ConnectionState
provisioningState Provisioning state of the Private Endpoint Connection. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'

PrivateEndpoint

Name Description Value
id Specifies the id of private endpoint. string

ConnectionState

Name Description Value
actionsRequired Actions required (if any). string
description Description of the connection state. string
status Status of the connection. 'Approved'
'Disconnected'
'Pending'
'Rejected'