Workspaces - Set Firewall Rules

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

ワークスペースの IP ファイアウォール規則を設定します。 この API を使用すると、ワークスペース管理者は、ワークスペースへの接続を許可する IP アドレスを制御する IP ファイアウォール規則を設定できます。 この機能は現在プレビュー段階です。

Note

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

Note

ファイアウォール規則は、ワークスペースのネットワーク通信ポリシーに inbound.publicAccessRules.defaultAction が Deny に設定されている場合にのみ適用されます。 ワークスペースでパブリック アクセスがブロックされていない場合、このワークスペースへの API 呼び出しは制限されません。

Note

この API は PUT メソッドを使用し、ワークスペースのすべての IP ファイアウォール規則を上書きします。 常に Get を最初に実行し、すべての IP ファイアウォール規則を要求本文に指定します。

アクセス許可

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

必要な委任スコープ

Workspace.ReadWrite.All

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

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

Identity サポート
ユーザー はい
サービス プリンシパルとマネージド ID はい

Interface

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

更新するワークスペースの一意識別子。

要求本文

名前 型 説明
rules

FirewallRule[]

受信アクセスに許可される IP アドレスを定義する規則の一覧。 各規則には、名前と 1 つの IP アドレス、IP アドレス範囲、または CIDR IP アドレスを含めることができます。 ワークスペースごとに最大 256 個のルールを指定できます。

応答

名前 型 説明
200 OK

要求は正常に完了し、応答本文にコンテンツがありません。

ヘッダー:

ETagstring - 更新後のファイアウォール構成の新しい ETag。 この値は、後続の PUT 呼び出しの If-Match ヘッダーで使用して、オプティミスティック コンカレンシー制御を適用します。
429 Too Many Requests

ErrorResponse

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

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

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

例

Example for setting workspace firewall rules

要求のサンプル

PUT https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/networking/communicationPolicy/inbound/firewall

{
  "rules": [
    {
      "displayName": "SingleIPAddressRule",
      "value": "12.34.56.78"
    },
    {
      "displayName": "IPAddressRangeRule",
      "value": "12.34.56.78-12.34.56.89"
    },
    {
      "displayName": "CidrIPAddressRule",
      "value": "12.34.56.0/24"
    }
  ]
}

応答のサンプル

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

定義

名前 説明
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
FirewallRule

ファイアウォール規則を定義します。ファイアウォール規則は、その名前で識別され、その値として単一の IP アドレス、IP アドレス範囲、または CIDR IP アドレスを含みます。
InboundFirewallConfiguration

このオブジェクトは、ワークスペースのネットワーク通信ポリシーの一部として受信アクセス保護を管理するためのファイアウォール規則の完全なセットを定義します。 これにより、明示的に承認された IP アドレスのみが受信通信に許可されます。 PUT API を介して送信されると、このオブジェクトはワークスペースの既存の IP ファイアウォール構成を作成または完全に置き換えます。 これらの規則は、ワークスペースのネットワーク通信ポリシーで inbound.publicAccessRules.defaultAction が Deny に設定されている場合にのみ適用されます。

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

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

FirewallRule

Object

ファイアウォール規則を定義します。ファイアウォール規則は、その名前で識別され、その値として単一の IP アドレス、IP アドレス範囲、または CIDR IP アドレスを含みます。

名前 型 説明
displayName

string

ルールの名前を指定します。 表示名の長さは最大 128 文字で、ワークスペースごとに一意である必要があります。
value

string

1 つの IP アドレス、IP アドレス範囲、または CIDR IP アドレスとして指定されるルールの値を指定します。

InboundFirewallConfiguration

Object

このオブジェクトは、ワークスペースのネットワーク通信ポリシーの一部として受信アクセス保護を管理するためのファイアウォール規則の完全なセットを定義します。 これにより、明示的に承認された IP アドレスのみが受信通信に許可されます。 PUT API を介して送信されると、このオブジェクトはワークスペースの既存の IP ファイアウォール構成を作成または完全に置き換えます。 これらの規則は、ワークスペースのネットワーク通信ポリシーで inbound.publicAccessRules.defaultAction が Deny に設定されている場合にのみ適用されます。

名前 型 説明
rules

FirewallRule[]

受信アクセスに許可される IP アドレスを定義する規則の一覧。 各規則には、名前と 1 つの IP アドレス、IP アドレス範囲、または CIDR IP アドレスを含めることができます。 ワークスペースごとに最大 256 個のルールを指定できます。