Microsoft.DataFactory factories/managedVirtualNetworks/managedPrivateEndpoints

• Latest
• 2018-06-01

Bicep resource definition

The factories/managedVirtualNetworks/managedPrivateEndpoints resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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

Usage Examples

Bicep Samples

A basic example of deploying Data Factory Managed Private Endpoint.

param location string = 'westeurope'
param resourceName string = 'acctest0001'

resource factory 'Microsoft.DataFactory/factories@2018-06-01' = {
  name: resourceName
  location: location
  properties: {
    globalParameters: {}
    publicNetworkAccess: 'Enabled'
  }
}

resource managedVirtualNetwork 'Microsoft.DataFactory/factories/managedVirtualNetworks@2018-06-01' = {
  name: 'default'
  parent: factory
  properties: {}
}

resource managedPrivateEndpoint 'Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints@2018-06-01' = {
  name: resourceName
  parent: managedVirtualNetwork
  properties: {
    groupId: 'blob'
    privateLinkResourceId: storageAccount.id
  }
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'BlobStorage'
  properties: {
    accessTier: 'Hot'
    allowBlobPublicAccess: true
    allowCrossTenantReplication: true
    allowSharedKeyAccess: true
    defaultToOAuthAuthentication: false
    encryption: {
      keySource: 'Microsoft.Storage'
      services: {
        queue: {
          keyType: 'Service'
        }
        table: {
          keyType: 'Service'
        }
      }
    }
    isHnsEnabled: false
    isNfsV3Enabled: false
    isSftpEnabled: false
    minimumTlsVersion: 'TLS1_2'
    networkAcls: {
      defaultAction: 'Allow'
    }
    publicNetworkAccess: 'Enabled'
    supportsHttpsTrafficOnly: true
  }
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module	Description
Data Factory - Managed Virtual Network - Managed Private Endpoint	AVM Child Module for Data Factory - Managed Virtual Network - Managed Private Endpoint

Resource format

To create a Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints@2018-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    connectionState: {}
    fqdns: [
      'string'
    ]
    groupId: 'string'
    privateLinkResourceId: 'string'
  }
}

Property Values

Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints

Name	Description	Value
name	The resource name	string Constraints: Min length = 1 Max length = 127 Pattern = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: factories/managedVirtualNetworks
properties	Managed private endpoint properties.	ManagedPrivateEndpoint (required)

ConnectionStateProperties

Name	Description	Value

ManagedPrivateEndpoint

Name	Description	Value
connectionState	The managed private endpoint connection state	ConnectionStateProperties
fqdns	Fully qualified domain names	string[]
groupId	The groupId to which the managed private endpoint is created	string
privateLinkResourceId	The ARM resource ID of the resource to which the managed private endpoint is created	string

ARM template resource definition

The factories/managedVirtualNetworks/managedPrivateEndpoints resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.

Usage Examples

Resource format

To create a Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints resource, add the following JSON to your template.

{
  "type": "Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints",
  "apiVersion": "2018-06-01",
  "name": "string",
  "properties": {
    "connectionState": {
    },
    "fqdns": [ "string" ],
    "groupId": "string",
    "privateLinkResourceId": "string"
  }
}

Property Values

Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints

Name	Description	Value
apiVersion	The api version	'2018-06-01'
name	The resource name	string Constraints: Min length = 1 Max length = 127 Pattern = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (required)
properties	Managed private endpoint properties.	ManagedPrivateEndpoint (required)
type	The resource type	'Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints'

ConnectionStateProperties

Name	Description	Value

ManagedPrivateEndpoint

Name	Description	Value
connectionState	The managed private endpoint connection state	ConnectionStateProperties
fqdns	Fully qualified domain names	string[]
groupId	The groupId to which the managed private endpoint is created	string
privateLinkResourceId	The ARM resource ID of the resource to which the managed private endpoint is created	string

Terraform (AzAPI provider) resource definition

The factories/managedVirtualNetworks/managedPrivateEndpoints resource type can be deployed with operations that target:

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

Usage Examples

Terraform Samples

A basic example of deploying Data Factory Managed Private Endpoint.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "factory" {
  type      = "Microsoft.DataFactory/factories@2018-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      globalParameters = {
      }
      publicNetworkAccess = "Enabled"
      repoConfiguration   = null
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "BlobStorage"
    properties = {
      accessTier                   = "Hot"
      allowBlobPublicAccess        = true
      allowCrossTenantReplication  = true
      allowSharedKeyAccess         = true
      defaultToOAuthAuthentication = false
      encryption = {
        keySource = "Microsoft.Storage"
        services = {
          queue = {
            keyType = "Service"
          }
          table = {
            keyType = "Service"
          }
        }
      }
      isHnsEnabled      = false
      isNfsV3Enabled    = false
      isSftpEnabled     = false
      minimumTlsVersion = "TLS1_2"
      networkAcls = {
        defaultAction = "Allow"
      }
      publicNetworkAccess      = "Enabled"
      supportsHttpsTrafficOnly = true
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "managedVirtualNetwork" {
  type      = "Microsoft.DataFactory/factories/managedVirtualNetworks@2018-06-01"
  parent_id = azapi_resource.factory.id
  name      = "default"
  body = {
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_id" "managedPrivateEndpoint" {
  type      = "Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints@2018-06-01"
  parent_id = azapi_resource.managedVirtualNetwork.id
  name      = var.resource_name
}

resource "azapi_resource_action" "managedPrivateEndpoint" {
  type        = "Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints@2018-06-01"
  resource_id = data.azapi_resource_id.managedPrivateEndpoint.id
  method      = "PUT"
  body = {
    properties = {
      groupId               = "blob"
      privateLinkResourceId = azapi_resource.storageAccount.id
    }
  }
}

Resource format

To create a Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints@2018-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      connectionState = {
      }
      fqdns = [
        "string"
      ]
      groupId = "string"
      privateLinkResourceId = "string"
    }
  }
}

Property Values

Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints

Name	Description	Value
name	The resource name	string Constraints: Min length = 1 Max length = 127 Pattern = ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: factories/managedVirtualNetworks
properties	Managed private endpoint properties.	ManagedPrivateEndpoint (required)
type	The resource type	"Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints@2018-06-01"

ConnectionStateProperties

Name	Description	Value

ManagedPrivateEndpoint

Name	Description	Value
connectionState	The managed private endpoint connection state	ConnectionStateProperties
fqdns	Fully qualified domain names	string[]
groupId	The groupId to which the managed private endpoint is created	string
privateLinkResourceId	The ARM resource ID of the resource to which the managed private endpoint is created	string