Workspaces - Set Git Outbound Policy

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

[送信ポリシー] が [拒否] に設定されている場合は、指定したワークスペースの Git 送信ポリシーを設定します。
この API は PUT メソッドを使用し、すべての設定を上書きします。 ワークスペースが送信ポリシーを制限する場合、ワークスペース管理者は、指定されたワークスペースでの Git 統合の使用を許可する必要があります。 ワークスペースに送信制限がない場合、このプロパティの変更は失敗し、Git 統合設定には影響しません。 常に最初に Git 送信ポリシーの取得操作を呼び出し、要求本文で完全なポリシーを指定します。

Note

要求本文から defaultAction 省略すると、既定で Allow になり、送信アクセスを制限する必要があるときに Git 統合が意図せず許可される可能性があります。 すべての PUT 要求本文で常に defaultAction を明示的に指定します。

Permissions

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

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

Workspace.ReadWrite.All

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

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

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

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。

要求ヘッダー

名前 必須 型 説明
If-Match

string

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

要求本文

名前 型 説明
defaultAction

NetworkAccessRule

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

応答

名前 型 説明
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/outbound/git

{
  "defaultAction": "Allow"
}

応答のサンプル

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

定義

名前 説明
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
NetworkAccessRule

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

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

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

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

NetworkRules

Object

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

名前 型 説明
defaultAction

NetworkAccessRule

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