Microsoft.Synapse workspaces/privateEndpointConnections 2021-03-01

Bicep resource definition

The workspaces/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.Synapse/workspaces/privateEndpointConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Synapse/workspaces/privateEndpointConnections@2021-03-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      description: 'string'
      status: 'string'
    }
  }
}

Property Values

Microsoft.Synapse/workspaces/privateEndpointConnections

Name Description Value
name The resource name 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: workspaces
properties Private endpoint connection properties. PrivateEndpointConnectionProperties

PrivateEndpoint

Name Description Value

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The private endpoint which the connection belongs to. PrivateEndpoint
privateLinkServiceConnectionState Connection state of the private endpoint connection. PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Name Description Value
description The private link service connection description. string
status The private link service connection status. string

ARM template resource definition

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

Usage Examples

Resource format

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

{
  "type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
  "apiVersion": "2021-03-01",
  "name": "string",
  "properties": {
    "privateEndpoint": {
    },
    "privateLinkServiceConnectionState": {
      "description": "string",
      "status": "string"
    }
  }
}

Property Values

Microsoft.Synapse/workspaces/privateEndpointConnections

Name Description Value
apiVersion The api version '2021-03-01'
name The resource name string (required)
properties Private endpoint connection properties. PrivateEndpointConnectionProperties
type The resource type 'Microsoft.Synapse/workspaces/privateEndpointConnections'

PrivateEndpoint

Name Description Value

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The private endpoint which the connection belongs to. PrivateEndpoint
privateLinkServiceConnectionState Connection state of the private endpoint connection. PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Name Description Value
description The private link service connection description. string
status The private link service connection status. string

Terraform (AzAPI provider) resource definition

The workspaces/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.Synapse/workspaces/privateEndpointConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/privateEndpointConnections@2021-03-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      privateEndpoint = {
      }
      privateLinkServiceConnectionState = {
        description = "string"
        status = "string"
      }
    }
  }
}

Property Values

Microsoft.Synapse/workspaces/privateEndpointConnections

Name Description Value
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: workspaces
properties Private endpoint connection properties. PrivateEndpointConnectionProperties
type The resource type "Microsoft.Synapse/workspaces/privateEndpointConnections@2021-03-01"

PrivateEndpoint

Name Description Value

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The private endpoint which the connection belongs to. PrivateEndpoint
privateLinkServiceConnectionState Connection state of the private endpoint connection. PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Name Description Value
description The private link service connection description. string
status The private link service connection status. string
  • Last updated on