Managed Private Endpoints - Create Workspace Managed Private Endpoint

Dienst:: Core

API-Version:: v1

Erstellt einen verwalteten privaten Endpunkt im angegebenen Arbeitsbereich.

Hinweis

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.

Permissions

Der Anrufer muss über Administratorrolle Arbeitsbereichs verfügen.

Erforderliche delegierte Bereiche

Workspace.ReadWrite.All.

Limitations

Um verwalteten privaten Endpunkt zu erstellen, muss sich der Arbeitsbereich auf einer unterstützten Fabric-Kapazität befindet. Weitere Informationen finden Sie unter: Microsoft Fabric-Lizenztypen.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity	Support
User	Yes
Service Principal und Verwaltete Identitäten	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/managedPrivateEndpoints

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der Name des privaten Endpunkts. Darf nicht mehr als 64 Zeichen lang sein.
targetPrivateLinkResourceId	True	string	Ressourcen-ID der Datenquelle, für die privater Endpunkt erstellt werden muss.
requestMessage		string	Nachricht zum Genehmigen einer privaten Endpunktanforderung. Darf nicht mehr als 140 Zeichen lang sein.
targetFQDNs		string[]	Vollqualifizierte Domänennamen (FQDNs), die dem privaten Endpunkt zugeordnet werden sollen. Darf nicht mehr als 20 FQDNs sein.
targetSubresourceType		string	Unterressource, die auf " Private-Link-Resoure" verweist.

Antworten

Name	Typ	Beschreibung
201 Created	ManagedPrivateEndpoint	Die Anforderung wurde erfolgreich abgeschlossen. Header Location: string
Other Status Codes	ErrorResponse	Häufige Fehlercodes: UnknownError – Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

201 Created

ManagedPrivateEndpoint

Die Anforderung wurde erfolgreich abgeschlossen.

Header

Location: string

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Create a managed private endpoint example

Beispielanforderung

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints

{
  "name": "testprivatendpoint1",
  "targetPrivateLinkResourceId": "/subscriptions/2374e587-d28b-4898-a39c-6070e078ae31/resourceGroups/testrg/providers/Microsoft.Sql/servers/testsql1",
  "targetSubresourceType": "sqlServer",
  "requestMessage": "Request message to approve private endpoint"
}

Beispiel für eine Antwort

Statuscode:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints/59a92b06-6e5a-468c-b748-e28c8ff28da3

{
  "id": "59a92b06-6e5a-468c-b748-e28c8ff28da3",
  "name": "SqlPE",
  "targetPrivateLinkResourceId": "/subscriptions/e3bf3f1a-4d64-4e42-85e9-aa1b84e3874/resourceGroups/testRG/providers/Microsoft.SqlServer/SqlServer/sql1",
  "provisioningState": "Provisioning",
  "targetSubresourceType": "sqlServer"
}

Definitionen

Name	Beschreibung
ConnectionStatus	Verbindungsstatus des privaten Endpunkts. Der zusätzliche Verbindungsstatus kann im Laufe der Zeit hinzugefügt werden.
CreateManagedPrivateEndpointRequest	Erstellen Sie die Nutzlast der verwalteten privaten Endpunktanforderung.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
ManagedPrivateEndpoint	Verwalteter privater Endpunkt.
PrivateEndpointConnectionState	Verbindungsstatus des privaten Endpunkts
PrivateEndpointProvisioningState	Bereitstellungsstatus des Endpunkts.

ConnectionStatus

Enumeration

Verbindungsstatus des privaten Endpunkts. Der zusätzliche Verbindungsstatus kann im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Pending	Ausstehende Genehmigung
Approved	Endpunkt genehmigt
Rejected	Endpunkt abgelehnt
Disconnected	Endpunkt getrennt

CreateManagedPrivateEndpointRequest

Objekt

Erstellen Sie die Nutzlast der verwalteten privaten Endpunktanforderung.

Name	Typ	Beschreibung
name	string	Der Name des privaten Endpunkts. Darf nicht mehr als 64 Zeichen lang sein.
requestMessage	string	Nachricht zum Genehmigen einer privaten Endpunktanforderung. Darf nicht mehr als 140 Zeichen lang sein.
targetFQDNs	string[]	Vollqualifizierte Domänennamen (FQDNs), die dem privaten Endpunkt zugeordnet werden sollen. Darf nicht mehr als 20 FQDNs sein.
targetPrivateLinkResourceId	string	Ressourcen-ID der Datenquelle, für die privater Endpunkt erstellt werden muss.
targetSubresourceType	string	Unterressource, die auf " Private-Link-Resoure" verweist.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.