Workspaces - Set Outbound Gateway Rules
送信アクセス保護 (OAP) で有効になっているワークスペースのゲートウェイ規則を設定します。 この API を使用すると、ワークスペース管理者は、現在のワークスペースから許可されるオンプレミス /Vnet データ ゲートウェイを制御する送信ネットワーク通信ポリシーのセットを定義、置換、またはオーバーライドできます。 現在、この機能はプレビュー段階にあります。
注
この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。
注
送信アクセス保護規則は、ワークスペースのネットワーク通信ポリシーに outbound.publicAccessRules.defaultAction が Deny に設定されている場合にのみ適用されます。 ワークスペースで OAP が有効になっていない場合、送信接続が制限されていないため、API は失敗します。
注
この API は PUT メソッドを使用し、ワークスペースのすべての送信アクセス ゲートウェイを上書きします。 要求本文で部分的なポリシーが指定されている場合、残りのポリシーは既定値に設定されます。 常に Get を最初に実行し、要求本文で完全なポリシーを指定します。
Permissions
呼び出し元には、管理者 ワークスペース ロール 必要があります。
必要な委任されたスコープ
Workspace.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| アイデンティティ | Support |
|---|---|
| ユーザー | イエス |
| サービス プリンシパルとマネージド ID | イエス |
インターフェイス
PUT https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy/outbound/gateways
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
workspace
|
path | True |
string (uuid) |
更新するワークスペースの一意識別子。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| allowedGateways |
ゲートウェイの送信アクセス動作を定義する規則の一覧。 |
|
| defaultAction |
許可リスト配列に明示的にリストされていないすべてのゲートウェイの既定の動作を定義します。 [許可] に設定すると、指定されていないすべてのゲートウェイが既定で許可されます。 "拒否" に設定すると、指定されていないすべてのゲートウェイがブロックされます。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は正常に完了しました。 ヘッダー ETag: string |
|
| Other Status Codes |
一般的なエラー コード:
|
例
Set workspace outbound access protection gateway rule for example
要求のサンプル
PUT https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/networking/communicationPolicy/outbound/gateways
{
"defaultAction": "Deny",
"allowedGateways": [
{
"id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
},
{
"id": "25bac802-080d-4f73-8a42-1b406eb1fceb"
}
]
}
応答のサンプル
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e
定義
| 名前 | 説明 |
|---|---|
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Gateway |
送信ゲートウェイのアクセス制御動作を定義します。 この列挙型は、既定で送信通信を許可するか拒否するかを指定するために、defaultAction フィールドに使用されます。 この種類により、送信アクセスに対するグローバルな制御とゲートウェイ固有の制御の両方が可能になり、セキュリティで保護された予測可能なネットワーク通信ポリシーを適用できます。 ゲートウェイ アクセス アクションの種類は、時間の経過と同時に追加される場合があります。 |
|
Gateway |
送信通信が許可されているゲートウェイを表します。 このオブジェクトは、発信アクセスを明示的に承認するために allowedGateways 内で使用されます。 |
|
Workspace |
ネットワーク通信ポリシーの一部としてワークスペース用に構成されたゲートウェイ送信アクセス保護規則の完全なセットを表します。 このオブジェクトは、送信通信を制御するゲートウェイルールを定義します。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
GatewayAccessActionType
送信ゲートウェイのアクセス制御動作を定義します。 この列挙型は、既定で送信通信を許可するか拒否するかを指定するために、defaultAction フィールドに使用されます。 この種類により、送信アクセスに対するグローバルな制御とゲートウェイ固有の制御の両方が可能になり、セキュリティで保護された予測可能なネットワーク通信ポリシーを適用できます。 ゲートウェイ アクセス アクションの種類は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Allow |
送信ゲートウェイを許可します。 既定のアクションとして使用すると、すべてのゲートウェイが許可されます。 |
| Deny |
送信ゲートウェイをブロックします。 既定のアクションとして使用すると、明示的に許可されない限り、すべてのゲートウェイが拒否されます。 |
GatewayAccessRuleMetadata
送信通信が許可されているゲートウェイを表します。 このオブジェクトは、発信アクセスを明示的に承認するために allowedGateways 内で使用されます。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string (uuid) |
許可するゲートウェイ ID。 |
WorkspaceOutboundGateways
ネットワーク通信ポリシーの一部としてワークスペース用に構成されたゲートウェイ送信アクセス保護規則の完全なセットを表します。 このオブジェクトは、送信通信を制御するゲートウェイルールを定義します。
| 名前 | 型 | 説明 |
|---|---|---|
| allowedGateways |
ゲートウェイの送信アクセス動作を定義する規則の一覧。 |
|
| defaultAction |
許可リスト配列に明示的にリストされていないすべてのゲートウェイの既定の動作を定義します。 [許可] に設定すると、指定されていないすべてのゲートウェイが既定で許可されます。 "拒否" に設定すると、指定されていないすべてのゲートウェイがブロックされます。 |