Workspaces - Set Inbound External Data Shares Policy

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

ワークスペースの受信外部データ共有バイパス ポリシーを設定します。 この API を使用すると、ワークスペース管理者は外部データ共有トラフィックを許可または拒否して、受信ネットワークの制限をバイパスできます。 現在、この機能はプレビュー段階にあります。

Note

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

Permissions

呼び出し元には、管理者 ワークスペース ロール 必要があります。

必要な委任スコープ

Workspace.ReadWrite.All

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

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

Identity Support
User はい
サービス プリンシパルとマネージド ID はい

Interface

PUT https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy/inbound/externalDataShares

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。

要求ヘッダー

名前 必須 型 説明
If-Match

string

ETag 値。 ETag は引用符で囲む必要があります。 指定した場合、呼び出しは、リソースの ETag が指定された ETag と一致する場合にのみ成功します。

要求本文

名前 型 説明
defaultAction

NetworkAccessRule

外部データ共有トラフィックが受信ネットワーク制限をバイパスできるかどうかを定義します。

応答

名前 型 説明
200 OK

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

ヘッダー

ETag: string
429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

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

例

Set workspace inbound External Data Shares policy example

要求のサンプル

PUT https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/networking/communicationPolicy/inbound/externalDataShares


{
  "defaultAction": "Allow"
}

応答のサンプル

状態コード:
200 
ETag: "e5f6g7h8"

定義

名前 説明
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
NetworkAccessRule

パブリック ネットワークからのワークスペース アクセスの既定のポリシー。 PUT 要求本文から省略すると、このフィールドは既定で Allow に設定され、ネットワーク アクセスが意図せず開かれる可能性があります。 すべての PUT 要求本文で、このフィールドを常に明示的に指定します。
WorkspaceInboundExternalDataSharesPolicy

ワークスペース内の外部データ共有の受信ネットワーク例外ポリシー。

ErrorRelatedResource

Object

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

名前 型 説明
resourceId

string

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

string

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

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

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

boolean

true の場合、要求を再試行できます。 Retry-After応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message

string

エラーの人間が理解可能な表現。
moreDetails

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string (uuid)

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

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

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

string

エラーの人間が理解可能な表現。
relatedResource

ErrorRelatedResource

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

NetworkAccessRule

列挙

パブリック ネットワークからのワークスペース アクセスの既定のポリシー。 PUT 要求本文から省略すると、このフィールドは既定で Allow に設定され、ネットワーク アクセスが意図せず開かれる可能性があります。 すべての PUT 要求本文で、このフィールドを常に明示的に指定します。

値 説明
Allow

すべての接続を許可します。
Deny

すべての接続を拒否します。

WorkspaceInboundExternalDataSharesPolicy

Object

ワークスペース内の外部データ共有の受信ネットワーク例外ポリシー。

名前 型 説明
defaultAction

NetworkAccessRule

外部データ共有トラフィックが受信ネットワーク制限をバイパスできるかどうかを定義します。