Workspaces - Get Outbound Cloud Connection Rules
送信アクセス保護 (OAP) で有効になっているワークスペースのクラウド接続規則を返します。 この API は、ワークスペース管理者がクラウド接続に適用される効果的な送信ネットワーク通信ポリシーを表示できるように設計されています。 送信アクセス保護クラウド接続規則は、ワークスペースのネットワーク通信ポリシーが [拒否] に設定 outbound.publicAccessRules.defaultAction 場合にのみ返され、適用されます。 ワークスペースで OAP が有効になっていない場合、送信接続が制限されていないため、API は失敗します。 現在、この機能はプレビュー段階にあります。
注
この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。
Permissions
呼び出し元には、ビューアー 以上のワークスペース ロールが必要です。
必要な委任されたスコープ
Workspace.Read.All または Workspace.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| アイデンティティ | Support |
|---|---|
| ユーザー | イエス |
| サービス プリンシパルとマネージド ID | イエス |
インターフェイス
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy/outbound/connectionsURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
workspace
|
path | True |
string (uuid) |
送信規則が照会されているワークスペースの一意識別子。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は正常に完了しました。 ヘッダー ETag: string |
|
| Other Status Codes |
一般的なエラー コード:
|
例
Get workspace outbound access protection cloud connection rule for example
要求のサンプル
GET https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/networking/communicationPolicy/outbound/connections
応答のサンプル
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e{
"defaultAction": "Deny",
"rules": [
{
"connectionType": "SQL",
"defaultAction": "Deny",
"allowedEndpoints": [
{
"hostNamePattern": "*.microsoft.com"
}
]
},
{
"connectionType": "LakeHouse",
"defaultAction": "Deny",
"allowedWorkspaces": [
{
"workspaceId": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
}
]
},
{
"connectionType": "Web",
"defaultAction": "Allow"
}
]
}定義
| 名前 | 説明 |
|---|---|
|
Connection |
送信接続のアクセス制御動作を定義します。 この列挙型は、既定で送信通信を許可するか拒否するかを指定するために、defaultAction フィールドに使用されます。 この種類により、送信アクセスに対するグローバルな制御と接続固有の制御の両方が可能になり、セキュリティで保護された予測可能なネットワーク通信ポリシーを適用できます。 接続アクセス アクションの種類は、時間の経過と同時に追加される場合があります。 |
|
Connection |
特定の外部ドメインまたはホストへの送信通信を許可する単一のエンドポイント レベルの例外ルールを表します。 このオブジェクトは、特定の connectionType の信頼されたエンドポイントへの送信アクセスを明示的に承認するために、接続規則の allowedEndpoints 配列内で使用されます。 これは、エンドポイント ベースのフィルター処理 (SQL、MySQL、Web など) をサポートする接続の種類にのみ適用されます。 |
|
Connection |
特定の connectionType の特定のワークスペースへの送信通信を許可するワークスペース レベルの例外ルールを表します。 このオブジェクトは、ワークスペース間アクセスを明示的に承認するために、接続規則の allowedWorkspaces 配列内で使用されます。 これは、Lakehouse、Warehouse、FabricSql、PowerPlatformDataflows などのワークスペース ベースのフィルター処理をサポートする接続の種類にのみ適用されます。 |
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Outbound |
特定のクラウド接続の送信アクセス規則を定義します。 |
|
Workspace |
ネットワーク通信ポリシーの一部としてワークスペース用に構成された送信アクセス保護クラウド接続規則の完全なセットを表します。 このオブジェクトは、送信通信で許可または拒否される外部エンドポイントとワークスペースを制御する接続規則を定義します。 |
ConnectionAccessActionType
送信接続のアクセス制御動作を定義します。 この列挙型は、既定で送信通信を許可するか拒否するかを指定するために、defaultAction フィールドに使用されます。 この種類により、送信アクセスに対するグローバルな制御と接続固有の制御の両方が可能になり、セキュリティで保護された予測可能なネットワーク通信ポリシーを適用できます。 接続アクセス アクションの種類は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Allow |
送信接続を許可します。 既定のアクションとして使用すると、すべてのクラウド接続が許可されます。 |
| Deny |
送信接続をブロックします。 既定のアクションとして使用すると、明示的に許可されない限り、すべてのクラウド接続が拒否されます。 |
ConnectionRuleEndpointMetadata
特定の外部ドメインまたはホストへの送信通信を許可する単一のエンドポイント レベルの例外ルールを表します。 このオブジェクトは、特定の connectionType の信頼されたエンドポイントへの送信アクセスを明示的に承認するために、接続規則の allowedEndpoints 配列内で使用されます。 これは、エンドポイント ベースのフィルター処理 (SQL、MySQL、Web など) をサポートする接続の種類にのみ適用されます。
| 名前 | 型 | 説明 |
|---|---|---|
| hostNamePattern |
string |
許可される外部エンドポイントを定義するワイルドカードでサポートされるパターン。 例としては、*.microsoft.com、api.contoso.com、または data.partner.org があります。 |
ConnectionRuleWorkspaceMetadata
特定の connectionType の特定のワークスペースへの送信通信を許可するワークスペース レベルの例外ルールを表します。 このオブジェクトは、ワークスペース間アクセスを明示的に承認するために、接続規則の allowedWorkspaces 配列内で使用されます。 これは、Lakehouse、Warehouse、FabricSql、PowerPlatformDataflows などのワークスペース ベースのフィルター処理をサポートする接続の種類にのみ適用されます。
| 名前 | 型 | 説明 |
|---|---|---|
| workspaceId |
string (uuid) |
現在のワークスペースからの接続が許可されているターゲット ワークスペースの一意識別子 (GUID)。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
OutboundConnectionRule
特定のクラウド接続の送信アクセス規則を定義します。
| 名前 | 型 | 説明 |
|---|---|---|
| allowedEndpoints |
connectionType に対して明示的に許可されている外部エンドポイントの一覧を定義します。 配列内の各エントリは、ワークスペースからの送信通信で許可されるホスト名パターンを表します。 このフィールドは、エンドポイントベースのフィルター処理 (SQL、MySQL、Web など) をサポートする接続の種類にのみ適用されます。 接続の種類に対して defaultAction が "Deny" に設定されている場合は、ここに記載されているエンドポイントのみが許可されます。それ以外はすべてブロックされます。 |
|
| allowedWorkspaces |
指定されたファブリック connectionType の送信通信で明示的に許可されるワークスペース ID の一覧を指定します。 このフィールドは、ワークスペース ベースのフィルター処理をサポートするファブリック接続の種類にのみ適用されます。これは、Lakehouse、Warehouse、FabricSql、PowerPlatformDataflows に限定されます。 接続の種類に defaultAction が "Deny" に設定されている場合、allowedWorkspaces に一覧表示されているワークスペースのみが送信アクセスに許可されます。それ以外はすべてブロックされます。 |
|
| connectionType |
string |
規則が適用されるクラウド接続の種類を指定します。 他のルール プロパティ (allowedEndpoints や allowedWorkspaces など) の動作と適用可能性は、接続の種類の機能によって異なる場合があります。 |
| defaultAction |
connectionType の既定の送信アクセス動作を定義します。 このフィールドは、allowedEndpoints または allowedWorkspaces によってさらに調整されない限り、この型の接続が既定で許可されるかブロックされるかを決定します。 [許可] に設定されている場合: この種類のすべての接続は、より具体的な規則によって明示的に拒否されない限り許可されます。 このフィールドは、各接続の種類をきめ細かく制御し、defaultAction で定義されているグローバル フォールバック動作を補完します。 |
WorkspaceOutboundConnections
ネットワーク通信ポリシーの一部としてワークスペース用に構成された送信アクセス保護クラウド接続規則の完全なセットを表します。 このオブジェクトは、送信通信で許可または拒否される外部エンドポイントとワークスペースを制御する接続規則を定義します。
| 名前 | 型 | 説明 |
|---|---|---|
| defaultAction |
規則配列に明示的に一覧表示されていないすべてのクラウド接続の種類の既定の動作を定義します。 [許可] に設定すると、指定されていないすべての接続の種類が既定で許可されます。 "拒否" に設定すると、明示的に許可されない限り、未指定の接続の種類はすべて既定でブロックされます。 この設定はグローバル フォールバック ポリシーとして機能し、既知の信頼された接続のみを許可する必要がある環境でセキュリティで保護された既定の体制を適用するために重要です。 |
|
| rules |
特定のクラウド接続の種類に対する送信アクセス動作を定義する規則の一覧。 各ルールには、サポートされている接続の種類に応じて、エンドポイントベースまたはワークスペースベースの制限が含まれる場合があります。 |