Registry /
azure / azure-synapse-managedprivateendpoints
Install & Compatibility
Where this runs
tested against v0.4.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.778s · 45.6MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 4.0s · import 0.678s · 46MB
45MB installed
● package 45MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
VnetClient
✓ from azure.synapse.managedprivateendpoints import VnetClient
This is the primary client for interacting with Synapse Managed Private Endpoints.
DefaultAzureCredential
✓ from azure.identity import DefaultAzureCredential
Standard authentication method for Azure SDKs, supporting various credential types.
This quickstart demonstrates how to authenticate with Azure using `DefaultAzureCredential` and then initialize the `VnetClient` for Azure Synapse Managed Private Endpoints to list existing private endpoints in your workspace. Ensure `SYNAPSE_WORKSPACE_ENDPOINT` is set to your Synapse workspace's development endpoint.
import os
from azure.identity import DefaultAzureCredential
from azure.synapse.managedprivateendpoints import VnetClient
# Your Azure Synapse workspace development endpoint, e.g., "https://<your-workspace-name>.dev.azuresynapse.net"
SYNAPSE_WORKSPACE_ENDPOINT = os.environ.get("SYNAPSE_WORKSPACE_ENDPOINT", "https://your_synapse_workspace.dev.azuresynapse.net")
# Create a credential using DefaultAzureCredential.
# DefaultAzureCredential will attempt to authenticate through multiple mechanisms,
# including environment variables, managed identity, and development tools.
credential = DefaultAzureCredential()
# Create a VnetClient
# The default API version is '2020-12-01'.
vnet_client = VnetClient(credential, SYNAPSE_WORKSPACE_ENDPOINT)
print("Listing managed private endpoints...")
# The .list() method is paginated, so iterate through the results.
managed_private_endpoints = vnet_client.managed_private_endpoints.list()
for mpe in managed_private_endpoints:
print(f" - Name: {mpe.name}, Status: {mpe.properties.provisioning_state}, Approval: {mpe.properties.private_link_connection_state.status}")
Debug
Known issues
breakingEnabling a Managed Virtual Network (VNet) or Managed Private Endpoints cannot be done on an existing Azure Synapse workspace. This is a critical design choice at workspace creation. If you need these features and your workspace wasn't initially configured with them, you must create a new Synapse workspace and migrate your artifacts.fixPlan your Synapse workspace network configuration carefully during creation. If Managed VNet is required for managed private endpoints, enable it from the outset. For existing workspaces without it, recreation and migration are necessary.
affects: <=0.4.0
breakingA critical transition is required for Azure Synapse Analytics workspaces to private links before August 1, 2026. Failure to do so may result in the loss of connectivity to Azure Storage and Key Vault. This transition necessitates that your workspace uses a Managed Virtual Network, which might require recreating your workspace if not initially configured.fixReview your Synapse workspace configurations and plan for migration to a Managed Virtual Network with managed private endpoints for all critical linked services before the deadline.
affects: All versions (service-level change)
gotchaWhen creating a managed private endpoint, it will initially be in a 'Pending' approval state. The owner of the target Azure resource (e.g., Storage Account, Azure SQL Database) must explicitly approve the private endpoint connection for the private link to be established and functional.fixAlways coordinate with the owner of the target resource to approve pending private endpoint connections in the Azure portal or via appropriate Azure CLI/PowerShell commands.
affects: All versions
gotchaWhen using Azure Synapse Spark utilities (e.g., `mssparkutils.fs.mount`) with Data Exfiltration Protection enabled, and connecting to Azure Data Lake Storage Gen2, ensure that you create a Managed Private Endpoint specifically for the *blob* endpoint of the storage account, not just the *dfs* endpoint. Otherwise, DNS resolution issues may occur.fixFor ADLS Gen2 with Data Exfiltration Protection, configure a Managed Private Endpoint targeting the blob endpoint (e.g., `accountname.blob.core.windows.net`) in addition to any dfs endpoint MPEs.
affects: All versions
deprecatedThe general `azure-synapse` meta-package is officially deprecated and will no longer be maintained after 2020-04-13 (receiving only security fixes until then). Users are advised to install service-specific packages, such as `azure-synapse-managedprivateendpoints`, directly.fixDirectly install the `azure-synapse-managedprivateendpoints` package and other specific Synapse service packages as needed, rather than the `azure-synapse` meta-package.
affects: Not applicable to this package, but affects usage of the older meta-package.
Upgrade
Version history
0.4.0latest on PyPI · released Aug 10, 2021
Audit
Dependencies
azure-corerequiredCore shared client functionality for Azure SDKs.
azure-identityrequiredProvides Azure Active Directory authentication, typically required for all Azure SDKs.