Zeema
New design
Catalogue / private-link

Azure Private Link

azurePrivate endpointazure-private-link

Private endpoint into one instance of a service over the Microsoft backbone.

Provider
azure
Kind
Private endpoint
Category
Edge
Official docs
https://learn.microsoft.com/en-us/azure/private-link/private-link-overview
Properties · 4 set by this component
propertytypevaluesrequiredkind defaultthis component
approvalRequiredboolean—no—inherited
connectionApproval · component propertyenumautomatic | manualno—inherited
crossRegionboolean—nofalse▸ true
endpointCountinteger—no—inherited
linkType · component propertyenumprivate-endpoint | private-link-serviceno—inherited
managedboolean—nofalse▸ true
privateDnsIntegrationboolean—no—▸ false
publicAccessDisabledboolean—no—▸ false
zoneResilient · component propertyboolean—notrueinherited
Rules that apply · 0

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

No rule reads this kind yet. That is a gap, not a guarantee.
Use it in a design
nodes:
  - { id: "private-link", component: "azure-private-link" }
Other Private endpoint products · 13
PrivateLinkalibaba-privatelinkalibabacloudprivate-linkPrivateLink endpoint serviceaws-privatelink-serviceawsprivate-linkAWS RTB Fabric gatewayaws-rtb-fabricawsprivate-linkAWS PrivateLink VPC endpointaws-vpc-endpointawsprivate-linkCloudflare Tunnelcloudflare-tunnelcloudflareprivate-linkWorkers VPCcloudflare-workers-vpccloudflareprivate-linkGeneric private endpointprivate-linkprivate-linkPrivate Service Connectgoogle-private-service-connectgcpprivate-linkServerless VPC Access connectorgoogle-serverless-vpc-access-connectorgcpprivate-linkVirtual Private Endpoint Gatewayibm-virtual-endpoint-gatewayibmprivate-linkPrivate Endpointoci-private-endpointociprivate-linkService Gatewayoci-service-gatewayociprivate-linkOUTSCALE Net access pointoutscale-net-access-pointoutscaleprivate-link
Source
# yaml-language-server: $schema=../../schema/component.schema.json
# Azure Private Link / Private Endpoint: a NIC in your subnet mapped to one instance of a PaaS or partner
# service, reached over the Microsoft backbone ("What is Azure Private Link?"). A private endpoint does
# not by itself restrict public network access, and it needs separate private DNS settings to resolve.
schemaVersion: "1"
type: "component"
id: "azure-private-link"
kind: "private-link"
provider: "azure"
docs: "https://learn.microsoft.com/en-us/azure/private-link/private-link-overview"
defaults:
  managed: true
  crossRegion: true
  publicAccessDisabled: false
  privateDnsIntegration: false
properties:
  linkType:
    type: "enum"
    values: ["private-endpoint", "private-link-service"]
  connectionApproval:
    type: "enum"
    values: ["automatic", "manual"]
  zoneResilient:
    type: "boolean"
    default: true

The same page as markdown, for an agent: /catalogue/components/azure-private-link.md