Workspaces - Set Network Communication Policy

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

指定したワークスペースのネットワーク通信ポリシーを設定します。
この API は PUT メソッドを使用し、すべての設定を上書きします。 要求本文で一部のポリシーのみが指定されている場合、残りの設定は既定値に設定されます。 常に最初にネットワーク通信ポリシーの取得操作を呼び出し、要求本文で完全なポリシーを指定します。

Note

要求本文から defaultAction を省略すると、既定で Allow になり、受信および送信ネットワーク アクセスが意図せずに開かれる可能性があります。 すべての PUT 要求本文で常に defaultAction を明示的に指定します。

Permissions

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

必要な委任されたスコープ

Workspace.ReadWrite.All

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

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

アイデンティティ Support
User イエス
サービス プリンシパルとマネージド ID イエス

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。

要求ヘッダー

名前 必須 型 説明
If-Match

string

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

要求本文

名前 型 説明
inbound

InboundRules

ワークスペースの受信ネットワーク通信プロパティ。
outbound

OutboundRules

ワークスペースの送信ネットワーク通信プロパティ。

応答

名前 型 説明
200 OK

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

ヘッダー

ETag: string
429 Too Many Requests

ErrorResponse

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

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

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

例

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"
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e

定義

名前 説明
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
InboundRules

ワークスペースへのすべての受信通信のポリシー。
NetworkAccessRule

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

パブリック ネットワーク間のワークスペース間のアクセスを定義するポリシー。
OutboundRules

ワークスペースからのすべての送信通信のポリシー。
WorkspaceNetworkingCommunicationPolicy

ワークスペースのネットワーク通信ポリシー。

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

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

InboundRules

Object

ワークスペースへのすべての受信通信のポリシー。

名前 型 説明
publicAccessRules

NetworkRules

パブリック ネットワークからワークスペースへの受信通信のポリシー。

NetworkAccessRule

列挙

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

値 説明
Allow

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

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

NetworkRules

Object

パブリック ネットワーク間のワークスペース間のアクセスを定義するポリシー。

名前 型 説明
defaultAction

NetworkAccessRule

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

OutboundRules

Object

ワークスペースからのすべての送信通信のポリシー。

名前 型 説明
publicAccessRules

NetworkRules

ワークスペースからパブリック ネットワークへの送信通信のポリシー。

WorkspaceNetworkingCommunicationPolicy

Object

ワークスペースのネットワーク通信ポリシー。

名前 型 説明
inbound

InboundRules

ワークスペースの受信ネットワーク通信プロパティ。
outbound

OutboundRules

ワークスペースの送信ネットワーク通信プロパティ。