Managed Private Endpoints - Create Workspace Managed Private Endpoint
指定したワークスペースにマネージド プライベート エンドポイントを作成します。
注
この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。
Permissions
呼び出し元には、管理者 ワークスペース ロール 必要があります。
必要な委任されたスコープ
Workspace.ReadWrite.All.
Limitations
- マネージド プライベート エンドポイントを作成するには、ワークスペースがサポートされている Fabric 容量上にある必要があります。 詳細については、「Microsoft Fabric ライセンスの種類を参照してください。
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| Identity | Support |
|---|---|
| User | Yes |
| サービス プリンシパルとマネージド ID | Yes |
Interface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/managedPrivateEndpointsURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| name | True |
string |
プライベート エンドポイント名。 64 文字以下にする必要があります。 |
| targetPrivateLinkResourceId | True |
string |
プライベート エンドポイントを作成する必要があるデータ ソースのリソース ID。 |
| requestMessage |
string |
プライベート エンドポイント要求を承認するメッセージ。 140 文字以下にする必要があります。 |
|
| targetFQDNs |
string[] |
プライベート エンドポイントに関連付ける完全修飾ドメイン名 (FQDN)。 20 個を超える FQDN を指定しないでください。 |
|
| targetSubresourceType |
string |
Private-link resoure を指すサブリソース。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 201 Created |
要求は正常に完了しました。 ヘッダー Location: string |
|
| Other Status Codes |
一般的なエラー コード:
|
例
Create a managed private endpoint example
要求のサンプル
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"
}
応答のサンプル
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"
}定義
| 名前 | 説明 |
|---|---|
|
Connection |
プライベート エンドポイント接続の状態。 追加の接続状態は、時間の経過と同時に追加される場合があります。 |
|
Create |
マネージド プライベート エンドポイント要求ペイロードを作成します。 |
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Managed |
マネージド プライベート エンドポイント。 |
|
Private |
プライベート エンドポイントの接続状態 |
|
Private |
エンドポイントのプロビジョニング状態。 |
ConnectionStatus
プライベート エンドポイント接続の状態。 追加の接続状態は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Pending |
承認待ち |
| Approved |
承認されたエンドポイント |
| Rejected |
エンドポイントが拒否されました |
| Disconnected |
エンドポイントが切断されました |
CreateManagedPrivateEndpointRequest
マネージド プライベート エンドポイント要求ペイロードを作成します。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
プライベート エンドポイント名。 64 文字以下にする必要があります。 |
| requestMessage |
string |
プライベート エンドポイント要求を承認するメッセージ。 140 文字以下にする必要があります。 |
| targetFQDNs |
string[] |
プライベート エンドポイントに関連付ける完全修飾ドメイン名 (FQDN)。 20 個を超える FQDN を指定しないでください。 |
| targetPrivateLinkResourceId |
string |
プライベート エンドポイントを作成する必要があるデータ ソースのリソース ID。 |
| targetSubresourceType |
string |
Private-link resoure を指すサブリソース。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
ManagedPrivateEndpoint
マネージド プライベート エンドポイント。
| 名前 | 型 | 説明 |
|---|---|---|
| connectionState |
プロビジョニングされたエンドポイントのエンドポイント接続状態。 |
|
| id |
string (uuid) |
マネージド プライベート エンドポイント ID。 |
| name |
string |
プライベート エンドポイント名。 |
| provisioningState |
エンドポイントのプロビジョニング状態。 |
|
| targetPrivateLinkResourceId |
string |
プライベート エンドポイントが作成されるデータ ソースのリソース ID |
| targetSubresourceType |
string |
Private-link resoure を指すサブリソース。 |
PrivateEndpointConnectionState
プライベート エンドポイントの接続状態
| 名前 | 型 | 説明 |
|---|---|---|
| actionsRequired |
string |
接続を確立するために必要なアクション。 |
| description |
string |
エンドポイントの承認または拒否に関する説明メッセージ (ある場合)。 |
| status |
[接続状態] |
PrivateEndpointProvisioningState
エンドポイントのプロビジョニング状態。
| 値 | 説明 |
|---|---|
| Provisioning |
プロビジョニング中のプライベート エンドポイントが進行中です |
| Succeeded |
プライベート エンドポイントのプロビジョニングに成功しました |
| Updating |
プライベート エンドポイントの更新 |
| Deleting |
プライベート エンドポイントの削除 |
| Failed |
プライベート エンドポイントのプロビジョニングに失敗しました |