次の方法で共有

Managed Private Endpoints - List Workspace Managed Private Endpoints

サービス:
Core
API バージョン:
v1

指定したワークスペースに関連付けられているマネージド プライベート エンドポイントの一覧を返します。

注

この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。

Permissions

呼び出し元には、ビューアー 以上のワークスペース ロールが必要です。

必要な委任されたスコープ

Workspace.Read.All または Workspace.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

Identity Support
User Yes
サービス プリンシパルとマネージド ID 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 パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。
continuationToken
 query

string

結果の次のページを取得するためのトークン。

応答

名前 型 説明
200 OK

ManagedPrivateEndpoints

要求は正常に完了しました。
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • UnknownError - エラーが発生しました。

例

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

List managed private endpoints in workspace example

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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"
}

定義

名前 説明
ConnectionStatus

プライベート エンドポイント接続の状態。 追加の接続状態は、時間の経過と同時に追加される場合があります。
ErrorRelatedResource

エラー関連のリソース詳細オブジェクト。
ErrorResponse

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
ManagedPrivateEndpoint

マネージド プライベート エンドポイント。
ManagedPrivateEndpoints
PrivateEndpointConnectionState

プライベート エンドポイントの接続状態
PrivateEndpointProvisioningState

エンドポイントのプロビジョニング状態。

ConnectionStatus

列挙

プライベート エンドポイント接続の状態。 追加の接続状態は、時間の経過と同時に追加される場合があります。

値 説明
Pending

承認保留中
Approved

承認されたエンドポイント
Rejected

エンドポイントが拒否されました
Disconnected

エンドポイントが切断されました

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前 型 説明
resourceId

string

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。
requestId

string

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

ManagedPrivateEndpoint

Object

マネージド プライベート エンドポイント。

名前 型 説明
connectionState

PrivateEndpointConnectionState

プロビジョニングされたエンドポイントのエンドポイント接続状態。
id

string (uuid)

マネージド プライベート エンドポイント ID。
name

string

プライベート エンドポイント名。
provisioningState

PrivateEndpointProvisioningState

エンドポイントのプロビジョニング状態。
targetPrivateLinkResourceId

string

プライベート エンドポイントが作成されるデータ ソースのリソース ID
targetSubresourceType

string

Private-link resoure を指すサブリソース。

ManagedPrivateEndpoints

Object
名前 型 説明
continuationToken

string

次の結果セット バッチのトークン。 これ以上レコードがない場合は、応答から削除されます。
continuationUri

string

次の結果セット バッチの URI。 これ以上レコードがない場合は、応答から削除されます。
value

ManagedPrivateEndpoint[]

マネージド プライベート エンドポイントの一覧。

PrivateEndpointConnectionState

Object

プライベート エンドポイントの接続状態

名前 型 説明
actionsRequired

string

接続を確立するために必要なアクション。
description

string

エンドポイントの承認または拒否に関する説明メッセージ (ある場合)。
status

ConnectionStatus

[接続状態]

PrivateEndpointProvisioningState

列挙

エンドポイントのプロビジョニング状態。

値 説明
Provisioning

プロビジョニング中のプライベート エンドポイントが進行中です
Succeeded

プライベート エンドポイントのプロビジョニングに成功しました
Updating

プライベート エンドポイントの更新
Deleting

プライベート エンドポイントの削除
Failed

プライベート エンドポイントのプロビジョニングに失敗しました