Azure Synapse Managed Private Endpoint
This page shows how to write Terraform and Azure Resource Manager for Synapse Managed Private Endpoint and write them securely.
azurerm_synapse_managed_private_endpoint (Terraform)
The Managed Private Endpoint in Synapse can be configured in Terraform with the resource name azurerm_synapse_managed_private_endpoint
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
-
id
optional computed - string -
name
required - string -
subresource_name
required - string -
synapse_workspace_id
required - string -
target_resource_id
required - string -
timeouts
single block
Explanation in Terraform Registry
Manages a Synapse Managed Private Endpoint.
Tips: Best Practices for The Other Azure Synapse Resources
In addition to the azurerm_synapse_workspace, Azure Synapse has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.
azurerm_synapse_workspace
Ensure to enable the managed virtual network
It is better to enable the managed virtual network, which is disabled as the default.
Microsoft.Synapse/workspaces/privateEndpointConnections (Azure Resource Manager)
The workspaces/privateEndpointConnections in Microsoft.Synapse can be configured in Azure Resource Manager with the resource name Microsoft.Synapse/workspaces/privateEndpointConnections
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
"type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
"properties": {
"provisioningState": "Provisioning",
"privateEndpoint": {
"id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
},
"type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
"properties": {
"provisioningState": "Provisioning",
"privateEndpoint": {
"id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
},
"type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
"properties": {
"provisioningState": "Provisioning",
"privateEndpoint": {
"id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
},
"type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
"properties": {
"provisioningState": "Provisioning",
"privateEndpoint": {
"id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
},
"type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
"properties": {
"provisioningState": "Provisioning",
"privateEndpoint": {
"id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
},
"type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
"properties": {
"provisioningState": "Provisioning",
"privateEndpoint": {
"id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
},
"type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
"properties": {
"provisioningState": "Provisioning",
"privateEndpoint": {
"id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
},
"type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
"properties": {
"provisioningState": "Provisioning",
"privateEndpoint": {
"id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
},
"type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
"properties": {
"provisioningState": "Provisioning",
"privateEndpoint": {
"id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
},
"type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
"properties": {
"provisioningState": "Provisioning",
"privateEndpoint": {
"id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
},
Parameters
apiVersion
required - stringname
required - stringThe name of the private endpoint connection.
properties
requiredprivateEndpoint
optionalprivateLinkServiceConnectionState
optionaldescription
optional - stringThe private link service connection description.
status
optional - stringThe private link service connection status.
type
required - string