Freigeben über


Managed Private Endpoints - List Workspace Managed Private Endpoints

Gibt eine Liste der verwalteten privaten Endpunkte zurück, die dem angegebenen Arbeitsbereich zugeordnet sind.

Note

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.

Permissions

Der Anrufer muss Viewer-rolle oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Workspace.Read.All oder Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity Support
User Yes
Service Principal und Verwaltete Identitäten Yes

Interface

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
path True

string (uuid)

Die Arbeitsbereichs-ID.

continuationToken
query

string

Ein Token zum Abrufen der nächsten Seite mit Ergebnissen.

Antworten

Name Typ Beschreibung
200 OK

ManagedPrivateEndpoints

Die Anforderung wurde erfolgreich abgeschlossen.

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • UnknownError – Ein Fehler ist aufgetreten.

Beispiele

List managed private endpoints in workspace example
List managed private endpoints in workspace with continuation example

List managed private endpoints in workspace example

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ConnectionStatus

Verbindungsstatus des privaten Endpunkts. Der zusätzliche Verbindungsstatus kann im Laufe der Zeit hinzugefügt werden.

ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.

ErrorResponse

Die Fehlerantwort.

ErrorResponseDetails

Die Fehlerantwortdetails.

ManagedPrivateEndpoint

Verwalteter privater Endpunkt.

ManagedPrivateEndpoints
PrivateEndpointConnectionState

Verbindungsstatus des privaten Endpunkts

PrivateEndpointProvisioningState

Bereitstellungsstatus des Endpunkts.

ConnectionStatus

Verbindungsstatus des privaten Endpunkts. Der zusätzliche Verbindungsstatus kann im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Pending

Genehmigung ausstehend

Approved

Endpunkt genehmigt

Rejected

Endpunkt abgelehnt

Disconnected

Endpunkt getrennt

ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.

resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.

message

string

Eine lesbare Darstellung des Fehlers.

moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.

relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.

message

string

Eine lesbare Darstellung des Fehlers.

relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

ManagedPrivateEndpoint

Verwalteter privater Endpunkt.

Name Typ Beschreibung
connectionState

PrivateEndpointConnectionState

Endpunktverbindungsstatus der bereitgestellten Endpunkte.

id

string (uuid)

Verwaltete private Endpunkt-ID.

name

string

Der Name des privaten Endpunkts.

provisioningState

PrivateEndpointProvisioningState

Bereitstellungsstatus des Endpunkts.

targetPrivateLinkResourceId

string

Ressourcen-ID der Datenquelle, für die ein privater Endpunkt erstellt wird

targetSubresourceType

string

Unterressource, die auf " Private-Link-Resoure" verweist.

ManagedPrivateEndpoints

Name Typ Beschreibung
continuationToken

string

Das Token für den nächsten Resultsetbatch. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.

continuationUri

string

Der URI des nächsten Resultsetbatches. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.

value

ManagedPrivateEndpoint[]

Eine Liste der verwalteten privaten Endpunkte.

PrivateEndpointConnectionState

Verbindungsstatus des privaten Endpunkts

Name Typ Beschreibung
actionsRequired

string

Zum Herstellen der Verbindung erforderliche Aktionen.

description

string

Beschreibungsmeldung (falls vorhanden) beim Genehmigen oder Ablehnen des Endpunkts.

status

ConnectionStatus

Verbindungsstatus

PrivateEndpointProvisioningState

Bereitstellungsstatus des Endpunkts.

Wert Beschreibung
Provisioning

Privater Endpunkt in der Bereitstellung wird in Bearbeitung

Succeeded

Private Endpunktbereitstellung erfolgreich

Updating

Aktualisierung des privaten Endpunkts

Deleting

Privater Endpunkt wird gelöscht

Failed

Fehler bei der Bereitstellung privater Endpunkte