Managed Private Endpoints - List Workspace Managed Private Endpoints

Usługa:: Core

Wersja interfejsu API:: v1

Zwraca listę zarządzanych prywatnych punktów końcowych skojarzonych z określonym obszarem 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ć 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

Z parametrami opcjonalnymi:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/managedPrivateEndpoints?continuationToken={continuationToken}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.
continuationToken	query		string	Token do pobierania następnej strony wyników.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ManagedPrivateEndpoints	Żądanie zostało ukończone pomyślnie.
Other Status Codes	ErrorResponse	Typowe kody błędów: UnknownError — wystąpił błąd.

Nazwa

Typ

Opis

200 OK

ManagedPrivateEndpoints

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

Other Status Codes

ErrorResponse

Typowe kody błędów:

UnknownError — wystąpił błąd.

Przykłady

List managed private endpoints in workspace example

List managed private endpoints in workspace with continuation example

List managed private endpoints in workspace example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "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"
    },
    {
      "id": "1b56faf6-9cb8-4506-8c6c-83e0aece804f",
      "name": "BlobPE",
      "targetPrivateLinkResourceId": "/subscriptions/73310022-c811-4844-8b73-f9baa17c0d08/resourceGroups/testRG2/providers/Microsoft.Storage/storageAccounts/storage1",
      "provisioningState": "Succeeded",
      "connectionState": {
        "status": "Approved",
        "description": "Endpoint approval provided"
      },
      "targetSubresourceType": "blob"
    }
  ]
}

List managed private endpoints in workspace with continuation example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "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"
    },
    {
      "id": "1b56faf6-9cb8-4506-8c6c-83e0aece804f",
      "name": "BlobPE",
      "targetPrivateLinkResourceId": "/subscriptions/73310022-c811-4844-8b73-f9baa17c0d08/resourceGroups/testRG2/providers/Microsoft.Storage/storageAccounts/storage1",
      "provisioningState": "Succeeded",
      "connectionState": {
        "status": "Approved",
        "description": "Endpoint approval provided"
      },
      "targetSubresourceType": "blob"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definicje

Nazwa	Opis
ConnectionStatus	Stan połączenia prywatnego punktu końcowego. W czasie może zostać dodany dodatkowy stan połączenia.
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.
ManagedPrivateEndpoints
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

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.