Managed Private Endpoints - Get Workspace Managed Private Endpoint
Pobiera określony zarządzany prywatny punkt końcowy.
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ć lub większą rolę obszaru roboczego.
Wymagane zakresy delegowane
Workspace.Read.All lub Workspace.ReadWrite.All
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
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/managedPrivateEndpoints/{managedPrivateEndpointId}
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
managed
|
path | True |
string (uuid) |
Identyfikator zarządzanego prywatnego punktu końcowego. |
|
workspace
|
path | True |
string (uuid) |
Identyfikator obszaru roboczego. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
Żądanie zostało ukończone pomyślnie. |
|
| Other Status Codes |
Typowe kody błędów:
|
Przykłady
Get managed private endpoint example
Przykładowe żądanie
GET https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints/59a92b06-6e5a-468c-b748-e28c8ff28da3
Przykładowa odpowiedź
{
"id": "59a92b06-6e5a-468c-b748-e28c8ff28da3",
"name": "SqlPE",
"targetPrivateLinkResourceId": "/subscriptions/e3bf3f1a-4d64-4e42-85e9-aa1b84e3874/resourceGroups/testRG/providers/Microsoft.SqlServer/SqlServer/sql1",
"provisioningState": "Succeeded",
"connectionState": {
"status": "Approved",
"description": "Endpoint approved"
},
"targetSubresourceType": "sqlServer"
}
Definicje
| Nazwa | Opis |
|---|---|
|
Connection |
Stan połączenia prywatnego punktu końcowego. W czasie może zostać dodany dodatkowy stan połączenia. |
|
Error |
Obiekt szczegółów zasobu powiązanego z błędem. |
|
Error |
Odpowiedź na błąd. |
|
Error |
Szczegóły odpowiedzi na błąd. |
|
Managed |
Zarządzany prywatny punkt końcowy. |
|
Private |
Stan połączenia prywatnego punktu końcowego |
|
Private |
Stan aprowizacji punktu końcowego. |
ConnectionStatus
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 |
ErrorRelatedResource
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
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 |
Lista dodatkowych szczegółów błędu. |
|
| relatedResource |
Szczegóły zasobu powiązanego z błędem. |
|
| requestId |
string |
Identyfikator żądania skojarzonego z błędem. |
ErrorResponseDetails
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 |
Szczegóły zasobu powiązanego z błędem. |
ManagedPrivateEndpoint
Zarządzany prywatny punkt końcowy.
| Nazwa | Typ | Opis |
|---|---|---|
| connectionState |
Stan połączenia punktu końcowego aprowizowania punktów końcowych. |
|
| id |
string (uuid) |
Identyfikator zarządzanego prywatnego punktu końcowego. |
| name |
string |
Nazwa prywatnego punktu końcowego. |
| provisioningState |
Stan aprowizacji punktu końcowego. |
|
| targetPrivateLinkResourceId |
string |
Identyfikator zasobu źródła danych, dla którego jest tworzony prywatny punkt końcowy |
| targetSubresourceType |
string |
Zasób podrzędny wskazujący na zasoby łącza prywatnego. |
PrivateEndpointConnectionState
Stan połączenia prywatnego punktu końcowego
| Nazwa | Typ | Opis |
|---|---|---|
| actionsRequired |
string |
Akcje wymagane do nawiązania połączenia. |
| description |
string |
Komunikat opisu (jeśli istnieje) podany podczas zatwierdzania lub odrzucania punktu końcowego. |
| status |
Stan połączenia |
PrivateEndpointProvisioningState
Stan aprowizacji punktu końcowego.
| Wartość | Opis |
|---|---|
| Provisioning |
Prywatny punkt końcowy aprowizacji jest w toku |
| Succeeded |
Aprowizowanie prywatnego punktu końcowego powiodło się |
| Updating |
Aktualizowanie prywatnego punktu końcowego |
| Deleting |
Usuwanie prywatnego punktu końcowego |
| Failed |
Aprowizowanie prywatnego punktu końcowego nie powiodło się |