Workspaces - Set Network Communication Policy
指定したワークスペースのネットワーク通信ポリシーを設定します。 この API は PUT メソッドを使用し、すべての設定を上書きします。 要求本文で部分的なポリシーのみが指定されている場合、残りのポリシーは既定値に設定されます。 常に最初にネットワーク通信ポリシーの取得を実行し、要求本文で完全なポリシーを指定します。 この機能は現在プレビュー段階です。
注
この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。
Permissions
呼び出し元には 管理者 ワークスペース ロールが必要です。
必要な委任されたスコープ
Workspace.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID が サポートされます。
| アイデンティティ | Support |
|---|---|
| User | イエス |
| サービス プリンシパル と マネージド ID | イエス |
インターフェイス
PUT https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| If-Match |
string |
ETag 値。 ETag は引用符で囲む必要があります。 指定した場合、呼び出しは、リソースの ETag が指定された ETag と一致する場合にのみ成功します。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| inbound |
ワークスペースの受信ネットワーク通信プロパティ。 |
|
| outbound |
ワークスペースの送信ネットワーク通信プロパティ。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は正常に完了しました。 ヘッダー ETag: string |
|
| Other Status Codes |
一般的なエラー コード:
|
例
Set workspace networking communication policy example
要求のサンプル
PUT https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/networking/communicationPolicy
{
"inbound": {
"publicAccessRules": {
"defaultAction": "Allow"
}
},
"outbound": {
"publicAccessRules": {
"defaultAction": "Deny"
}
}
}
応答のサンプル
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e
定義
| 名前 | 説明 |
|---|---|
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Inbound |
ワークスペースへのすべての受信通信のポリシー。 |
|
Network |
パブリック ネットワークからのワークスペース アクセスの既定のポリシー。 |
|
Network |
パブリック ネットワーク間のワークスペース間のアクセスを定義するポリシー。 |
|
Outbound |
ワークスペースからのすべての送信通信のポリシー。 |
|
Workspace |
ワークスペースのネットワーク通信ポリシー。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
InboundRules
ワークスペースへのすべての受信通信のポリシー。
| 名前 | 型 | 説明 |
|---|---|---|
| publicAccessRules |
パブリック ネットワークからワークスペースへの受信通信のポリシー。 |
NetworkAccessRule
パブリック ネットワークからのワークスペース アクセスの既定のポリシー。
| 値 | 説明 |
|---|---|
| Allow |
すべての接続を許可します。 |
| Deny |
すべての接続を拒否します。 |
NetworkRules
パブリック ネットワーク間のワークスペース間のアクセスを定義するポリシー。
| 名前 | 型 | 説明 |
|---|---|---|
| defaultAction |
パブリック ネットワークからのワークスペース アクセスの既定のポリシー。 |
OutboundRules
ワークスペースからのすべての送信通信のポリシー。
| 名前 | 型 | 説明 |
|---|---|---|
| publicAccessRules |
ワークスペースからパブリック ネットワークへの送信通信のポリシー。 |
WorkspaceNetworkingCommunicationPolicy
ワークスペースのネットワーク通信ポリシー。
| 名前 | 型 | 説明 |
|---|---|---|
| inbound |
ワークスペースの受信ネットワーク通信プロパティ。 |
|
| outbound |
ワークスペースの送信ネットワーク通信プロパティ。 |