Workspaces - Set Inbound Azure Resource Rules

サービス:: Core

API バージョン:: v1

ワークスペースの受信Azureリソースインスタンスルールを設定します。この API を使用すると、ワークスペース管理者は、ワークスペースの許可リストに含まれるAzureリソースインスタンスを制御する受信Azureリソースインスタンスルールを設定できます。現在、この機能はプレビュー段階にあります。

Note

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

アクセス許可

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

必要な委任スコープ

Workspace.ReadWrite.All

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

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

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

Interface

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

URI パラメーター

名前	/	必須	型	説明
workspaceId	path	True	string (uuid)	ワークスペース ID。

要求本文

名前	型	説明
rules	WorkspaceInboundAzureResourceRule[]	ワークスペースに関連付けられている受信Azureリソースインスタンスルールの配列。

応答

名前型説明

200 OK

名前	型	説明
200 OK		要求は正常に完了しました。
429 Too Many Requests	ErrorResponse	サービスレートの制限を超えました。サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す `Retry-After` ヘッダーを返します。ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラーコード: UnknownError - エラーが発生しました。

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

429 Too Many Requests

ErrorResponse

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

ヘッダー

Retry-After: integer

Other Status Codes

ErrorResponse

一般的なエラーコード:

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

例

Set workspace resource instance example

要求のサンプル

HTTP

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

{
  "rules": [
    {
      "displayName": "SQL Server - testsql1",
      "resourceId": "/subscriptions/2374e516-d28b-4898-a39c-6070e078ae31/resourceGroups/testrg/providers/Microsoft.Sql/servers/testsql1"
    },
    {
      "displayName": "Storage Account - teststorageacct",
      "resourceId": "/subscriptions/2374e516-d28b-4898-a39c-6070e078ae31/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorageacct"
    }
  ]
}

応答のサンプル

状態コード:: 200

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
WorkspaceInboundAzureResourceRule	ワークスペースの許可Azureリソースインスタンスを指定する単一の受信Azure リソースインスタンスルールを表します。
WorkspaceInboundAzureResourceRules	ワークスペース用に構成された受信Azureリソースインスタンスルールのコレクションを表します。これらの規則では、ワークスペースへのアクセスを許可するリソースインスタンスAzureを定義します。

ErrorRelatedResource

Object

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

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が理解可能な表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が理解可能な表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

WorkspaceInboundAzureResourceRule

Object

ワークスペースの許可Azureリソースインスタンスを指定する単一の受信Azure リソースインスタンスルールを表します。

名前	型	説明
displayName	string	ルールのわかりやすい表示名。この名前は表示目的でのみ使用され、ルールの機能には影響しません。
resourceId	string	ルール内のリソースの完全なAzure Resource Manager (ARM) リソース ID。これは、 `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}`という形式の一意の識別子です。これは、Azure portal (リソースプロパティ)、Azure CLI (az resource show)、または ARM テンプレートから取得できます。

WorkspaceInboundAzureResourceRules

Object

ワークスペース用に構成された受信Azureリソースインスタンスルールのコレクションを表します。これらの規則では、ワークスペースへのアクセスを許可するリソースインスタンスAzureを定義します。

名前	型	説明
rules	WorkspaceInboundAzureResourceRule[]	ワークスペースに関連付けられている受信Azureリソースインスタンスルールの配列。