Share via

Microsoft.DataFactory factories/privateEndpointConnections 2018-06-01

  • Article

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.DataFactory/factories/privateEndpointConnections@2018-06-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    privateEndpoint: {
      id: 'string'
    }
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
  }
}

Property values

factories/privateEndpointConnections

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (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
properties Core resource properties PrivateLinkConnectionApprovalRequestOrRemotePrivateE...

PrivateLinkConnectionApprovalRequestOrRemotePrivateE...

Name Description Value
privateEndpoint The resource of private endpoint. PrivateEndpointOrArmIdWrapper
privateLinkServiceConnectionState The state of a private link connection PrivateLinkConnectionState

PrivateEndpointOrArmIdWrapper

Name Description Value
id The resource Id for private endpoint string

PrivateLinkConnectionState

Name Description Value
actionsRequired ActionsRequired for a private link connection string
description Description of a private link connection string
status Status of a private link connection string

ARM template resource definition

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

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

Resource format

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

{
  "type": "Microsoft.DataFactory/factories/privateEndpointConnections",
  "apiVersion": "2018-06-01",
  "name": "string",
  "properties": {
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    }
  }
}

Property values

factories/privateEndpointConnections

Name Description Value
type The resource type 'Microsoft.DataFactory/factories/privateEndpointConnections'
apiVersion The resource api version '2018-06-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Core resource properties PrivateLinkConnectionApprovalRequestOrRemotePrivateE...

PrivateLinkConnectionApprovalRequestOrRemotePrivateE...

Name Description Value
privateEndpoint The resource of private endpoint. PrivateEndpointOrArmIdWrapper
privateLinkServiceConnectionState The state of a private link connection PrivateLinkConnectionState

PrivateEndpointOrArmIdWrapper

Name Description Value
id The resource Id for private endpoint string

PrivateLinkConnectionState

Name Description Value
actionsRequired ActionsRequired for a private link connection string
description Description of a private link connection string
status Status of a private link connection string

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories/privateEndpointConnections@2018-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      privateEndpoint = {
        id = "string"
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
    }
  })
}

Property values

factories/privateEndpointConnections

Name Description Value
type The resource type "Microsoft.DataFactory/factories/privateEndpointConnections@2018-06-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: factories
properties Core resource properties PrivateLinkConnectionApprovalRequestOrRemotePrivateE...

PrivateLinkConnectionApprovalRequestOrRemotePrivateE...

Name Description Value
privateEndpoint The resource of private endpoint. PrivateEndpointOrArmIdWrapper
privateLinkServiceConnectionState The state of a private link connection PrivateLinkConnectionState

PrivateEndpointOrArmIdWrapper

Name Description Value
id The resource Id for private endpoint string

PrivateLinkConnectionState

Name Description Value
actionsRequired ActionsRequired for a private link connection string
description Description of a private link connection string
status Status of a private link connection string