Managed Private Endpoints - Create Workspace Managed Private Endpoint

Referentie

Service:: Core

API-versie:: v1

Notitie

Deze API is in preview.

Hiermee maakt u een beheerd privé-eindpunt in de opgegeven werkruimte.

Machtigingen

De aanroeper moet beheerdersrol werkruimte hebben.

Vereiste gedelegeerde bereiken

Workspace.ReadWrite.All.

Beperkingen

Als u een beheerd privé-eindpunt wilt maken, moet de werkruimte zich in een ondersteunde Infrastructuurcapaciteit bevinden. Zie voor meer informatie: Microsoft Fabric-licentietypen.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Steunen
Gebruiker	Ja
service-principal en beheerde identiteiten	Ja

Interface

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

URI-parameters

Name	In	Vereist	Type	Description
workspaceId	path	True	string uuid	De werkruimte-id.

Aanvraagbody

Name	Vereist	Type	Description
name	True	string	De naam van het privé-eindpunt. Mag niet langer zijn dan 64 tekens.
targetPrivateLinkResourceId	True	string	Resource-id van gegevensbron waarvoor een privé-eindpunt moet worden gemaakt.
targetSubresourceType	True	string	Subresource die verwijst naar private-link-.
requestMessage		string	Bericht voor het goedkeuren van een privé-eindpuntaanvraag. Mag niet langer zijn dan 140 tekens.

Antwoorden

Name	Type	Description
201 Created	ManagedPrivateEndpoint	De aanvraag is voltooid. Kopteksten Location: string
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError: er is een fout opgetreden.

Name

Type

Description

201 Created

ManagedPrivateEndpoint

De aanvraag is voltooid.

Kopteksten

Location: string

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

UnknownError: er is een fout opgetreden.

Voorbeelden

Create a managed private endpoint example

Voorbeeldaanvraag

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"
}

Voorbeeldrespons

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"
}

Definities

Name	Description
ConnectionStatus	Verbindingsstatus van privé-eindpunt. Er kan na verloop van tijd extra verbindingsstatus worden toegevoegd.
CreateManagedPrivateEndpointRequest	Maak nettolading voor beheerde privé-eindpuntaanvragen.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
ManagedPrivateEndpoint	Beheerd privé-eindpunt.
PrivateEndpointConnectionState	Verbindingsstatus privé-eindpunt
PrivateEndpointProvisioningState	Inrichtingsstatus van eindpunt.

ConnectionStatus

Inventarisatie

Verbindingsstatus van privé-eindpunt. Er kan na verloop van tijd extra verbindingsstatus worden toegevoegd.

Waarde	Description
Approved	Eindpunt goedgekeurd
Disconnected	Verbinding met eindpunt verbroken
Pending	Goedkeuring in behandeling
Rejected	Eindpunt geweigerd

CreateManagedPrivateEndpointRequest

Object

Maak nettolading voor beheerde privé-eindpuntaanvragen.

Name	Type	Description
name	string	De naam van het privé-eindpunt. Mag niet langer zijn dan 64 tekens.
requestMessage	string	Bericht voor het goedkeuren van een privé-eindpuntaanvraag. Mag niet langer zijn dan 140 tekens.
targetPrivateLinkResourceId	string	Resource-id van gegevensbron waarvoor een privé-eindpunt moet worden gemaakt.
targetSubresourceType	string	Subresource die verwijst naar private-link-.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.