管理者向けPower Platform
Power Platform Management Connector では、BAP API で提供される環境ライフサイクル管理機能、DLP ポリシー管理、およびその他の管理機能にアクセスできます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Standard | すべての地域 Power Automate |
| Power Apps | Standard | すべての Power Apps リージョン |
| Power Automate | Standard | すべての地域 Power Automate |
| お問い合わせ | |
|---|---|
| 名前 | Microsoft Power Apps のサポート |
| URL | https://powerapps.microsoft.com/en-us/support/ |
| コネクタ メタデータ | |
|---|---|
| Publisher | Microsoft |
| Website | https://admin.powerplatform.microsoft.com/ |
| プライバシー ポリシー | https://privacy.microsoft.com/en-us/privacystatement |
Power Platform for Admins は、ビジネス アプリケーション プラットフォーム (BAP) API にアクセスするためのコネクタ インターフェイスです。これは、Power Platform 管理センターを運営するのと同じ API である Power Platform の 管理関連リソースを管理するために使用されます。 これには、環境のライフサイクルとアクセス許可、Dataverse プロビジョニング操作、DLP ポリシー、ユーザー同期の管理が含まれます。
[前提条件]
任意のユーザーがこのコネクタへの Microsoft Entra ID 認証接続を作成できます。データはユーザーのスコープに基づいて返されます。
- Power Platform サービス管理者は、このエンドポイントからテナントで使用できるすべてのリソースと操作にアクセスできます。
- 環境管理者は、自分の環境、管理できる DLP ポリシー、または影響を受けるデータと操作にのみアクセスできます。
既知の問題と制限事項
- DLP ポリシーを作成または更新するときに、NULL または Blank() 値を API コネクタ グループ (配列) として渡さないでください。ポリシーが中断され、他の意図しない結果で使用できなくなる可能性があります。 グループにコネクタが含まれていない場合は、空の角かっこ [ ] のセットを渡します。
- 古い DLP 操作は、更新された DLP ブロック されたグループでは機能せず、非推奨とされます。 すべての DLP 操作の "V2" バージョンを使用してください。
- DLP ポリシー グループにはコネクタが自動的に設定されないため、入力パラメーターとして取得、書式設定、追加する必要があります。
- コネクタを格納する配列変数を作成します。
- テナントの既定の環境 ID を変数に保存します。
- Power Platform for App Maker の GetConnectors 操作を使用して、環境のすべてのコネクタを取得します ("environment eq '{environmentName}" というフィルターを使用します。環境名は前の手順のものです)。
- GetConnectors 応答の ID、名前、および型フィールドのみを使用するには、Select 操作を使用します (最後の 'value' 動的コンテンツ オプションを使用します)。 ID、名前、および入力を左側に配置し、id、displayName をマップし、選択アクションの右側に入力します。
- Select の出力を配列変数に保存する
- これらのハードコードされたコネクタを配列変数に追加します (GetConnectors 応答には表示されません)。
[ { "id": "/providers/Microsoft.PowerApps/apis/shared_microsoftspatialservices", "name": "Spatial Services", "type": "Microsoft.PowerApps/apis" }, { "id": "HttpRequestReceived", "name": "When a HTTP request is received", "type": "Microsoft.PowerApps/apis" }, { "id": "HttpWebhook", "name": "HTTP Webhook", "type": "Microsoft.PowerApps/apis" }, { "id": "Http", "name": "HTTP", "type": "Microsoft.PowerApps/apis" } ]
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| CDS データベースの作成 |
指定した環境に新しい CDS インスタンスを作成します。 |
| CDS プロビジョニングの状態を取得する |
プロビジョニング操作の状態を確認するために使用されます。 |
| DLP ポリシー V2 の一覧表示 |
アカウントがアクセスできるすべての DLP ポリシーの一覧を返します。 |
| DLP ポリシー V2 の作成 |
新しい DLP ポリシーを作成します。 |
| DLP ポリシー V2 の更新 |
DLP ポリシーを更新します。 |
| DLP ポリシー V2 を削除する |
DLP ポリシーを削除します。 |
| DLP ポリシー V2 を取得する |
DLP ポリシーを返します。 |
| DLP ポリシーの一覧表示 |
すべてのテナントおよび環境 DLP ポリシーの一覧を返します。 |
| サポートされている場所の一覧表示 |
BAP サービスがサポートされている場所の一覧を返します。 |
| サポートされている環境言語を一覧表示する |
場所に基づいてサポートされている言語の一覧を返します。 |
| サポートされている環境通貨を一覧表示する |
場所に基づいてサポートされている通貨の一覧を返します。 |
| テナント DLP ポリシーの作成 |
新しいテナント DLP ポリシーを作成します。 |
| テナント DLP ポリシーの削除 |
テナント DLP ポリシーを削除します。 |
| テナント DLP ポリシーの更新 |
DLP ポリシーのフィールドを更新します。 |
| テナント DLP ポリシーを取得する |
テナント DLP ポリシーを返します。 |
| データベース プロビジョニングの状態を取得する |
プロビジョニング操作の状態を確認するために使用されます。 |
| ブロック解除可能なコネクタを一覧表示する |
DLP ポリシーでブロックできないコネクタの一覧を返します。 |
| ユーザーを強制的に同期する |
PowerApps ユーザーを CRM に同期するために使用されます。 |
| ライフサイクル操作の状態を取得する |
環境パッチの後に発生するライフサイクル操作の現在の状態を返します。 |
| 仮想コネクタの一覧表示 |
仮想コネクタの一覧を返します。 |
| 環境 DLP ポリシーの作成 |
環境 DLP ポリシーを作成します。 |
| 環境 DLP ポリシーの削除 |
環境 DLP ポリシーを削除します。 |
| 環境 DLP ポリシーの取得 |
環境 DLP ポリシーを返します。 |
| 環境 DLP ポリシーの更新 |
環境 DLP ポリシーを更新します。 |
| 環境の作成 |
新しい環境を作成します。 |
| 環境の削除の検証 |
環境を削除できるかどうかを確認するために使用します。 |
| 環境の操作状態の取得 (プレビュー) |
環境操作の状態を確認するために使用され、削除として sucn。 |
| 環境の更新 |
環境のプロパティを更新します。 |
| 環境を削除する |
環境を削除します。 |
| 環境を管理者として一覧表示する |
環境の一覧を返します。 |
| 環境を管理者として取得する |
1 つの環境を管理者として返します。 |
| 環境ロールの割り当ての編集 |
環境のアクセス許可を設定します。 |
| 環境ロールの割り当てを一覧表示する |
CDS for Apps を使用しない環境のアクセス許可の一覧を返します。 |
CDS データベースの作成
指定した環境に新しい CDS インスタンスを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
基本言語
|
baseLanguage | integer |
List Environment Languages から返されるすべての言語。 |
|
|
通貨コード
|
code | string |
環境通貨の一覧から返される通貨コード。 |
|
|
テンプレート
|
templates | array of string |
プロビジョニング呼び出しに渡す CRM テンプレートの検証済みリスト。 |
戻り値
環境オブジェクト。
- Body
- Environment
CDS プロビジョニングの状態を取得する
プロビジョニング操作の状態を確認するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
Operation
|
operationName | True | string |
操作の名前。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
DLP ポリシー V2 の一覧表示
DLP ポリシー V2 の作成
新しい DLP ポリシーを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
[表示名]
|
displayName | string | ||
|
既定のコネクタの分類
|
defaultConnectorsClassification | string | ||
|
classification
|
classification | True | string | |
|
id
|
id | True | string | |
|
型
|
type | True | string | |
|
名前
|
name | True | string | |
|
ポリシー環境の種類
|
environmentType | string | ||
|
id
|
id | True | string | |
|
型
|
type | True | string | |
|
名前
|
name | True | string |
戻り値
- Body
- PolicyV2
DLP ポリシー V2 の更新
DLP ポリシーを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Policy
|
policy | True | string |
ポリシーの名前フィールド。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
|
|
[表示名]
|
displayName | string | ||
|
既定のコネクタの分類
|
defaultConnectorsClassification | string | ||
|
classification
|
classification | True | string | |
|
id
|
id | True | string | |
|
型
|
type | True | string | |
|
名前
|
name | True | string | |
|
ポリシー環境の種類
|
environmentType | string | ||
|
id
|
id | True | string | |
|
型
|
type | True | string | |
|
名前
|
name | True | string |
戻り値
- Body
- PolicyV2
DLP ポリシー V2 を削除する
DLP ポリシー V2 を取得する
DLP ポリシーの一覧表示
すべてのテナントおよび環境 DLP ポリシーの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
サポートされている場所の一覧表示
BAP サービスがサポートされている場所の一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
- Body
- Locations
サポートされている環境言語を一覧表示する
場所に基づいてサポートされている言語の一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ロケーション
|
environmentLocation | True | string |
環境の場所。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
- Body
- Languages
サポートされている環境通貨を一覧表示する
場所に基づいてサポートされている通貨の一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ロケーション
|
environmentLocation | True | string |
環境の場所。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
- Body
- Currencies
テナント DLP ポリシーの作成
新しいテナント DLP ポリシーを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン
|
api-version | string |
API の日付値。 |
|
|
表示される名前
|
displayName | True | string |
API ポリシーの表示名。 |
|
スキーマのバージョン
|
$schema | True | string |
API ポリシー定義$schema。 |
|
制約の種類
|
type | True | string |
ポリシー制約の種類。すべての環境にポリシーを適用するには、空白のままにします。 |
|
名前
|
name | True | string |
[ポリシー環境名] フィールド。 |
|
ID
|
id | True | string |
[ポリシー環境 ID] フィールド。 |
|
タイプ
|
type | True | string |
[ポリシー環境の種類] フィールド。 |
|
環境フィルターの種類
|
filterType | True | string |
API Policy 制約 environmentFilter1 パラメーター filterType。 |
|
ビジネス データの説明
|
description | string |
ポリシー ビジネス データ グループの説明。 |
|
|
コネクタ ID
|
id | string |
ビジネス データ コネクタ ID フィールド。 |
|
|
コネクタ名
|
name | string |
ビジネス データ コネクタ名フィールド。 |
|
|
コネクタの種類
|
type | string |
ビジネス データ コネクタの種類フィールド。 |
|
|
ビジネス データ以外の説明
|
description | string |
ビジネス データ グループ以外のポリシーの説明。 |
|
|
コネクタ ID
|
id | string |
[Non Business Data Connector ID]\(ビジネス データ コネクタ ID 以外\) フィールド |
|
|
コネクタ名
|
name | string |
[Non Business Data Connector name]\(ビジネス データ 以外のコネクタ名\) フィールド |
|
|
コネクタの種類
|
type | string |
[Non Business Data Connector type]\(ビジネス データ以外のコネクタの種類\) フィールド |
|
|
既定のグループ
|
defaultApiGroup | True | string |
新しいコネクタが自動的に追加されるグループ。 |
|
型
|
type | True | string |
ポリシー ルール apiGroupRule の種類。 |
|
apiGroupの
|
apiGroup | True | string |
ポリシー ルール apiGroupRule パラメーター apiGroup。 |
|
ブロック アクションの種類
|
type | True | string |
ブロック アクションの種類。ブロックを追加する必要がない場合は空白のままにします。 |
戻り値
- Body
- Policy
テナント DLP ポリシーの削除
テナント DLP ポリシーを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Policy
|
policy | True | string |
ポリシーの名前フィールド。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
- response
- object
テナント DLP ポリシーの更新
DLP ポリシーのフィールドを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Policy
|
policy | True | string |
ポリシーの名前フィールド。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
|
|
表示される名前
|
displayName | True | string |
API ポリシーの表示名。 |
|
スキーマのバージョン
|
$schema | True | string |
API ポリシー定義$schema。 |
|
制約の種類
|
type | True | string |
ポリシー制約の種類。すべての環境にポリシーを適用するには、空白のままにします。 |
|
名前
|
name | True | string |
[ポリシー環境名] フィールド。 |
|
ID
|
id | True | string |
[ポリシー環境 ID] フィールド。 |
|
タイプ
|
type | True | string |
[ポリシー環境の種類] フィールド。 |
|
環境フィルターの種類
|
filterType | True | string |
API Policy 制約 environmentFilter1 パラメーター filterType。 |
|
ビジネス データの説明
|
description | string |
ポリシー ビジネス データ グループの説明。 |
|
|
コネクタ ID
|
id | string |
ビジネス データ コネクタ ID フィールド。 |
|
|
コネクタ名
|
name | string |
ビジネス データ コネクタ名フィールド。 |
|
|
コネクタの種類
|
type | string |
ビジネス データ コネクタの種類フィールド。 |
|
|
ビジネス データ以外の説明
|
description | string |
ビジネス データ グループ以外のポリシーの説明。 |
|
|
コネクタ ID
|
id | string |
[Non Business Data Connector ID]\(ビジネス データ コネクタ ID 以外\) フィールド |
|
|
コネクタ名
|
name | string |
[Non Business Data Connector name]\(ビジネス データ 以外のコネクタ名\) フィールド |
|
|
コネクタの種類
|
type | string |
[Non Business Data Connector type]\(ビジネス データ以外のコネクタの種類\) フィールド |
|
|
既定のグループ
|
defaultApiGroup | True | string |
新しいコネクタが自動的に追加されるグループ。 |
|
型
|
type | True | string |
ポリシー ルール apiGroupRule の種類。 |
|
apiGroupの
|
apiGroup | True | string |
ポリシー ルール apiGroupRule パラメーター apiGroup。 |
|
ブロック アクションの種類
|
type | True | string |
ブロック アクションの種類。ブロックを追加する必要がない場合は空白のままにします。 |
戻り値
- Body
- Policy
テナント DLP ポリシーを取得する
テナント DLP ポリシーを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Policy
|
policy | True | string |
ポリシーの名前フィールド。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
- Body
- Policy
データベース プロビジョニングの状態を取得する
プロビジョニング操作の状態を確認するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
Operation
|
operationName | True | string |
操作の名称。 この URI 全体が /provisionInstance から Location ヘッダーとして返され、この値が含まれます。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
ブロック解除可能なコネクタを一覧表示する
DLP ポリシーでブロックできないコネクタの一覧を返します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
ブロック解除可能
|
metadata.unblockable | boolean |
ユーザーを強制的に同期する
PowerApps ユーザーを CRM に同期するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
オブジェクト識別子
|
ObjectId | True | string |
ユーザー オブジェクト ID。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
ライフサイクル操作の状態を取得する
環境パッチの後に発生するライフサイクル操作の現在の状態を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライフサイクル操作
|
lifecycleOperationId | True | string |
ライフサイクル操作の ID。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
仮想コネクタの一覧表示
仮想コネクタの一覧を返します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
virtualConnector
|
metadata.virtualConnector | boolean | |
|
名前
|
metadata.name | string | |
|
型
|
metadata.type | string | |
|
アイコンUri
|
metadata.iconUri | string | |
|
ディスプレイ名
|
metadata.displayName | string |
環境 DLP ポリシーの作成
環境 DLP ポリシーを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン
|
api-version | string |
API の日付値。 |
|
|
環境
|
environment | True | string |
環境の名前。 |
|
表示される名前
|
displayName | True | string |
API ポリシーの表示名。 |
|
スキーマのバージョン
|
$schema | True | string |
API ポリシー定義$schema。 |
|
名前
|
name | True | string |
[ポリシー環境名] フィールド。 |
|
ID
|
id | True | string |
[ポリシー環境 ID] フィールド。 |
|
タイプ
|
type | True | string |
[ポリシー環境の種類] フィールド。 |
|
ビジネス データの説明
|
description | string |
ポリシー ビジネス データ グループの説明。 |
|
|
コネクタ ID
|
id | string |
ビジネス データ コネクタ ID フィールド。 |
|
|
コネクタ名
|
name | string |
ビジネス データ コネクタ名フィールド。 |
|
|
コネクタの種類
|
type | string |
ビジネス データ コネクタの種類フィールド。 |
|
|
ビジネス データ以外の説明
|
description | string |
ビジネス データ グループ以外のポリシーの説明。 |
|
|
コネクタ ID
|
id | string |
[Non Business Data Connector ID]\(ビジネス データ コネクタ ID 以外\) フィールド |
|
|
コネクタ名
|
name | string |
[Non Business Data Connector name]\(ビジネス データ 以外のコネクタ名\) フィールド |
|
|
コネクタの種類
|
type | string |
[Non Business Data Connector type]\(ビジネス データ以外のコネクタの種類\) フィールド |
|
|
既定のグループ
|
defaultApiGroup | True | string |
新しいコネクタが自動的に追加されるグループ。 |
|
型
|
type | True | string |
ポリシー ルール apiGroupRule の種類。 |
|
apiGroupの
|
apiGroup | True | string |
ポリシー ルール apiGroupRule パラメーター apiGroup。 |
|
ブロック アクションの種類
|
type | True | string |
ブロック アクションの種類。ブロックを追加する必要がない場合は空白のままにします。 |
戻り値
- Body
- Policy
環境 DLP ポリシーの削除
環境 DLP ポリシーを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
Policy
|
policy | True | string |
ポリシーの名前フィールド。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
- response
- object
環境 DLP ポリシーの取得
環境 DLP ポリシーを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
Policy
|
policy | True | string |
ポリシーの名前フィールド。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
- Body
- Policy
環境 DLP ポリシーの更新
環境 DLP ポリシーを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
Policy
|
policy | True | string |
ポリシーの名前フィールド。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
|
|
表示される名前
|
displayName | True | string |
API ポリシーの表示名。 |
|
スキーマのバージョン
|
$schema | True | string |
API ポリシー定義$schema。 |
|
名前
|
name | True | string |
[ポリシー環境名] フィールド。 |
|
ID
|
id | True | string |
[ポリシー環境 ID] フィールド。 |
|
タイプ
|
type | True | string |
[ポリシー環境の種類] フィールド。 |
|
ビジネス データの説明
|
description | string |
ポリシー ビジネス データ グループの説明。 |
|
|
コネクタ ID
|
id | string |
ビジネス データ コネクタ ID フィールド。 |
|
|
コネクタ名
|
name | string |
ビジネス データ コネクタ名フィールド。 |
|
|
コネクタの種類
|
type | string |
ビジネス データ コネクタの種類フィールド。 |
|
|
ビジネス データ以外の説明
|
description | string |
ビジネス データ グループ以外のポリシーの説明。 |
|
|
コネクタ ID
|
id | string |
[Non Business Data Connector ID]\(ビジネス データ コネクタ ID 以外\) フィールド |
|
|
コネクタ名
|
name | string |
[Non Business Data Connector name]\(ビジネス データ 以外のコネクタ名\) フィールド |
|
|
コネクタの種類
|
type | string |
[Non Business Data Connector type]\(ビジネス データ以外のコネクタの種類\) フィールド |
|
|
既定のグループ
|
defaultApiGroup | True | string |
新しいコネクタが自動的に追加されるグループ。 |
|
型
|
type | True | string |
ポリシー ルール apiGroupRule の種類。 |
|
apiGroupの
|
apiGroup | True | string |
ポリシー ルール apiGroupRule パラメーター apiGroup。 |
|
ブロック アクションの種類
|
type | True | string |
ブロック アクションの種類。ブロックを追加する必要がない場合は空白のままにします。 |
戻り値
- Body
- Policy
環境の作成
新しい環境を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン
|
api-version | True | string |
API の日付値。 |
|
ロケーション
|
___location | True | string |
環境がデプロイされているリージョン。 |
|
表示される名前
|
displayName | True | string |
環境のバニティ名。 |
|
環境 SKU
|
environmentSku | True | string |
環境の種類。 |
戻り値
環境オブジェクト。
- Body
- Environment
環境の削除の検証
環境を削除できるかどうかを確認するために使用します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
環境の操作状態の取得 (プレビュー)
環境操作の状態を確認するために使用され、削除として sucn。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
Operation
|
operationName | True | string |
操作の名前。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
環境の更新
環境のプロパティを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
|
|
説明
|
description | string | ||
|
ディスプレイ名
|
displayName | string | ||
|
セキュリティグループID
|
securityGroupId | string |
環境を削除する
環境を削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
- response
- object
環境を管理者として一覧表示する
環境の一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン
|
api-version | string |
API の日付値。 |
|
|
トークンのスキップ
|
$skiptoken | string |
応答の次のページを取得するために使用される入力。 |
|
|
ページ サイズ
|
$top | integer |
応答内の環境の数。 |
|
|
プロパティの展開
|
$expand | string |
応答プロパティを展開するためのアクセスを許可します。 |
戻り値
環境を管理者として取得する
1 つの環境を管理者として返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
環境オブジェクト。
- Body
- Environment
環境ロールの割り当ての編集
環境のアクセス許可を設定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
|
|
プリンシパル 電子メール
|
string |
ユーザーのプリンシパル メール。 |
||
|
プリンシパル テナント ID
|
tenantId | string |
ユーザーのプリンシパル テナント ID。 |
|
|
プリンシパル オブジェクト ID
|
id | string |
ユーザーのプリンシパル オブジェクト ID。 |
|
|
プリンシパルの種類
|
type | string |
ユーザーのプリンシパルの種類。 |
|
|
ロール定義 ID
|
id | string |
ロール定義 ID。 形式: /providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/{environment}/{roleName}。 |
|
|
id
|
id | string |
ID フィールド。 |
戻り値
- Body
- RoleAssignment
環境ロールの割り当てを一覧表示する
CDS for Apps を使用しない環境のアクセス許可の一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
環境
|
environment | True | string |
環境の名前。 |
|
API バージョン
|
api-version | string |
API の日付値。 |
戻り値
定義
ResourceArray[Policy]
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of Policy |
Policy
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ポリシー ID
|
id | string |
[ポリシー ID] フィールド。 |
|
ポリシーの種類
|
type | string |
[ポリシーの種類] フィールド。 |
|
ポリシー名
|
name | string |
[ポリシー名] フィールド。 |
|
表示される名前
|
properties.displayName | string |
API ポリシーの表示名。 |
|
作成時間
|
properties.createdTime | date-time |
Api Policy の作成時刻。 |
|
作成者
|
properties.createdBy | Principal[CreatedBy] |
プリンシパル オブジェクトによって作成されたポリシー。 |
|
変更時刻
|
properties.lastModifiedTime | date-time |
Api Policy の変更時刻。 |
|
変更者
|
properties.lastModifiedBy | Principal[ModifiedBy] |
プリンシパル オブジェクトによって変更されたポリシー。 |
|
スキーマのバージョン
|
properties.definition.$schema | PolicySchema |
API ポリシー定義$schema。 |
|
タイプ
|
properties.definition.constraints.environmentFilter1.type | string |
Policy environmentFilter 型。 |
|
Environments
|
properties.definition.constraints.environmentFilter1.parameters.environments | PolicyEnvironments |
ポリシー環境。 |
|
フィルターの種類
|
properties.definition.constraints.environmentFilter1.parameters.filterType | string |
API Policy 制約 environmentFilter1 パラメーター filterType。 |
|
apiGroups
|
properties.definition.apiGroups | PolicyApiGroups | |
|
既定のグループ
|
properties.definition.defaultApiGroup | PolicyDefaultApiGroup |
新しいコネクタが自動的に追加されるグループ。 |
|
ルール
|
properties.definition.rules | PolicyRules |
ポリシー ルール オブジェクト。 |
ResourceArray[PolicyV2]
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of PolicyV2 |
PolicyV2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string | |
|
ディスプレイ名
|
displayName | string | |
|
defaultConnectorsClassification
|
defaultConnectorsClassification | string | |
|
connectorGroups
|
connectorGroups | array of object | |
|
classification
|
connectorGroups.classification | string | |
|
connectors
|
connectorGroups.connectors | array of object | |
|
id
|
connectorGroups.connectors.id | string | |
|
名前
|
connectorGroups.connectors.name | string | |
|
型
|
connectorGroups.connectors.type | string | |
|
環境タイプ
|
environmentType | string | |
|
environments
|
environments | array of object | |
|
id
|
environments.id | string | |
|
型
|
environments.type | string | |
|
名前
|
environments.name | string | |
|
id
|
createdBy.id | string | |
|
ディスプレイ名
|
createdBy.displayName | string | |
|
createdTime(クリcreatedTime)
|
createdTime | string | |
|
id
|
lastModifiedBy.id | string | |
|
ディスプレイ名
|
lastModifiedBy.displayName | string | |
|
最終更新時刻
|
lastModifiedTime | string | |
|
isLegacySchemaVersion
|
isLegacySchemaVersion | boolean |
ResourceArray[環境]
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of Environment |
環境値オブジェクト配列。 |
|
次のリンク
|
nextLink | string |
環境の一覧の次のページを取得する URL。 |
環境
環境オブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
[環境 ID] フィールド。 |
|
タイプ
|
type | string |
[環境の種類] フィールド。 |
|
名前
|
name | string |
[環境名] フィールド。 |
|
ロケーション
|
___location | string |
[環境の場所] フィールド。 |
|
Azure リージョン ヒント
|
properties.azureRegionHint | string |
Environment azureRegionHint フィールド。 |
|
表示される名前
|
properties.displayName | string |
環境の表示名。 |
|
作成時刻
|
properties.createdTime | date-time |
環境の作成時刻。 |
|
作成者
|
properties.createdBy | Principal[CreatedBy] |
プリンシパル オブジェクトによって作成されたポリシー。 |
|
最終更新時刻
|
properties.lastModifiedTime | date-time |
環境 lastModified の日付と時刻。 |
|
変更者
|
properties.lastModifiedBy | Principal[ModifiedBy] |
プリンシパル オブジェクトによって変更されたポリシー。 |
|
プロビジョニングの状態
|
properties.provisioningState | string |
Environment provisioningState。 |
|
キャパシティ
|
properties.capacity | array of object | |
|
容量タイプ
|
properties.capacity.capacityType | string | |
|
actualConsumption
|
properties.capacity.actualConsumption | number | |
|
ratedConsumption
|
properties.capacity.ratedConsumption | number | |
|
capacityUnit
|
properties.capacity.capacityUnit | string | |
|
updatedOn
|
properties.capacity.updatedOn | string | |
|
addons
|
properties.addons | array of object | |
|
アドオンタイプ
|
properties.addons.addonType | string | |
|
割り当て られた
|
properties.addons.allocated | number | |
|
addonUnit
|
properties.addons.addonUnit | string | |
|
作成の種類
|
properties.creationType | string |
環境の作成の種類。 |
|
環境 SKU
|
properties.environmentSku | string |
環境の SKU ID。 |
|
環境の種類
|
properties.environmentType | string |
環境の種類。 |
|
既定値
|
properties.isDefault | boolean |
既定の環境かどうか。 |
|
Business App Platform
|
properties.runtimeEndpoints.microsoft.BusinessAppPlatform | string |
BusinessAppPlatform ランタイム エンドポイント。 |
|
Common Data Model
|
properties.runtimeEndpoints.microsoft.CommonDataModel | string |
CommonDataModel ランタイム エンドポイント。 |
|
PowerApps
|
properties.runtimeEndpoints.microsoft.PowerApps | string |
PowerApps ランタイム エンドポイント。 |
|
Flow
|
properties.runtimeEndpoints.microsoft.Flow | string |
フロー ランタイム エンドポイント。 |
|
論理的に削除された時間
|
properties.softDeletedTime | date-time |
環境 softDeletedTime。 |
|
タイプ
|
properties.linkedEnvironmentMetadata.type | string |
環境 linkedEnvironmentMetadata 型。 |
|
リソース ID
|
properties.linkedEnvironmentMetadata.resourceId | string |
環境 linkedEnvironmentMetadata resourceId。 |
|
親しみやすい名前
|
properties.linkedEnvironmentMetadata.friendlyName | string |
環境 linkedEnvironmentMetadata friendlyName。 |
|
一意の名前
|
properties.linkedEnvironmentMetadata.uniqueName | string |
環境 linkedEnvironmentMetadata uniqueName。 |
|
ドメイン名
|
properties.linkedEnvironmentMetadata.domainName | string |
環境 linkedEnvironmentMetadata domainName。 |
|
バージョン
|
properties.linkedEnvironmentMetadata.version | string |
環境 linkedEnvironmentMetadata バージョン。 |
|
インスタンス URL
|
properties.linkedEnvironmentMetadata.instanceUrl | string |
環境 linkedEnvironmentMetadata instanceUrl。 |
|
インスタンス API URL
|
properties.linkedEnvironmentMetadata.instanceApiUrl | string |
環境 linkedEnvironmentMetadata instanceApiUrl。 |
|
基本言語
|
properties.linkedEnvironmentMetadata.baseLanguage | integer |
環境 linkedEnvironmentMetadata baseLanguage。 |
|
インスタンスの状態
|
properties.linkedEnvironmentMetadata.instanceState | string |
環境 linkedEnvironmentMetadata instanceState。 |
|
作成時刻
|
properties.linkedEnvironmentMetadata.createdTime | date-time |
環境 linkedEnvironmentMetadata createdTime。 |
|
変更時刻
|
properties.linkedEnvironmentMetadata.modifiedTime | date-time |
環境 linkedEnvironmentMetadata modifiedTime。 |
|
ホスト名サフィックス
|
properties.linkedEnvironmentMetadata.hostNameSuffix | string |
環境 linkedEnvironmentMetadata hostNameSuffix。 |
|
BAP ソリューション ID
|
properties.linkedEnvironmentMetadata.bapSolutionId | string |
環境 linkedEnvironmentMetadata bapSolutionId。 |
|
作成テンプレート
|
properties.linkedEnvironmentMetadata.creationTemplates | array of string |
環境 linkedEnvironmentMetadata creationTemplates。 |
|
管理パッケージのバージョン
|
properties.linkedEnvironmentMetadata.managementPackageVersion | string |
環境 linkedEnvironmentMetadata managementPackageVersion。 |
PolicyEnvironments
ポリシー環境。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
[ポリシー環境名] フィールド。 |
|
ID
|
id | string |
[ポリシー環境 ID] フィールド。 |
|
タイプ
|
type | string |
[ポリシー環境の種類] フィールド。 |
PolicyRules
ポリシー ルール オブジェクト。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
型
|
apiGroupRule.type | string |
ポリシー ルール apiGroupRule の種類。 |
|
apiGroupの
|
apiGroupRule.parameters.apiGroup | string |
ポリシー ルール apiGroupRule パラメーター apiGroup。 |
|
ブロック アクションの種類
|
apiGroupRule.actions.blockAction.type | string |
ブロック アクションの種類。ブロックを追加する必要がない場合は空白のままにします。 |
PolicySchema
PolicyApiGroups
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
hbi
|
hbi | PolicyHbi |
ポリシー Hbi グループ。 |
|
lbi
|
lbi | PolicyLbi |
PolicyHbi
ポリシー Hbi グループ。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ビジネス データの説明
|
description | string |
ポリシー ビジネス データ グループの説明。 |
|
ビジネス データ
|
apis | array of object |
ビジネス データ API。 |
|
コネクタ ID
|
apis.id | string |
ビジネス データ コネクタ ID フィールド。 |
|
コネクタ名
|
apis.name | string |
ビジネス データ コネクタ名フィールド。 |
|
コネクタの種類
|
apis.type | string |
ビジネス データ コネクタの種類フィールド。 |
PolicyLbi
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ビジネス データ以外の説明
|
description | string |
ビジネス データ グループ以外のポリシーの説明。 |
|
ビジネス 以外のデータ
|
apis | array of object |
ビジネス データ以外の API。 |
|
コネクタ ID
|
apis.id | string |
[Non Business Data Connector ID]\(ビジネス データ コネクタ ID 以外\) フィールド |
|
コネクタ名
|
apis.name | string |
[Non Business Data Connector name]\(ビジネス データ 以外のコネクタ名\) フィールド |
|
コネクタの種類
|
apis.type | string |
[Non Business Data Connector type]\(ビジネス データ以外のコネクタの種類\) フィールド |
PolicyDefaultApiGroup
ValidateDeleteResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
削除可能
|
canInitiateDelete | boolean |
環境は削除できます。 |
|
Errors 配列
|
errors | array of object |
Errors 配列 |
|
Code
|
errors.error.code | string |
削除の検証のエラー コード。 |
|
メッセージ
|
errors.error.message | string |
エラー メッセージ。 |
|
resourcesToBeDeleted
|
resourcesToBeDeleted | array of object | |
|
ID
|
resourcesToBeDeleted.id | string |
削除されるリソース ID。 |
|
名前
|
resourcesToBeDeleted.name | string |
削除するリソースの名前。 |
|
タイプ
|
resourcesToBeDeleted.type | string |
削除するリソースの種類。 |
ResourceArray[RoleAssignment]
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of object |
環境ロールの割り当て値オブジェクト配列。 |
|
id
|
value.id | string |
[環境ロールの割り当て ID] フィールド。 |
|
型
|
value.type | string |
[環境ロールの割り当ての種類] フィールド。 |
|
名前
|
value.name | string |
[環境ロールの割り当て] フィールド名。 |
|
スコープ
|
value.properties.scope | string |
環境ロールの割り当てスコープ。 |
|
id
|
value.properties.roleDefinition.id | string |
[環境ロールの割り当て] roleDefinition ID フィールド。 |
|
型
|
value.properties.roleDefinition.type | string |
[環境ロールの割り当て] roleDefinition 型フィールド。 |
|
名前
|
value.properties.roleDefinition.name | string |
[環境ロールの割り当て] roleDefinition フィールド名。 |
|
id
|
value.properties.principal.id | string |
環境ロールの割り当てプリンシパル オブジェクト ID。 |
|
ディスプレイ名
|
value.properties.principal.displayName | string |
環境ロールの割り当てプリンシパルの displayName。 |
|
メール
|
value.properties.principal.email | string |
環境ロールの割り当てプリンシパルの電子メール。 |
|
型
|
value.properties.principal.type | string |
環境ロールの割り当てプリンシパルの種類。 |
役割割り当て
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
add
|
add | array of object |
環境ロールの割り当てでオブジェクトを追加します。 |
|
id
|
add.roleAssignment.id | string |
[環境ロールの割り当てロールの割り当て ID] フィールド。 |
|
型
|
add.roleAssignment.type | string |
[環境ロールの割り当て] roleAssignment 型フィールド。 |
|
名前
|
add.roleAssignment.name | string |
[Environment Role Assignment roleAssignment name]\(環境ロールの割り当て\) roleAssignment name フィールド。 |
|
スコープ
|
add.roleAssignment.properties.scope | string |
環境ロールの割り当てスコープ。 |
|
id
|
add.roleAssignment.properties.roleDefinition.id | string |
[環境ロールの割り当て] roleDefinition ID フィールド。 |
|
型
|
add.roleAssignment.properties.roleDefinition.type | string |
[環境ロールの割り当て] roleDefinition ID フィールド。 |
|
名前
|
add.roleAssignment.properties.roleDefinition.name | string |
[Environment Role Assignment roleDefinition name]\(環境ロールの割り当て\) roleDefinition name フィールド。 |
|
id
|
add.roleAssignment.properties.principal.id | string |
環境ロールの割り当てプリンシパル オブジェクト ID。 |
|
ディスプレイ名
|
add.roleAssignment.properties.principal.displayName | string |
環境ロールの割り当てプリンシパルの displayName。 |
|
メール
|
add.roleAssignment.properties.principal.email | string |
環境ロールの割り当てプリンシパルの電子メール。 |
|
型
|
add.roleAssignment.properties.principal.type | string |
環境ロールの割り当てプリンシパルの種類。 |
|
httpStatus
|
add.httpStatus | string |
環境ロールの割り当て httpStatus。 |
Principal[ModifiedBy]
プリンシパル オブジェクトによって変更されたポリシー。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
プリンシパル オブジェクト ID によって変更されました。 |
|
[表示名]
|
displayName | string |
プリンシパル displayName によって変更されました。 |
|
Email
|
string |
プリンシパルによって変更されました。 |
|
|
タイプ
|
type | string |
プリンシパルの種類によって変更されます。 |
|
テナント ID
|
tenantId | string |
プリンシパル テナント ID によって変更されました。 |
|
UPN
|
userPrincipalName | string |
userPrincipalName によって変更されました。 |
Principal[CreatedBy]
プリンシパル オブジェクトによって作成されたポリシー。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
Api Policy 作成者プリンシパル オブジェクト ID。 |
|
[表示名]
|
displayName | string |
Api Policy 作成者プリンシパルの displayName。 |
|
Email
|
string |
Api Policy 作成者プリンシパルの電子メール。 |
|
|
タイプ
|
type | string |
Api Policy 作成者プリンシパルの種類。 |
|
テナント ID
|
tenantId | string |
Api Policy 作成者プリンシパル テナント ID。 |
|
UPN
|
userPrincipalName | string |
Api Policy Creator userPrincipalName。 |
Locations
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of object | |
|
ID
|
value.id | string |
場所 ID。 |
|
名前
|
value.name | string |
場所名。 |
|
表示される名前
|
value.properties.displayName | string |
場所の表示名。 |
|
既定値
|
value.properties.isDefault | boolean |
既定の場所です。 |
|
無効
|
value.properties.isDisabled | boolean |
場所は無効です。 |
通貨
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of object | |
|
ID
|
value.id | string |
通貨 ID。 |
|
名前
|
value.name | string |
通貨名。 |
|
ロケール ID
|
value.properties.localeId | integer |
通貨のロケール ID。 |
|
ローカライズされた名前
|
value.properties.localizedName | string |
通貨のローカライズされた名前。 |
|
表示される名前
|
value.properties.displayName | string |
通貨の表示名。 |
Languages
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of object | |
|
名前
|
value.name | string |
言語名フィールド。 |
|
ID
|
value.id | string |
言語 ID フィールド。 |
|
タイプ
|
value.type | string |
言語の種類フィールド。 |
|
ロケール ID
|
value.properties.localeId | integer |
言語ロケール ID フィールド。 |
|
ローカライズされた名前
|
value.properties.localizedName | string |
言語のローカライズされた名前フィールド。 |
|
表示される名前
|
value.properties.displayName | string |
言語表示名フィールド。 |
|
テナントの既定値
|
value.properties.isTenantDefault | boolean |
言語はテナントの既定のフィールドです。 |
オブジェクト
これは型 'object' です。