Managed Private Endpoints - Create Workspace Managed Private Endpoint

Usługa:: Core

Wersja interfejsu API:: v1

Tworzy zarządzany prywatny punkt końcowy w określonym obszarze roboczym.

Uwaga / Notatka

Ten interfejs API jest częścią wersji zapoznawczej i jest dostarczany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego.

Permissions

Obiekt wywołujący musi mieć rolę administratora obszaru roboczego.

Wymagane zakresy delegowane

Workspace.ReadWrite.All.

Limitations

Aby utworzyć zarządzany prywatny punkt końcowy, obszar roboczy musi znajdować się w obsługiwanej pojemności sieci szkieletowej. Aby uzyskać więcej informacji, zobacz: typy licencji usługi Microsoft Fabric.

Tożsamości obsługiwane przez firmę Microsoft

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity	Support
User	Yes
Główne usługi i Tożsamości zarządzane	Yes

Interface

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string	Nazwa prywatnego punktu końcowego. Nie powinna zawierać więcej niż 64 znaków.
targetPrivateLinkResourceId	True	string	Identyfikator zasobu źródła danych, dla którego należy utworzyć prywatny punkt końcowy.
requestMessage		string	Komunikat dotyczący zatwierdzenia żądania prywatnego punktu końcowego. Nie powinna zawierać więcej niż 140 znaków.
targetFQDNs		string[]	W pełni kwalifikowane nazwy domen (FQDN) do skojarzenia z prywatnym punktem końcowym. Nie powinna przekraczać 20 nazw FQDN.
targetSubresourceType		string	Zasób podrzędny wskazujący na zasoby łącza prywatnego.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	ManagedPrivateEndpoint	Żądanie zostało ukończone pomyślnie. Nagłówki Location: string
Other Status Codes	ErrorResponse	Typowe kody błędów: UnknownError — wystąpił błąd.

Nazwa

Typ

Opis

201 Created

ManagedPrivateEndpoint

Żądanie zostało ukończone pomyślnie.

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Typowe kody błędów:

UnknownError — wystąpił błąd.

Przykłady

Create a managed private endpoint example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
ConnectionStatus	Stan połączenia prywatnego punktu końcowego. W czasie może zostać dodany dodatkowy stan połączenia.
CreateManagedPrivateEndpointRequest	Utwórz ładunek żądania zarządzanego prywatnego punktu końcowego.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ManagedPrivateEndpoint	Zarządzany prywatny punkt końcowy.
PrivateEndpointConnectionState	Stan połączenia prywatnego punktu końcowego
PrivateEndpointProvisioningState	Stan aprowizacji punktu końcowego.

ConnectionStatus

Wyliczanie

Stan połączenia prywatnego punktu końcowego. W czasie może zostać dodany dodatkowy stan połączenia.

Wartość	Opis
Pending	Oczekiwanie na zatwierdzenie
Approved	Zatwierdzony punkt końcowy
Rejected	Punkt końcowy został odrzucony
Disconnected	Odłączony punkt końcowy

CreateManagedPrivateEndpointRequest

Objekt

Utwórz ładunek żądania zarządzanego prywatnego punktu końcowego.

Nazwa	Typ	Opis
name	string	Nazwa prywatnego punktu końcowego. Nie powinna zawierać więcej niż 64 znaków.
requestMessage	string	Komunikat dotyczący zatwierdzenia żądania prywatnego punktu końcowego. Nie powinna zawierać więcej niż 140 znaków.
targetFQDNs	string[]	W pełni kwalifikowane nazwy domen (FQDN) do skojarzenia z prywatnym punktem końcowym. Nie powinna przekraczać 20 nazw FQDN.
targetPrivateLinkResourceId	string	Identyfikator zasobu źródła danych, dla którego należy utworzyć prywatny punkt końcowy.
targetSubresourceType	string	Zasób podrzędny wskazujący na zasoby łącza prywatnego.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.