Managed Private Endpoints - Create Workspace Managed Private Endpoint

Service:: Core

Version d’API:: v1

Crée un point de terminaison privé managé dans l’espace de travail spécifié.

Permissions

L’appelant doit avoir un rôle d’espace de travail d’administrateur .

Étendues déléguées requises

Workspace.ReadWrite.All.

Limitations

Pour créer un point de terminaison privé managé, l’espace de travail doit se trouver sur une capacité Fabric prise en charge. Pour plus d’informations, consultez : types de licences Microsoft Fabric.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity	Support
User	Yes
Service principal et identités gérées	Yes

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string (uuid)	ID de l’espace de travail.

Corps de la demande

Nom	Obligatoire	Type	Description
name	True	string	Nom du point de terminaison privé. Ne doit pas comporter plus de 64 caractères.
targetPrivateLinkResourceId	True	string	ID de ressource de la source de données pour laquelle le point de terminaison privé doit être créé.
requestMessage		string	Message pour approuver la demande de point de terminaison privé. Ne doit pas comporter plus de 140 caractères.
targetFQDNs		string[]	Noms de domaine complets (FQDN) à associer au point de terminaison privé. Ne doit pas contenir plus de 20 noms de domaine complets.
targetSubresourceType		string	Sous-ressource pointant vers une ressource de liaison privée.

Réponses

Nom Type Description

201 Created

Nom	Type	Description
201 Created	ManagedPrivateEndpoint	La demande s’est terminée avec succès. En-têtes Location: string
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : UnknownError : une erreur s’est produite.

ManagedPrivateEndpoint

La demande s’est terminée avec succès.

En-têtes

Location: string

429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

UnknownError : une erreur s’est produite.

Exemples

Create a managed private endpoint example

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
ConnectionStatus	État de la connexion de point de terminaison privé. L’état de connexion supplémentaire peut être ajouté au fil du temps.
CreateManagedPrivateEndpointRequest	Créez une charge utile de demande de point de terminaison privé managée.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
ManagedPrivateEndpoint	Point de terminaison privé managé.
PrivateEndpointConnectionState	État de connexion de point de terminaison privé
PrivateEndpointProvisioningState	État d’approvisionnement du point de terminaison.

ConnectionStatus

Énumération

État de la connexion de point de terminaison privé. L’état de connexion supplémentaire peut être ajouté au fil du temps.

Valeur	Description
Pending	Approbation en attente
Approved	Point de terminaison approuvé
Rejected	Point de terminaison rejeté
Disconnected	Point de terminaison déconnecté

CreateManagedPrivateEndpointRequest

Objet

Créez une charge utile de demande de point de terminaison privé managée.

Nom	Type	Description
name	string	Nom du point de terminaison privé. Ne doit pas comporter plus de 64 caractères.
requestMessage	string	Message pour approuver la demande de point de terminaison privé. Ne doit pas comporter plus de 140 caractères.
targetFQDNs	string[]	Noms de domaine complets (FQDN) à associer au point de terminaison privé. Ne doit pas contenir plus de 20 noms de domaine complets.
targetPrivateLinkResourceId	string	ID de ressource de la source de données pour laquelle le point de terminaison privé doit être créé.
targetSubresourceType	string	Sous-ressource pointant vers une ressource de liaison privée.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.