Power Platform for Admins
Power Platform 管理コネクタを使用すると、BAP API で提供される環境ライフサイクル管理、DLP ポリシー管理、およびその他の管理機能にアクセスできます。
このコネクタは、次の製品および地域で利用可能です:
サービス | クラス | リージョン |
---|---|---|
Power Automate | Standard | すべての Power Automate 地域 |
Power Apps | Standard | すべての Power Apps 地域 |
お問い合わせ先 | |
---|---|
件名 | Microsoft Power Apps サポート |
[URL] | https://powerapps.microsoft.com/en-us/support/ |
Connector Metadata | |
---|---|
パブリッシャー | Microsoft |
Web サイト | https://admin.powerplatform.microsoft.com/ |
プライバシー ポリシー | https://privacy.microsoft.com/en-us/privacystatement |
Power Platform for Admins は、Power Platform の管理関連のリソースを管理するのに使われている、Power Platform 管理センター を運用している同じ APIであるビジネス アプリケーション プラットフォーム (BAP) API にアクセスするためのコネクタ インターフェイスです。 これには、環境のライフサイクルおよびアクセス許可の管理、 Dataverse プロビジョニング操作、DLP ポリシー、およびユーザー同期が含まれます。
前提条件
すべてのユーザーがこのコネクタへの Microsoft Entra ID の認証された接続を作成でき、データはユーザーのスコープに基づいて返されます。
- Power Platform サービス管理者は、このエンドポイントからテナントで利用可能なすべてのリソースと操作にアクセスできます。
- 環境管理者は、環境上のデータと操作、管理できる、またはそれから影響を受ける DLP ポリシーにのみアクセスできます。
既知の問題と制限事項
- DLP ポリシーの作成時または更新時に、ポリシーが破損および他の意図しない結果により使用できなくなる可能性があるので、null または Blank() の値を API コネクタ グループとして渡さないでください (配列)。 グループにコネクタが含まれていない場合は、空の角かっこ [ ] のセットを渡します。
- 古い DLP 操作は、更新された DLP がブロックされたグループでは機能せず、非推奨になっています。 すべての DLP 操作の 「V2」 バージョンを使用してください。
- DLP ポリシー グループにはコネクタが自動入力されないため、取得し、書式設定し、入力パラメーターとして追加する必要があります。
- コネクタを格納する配列変数を作成します。
- テナントの既定環境 ID を変数に保存します。
- アプリ作成者のための Power Platform から GetConnectors 操作を使用して、環境のためのすべてのコネクタを取得します (環境名が前のステップからである場合、「environment eq '{environmentName}'」 というフィルターを使用してください)。
- 選択操作を使用して、GetConnectors 応答からの ID、名前、およびタイプ フィールドのみを使用します (最後の 「value」 の動的コンテンツ オプションを使用します)。 ID、名前を入力し、型を左側を入力し、それから ID、displayName をマップして、選択アクションの右側に入力します。
- 選択の出力を配列変数に保存する
- これらのハードコードされたコネクタを配列変数に追加します (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 ポリシーを更新します。 |
環境のロール割り当てを編集する |
環境のアクセス許可を設定します。 |
環境の削除を検証する |
環境が削除可能かどうかを確認するために使用します。 |
環境を作成する |
新しい環境を作成します。 |
環境を削除する |
環境を削除します。 |
環境を更新する |
環境のプロパティを更新します。 |
環境を管理者として取得する |
1 つの環境を管理者として返します。 |
環境ロールの割り当て一覧を作成する |
CDS for Apps のない環境に対するアクセス許可の一覧を返します。 |
環境一覧を管理者として作成する |
環境の一覧を返します。 |
環境操作の状態を取得する (プレビュー) |
環境の操作 (削除など) の状態を確認するために使用します。 |
CDS データベースを作成する
指定した環境に新しい CDS インスタンスを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
基本言語
|
baseLanguage | integer |
環境言語の一覧から返された言語です。 |
|
通貨コード
|
code | string |
環境の通貨一覧から返される通貨コードです。 |
|
テンプレート
|
templates | array of string |
プロビジョニングの呼び出しに渡す CRM テンプレートの検証済み一覧です。 |
戻り値
環境オブジェクトです。
- Body
- Environment
CDS プロビジョニングの状態を取得する
プロビジョニング処理の状態を確認するために使用されます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
操作
|
operationName | True | string |
操作の名前です。 |
API バージョン
|
api-version | string |
API の日付値です。 |
DLP ポリシーの作成 V2
新しい DLP ポリシーを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
表示名です
|
displayName | string | ||
既定のコネクタ分類
|
defaultConnectorsClassification | string | ||
分類
|
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 |
戻り値
- 本文
- PolicyV2
DLP ポリシーの削除 V2
DLP ポリシーの取得 V2
DLP ポリシーの更新 V2
DLP ポリシーを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ポリシー
|
policy | True | string |
ポリシーの名前フィールドです。 |
API バージョン
|
api-version | string |
API の日付値です。 |
|
表示名です
|
displayName | string | ||
既定のコネクタ分類
|
defaultConnectorsClassification | string | ||
分類
|
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 |
戻り値
- 本文
- PolicyV2
DLP ポリシー一覧の作成 V2
DLP ポリシー一覧を作成する
すべてのテナントおよび環境の DLP ポリシーの一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
サポートされている場所の一覧を作成する
BAP サービスがサポートされている場所の一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
- 本文
- Locations
サポートされている環境言語の一覧を作成する
サポートされている言語の一覧を、場所に基づいて返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
場所
|
environmentLocation | True | string |
環境の場所です。 |
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
- 本文
- Languages
サポートされている環境通貨の一覧を作成する
サポートされている通貨の一覧を、場所に基づいて返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
場所
|
environmentLocation | True | string |
環境の場所です。 |
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
- 本文
- 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 ポリシー制約 environmentFilter1 のパラメーター filterType です。 |
ビジネス データの説明
|
description | string |
ポリシーのビジネス データ グループの説明です。 |
|
コネクタ ID
|
id | string |
ビジネス データ コネクタ ID フィールドです。 |
|
コネクタ名
|
name | string |
ビジネス データ コネクタ名フィールドです。 |
|
コネクタの種類
|
type | string |
ビジネス データ コネクタの種類フィールドです。 |
|
非ビジネス データの説明
|
description | string |
ポリシーの非ビジネス データ グループの説明です。 |
|
コネクタ ID
|
id | string |
非ビジネス データ コネクタ ID フィールドです。 |
|
コネクタ名
|
name | string |
非ビジネス データ コネクタ名フィールドです。 |
|
コネクタの種類
|
type | string |
非ビジネス データ コネクタの種類フィールドです。 |
|
既定のグループ
|
defaultApiGroup | True | string |
新しいコネクタが自動的に追加されるグループです。 |
種類
|
type | True | string |
ポリシー規則の apiGroupRule の種類です。 |
apiGroup
|
apiGroup | True | string |
ポリシー規則の apiGroupRule パラメーター apiGroup です。 |
ブロック アクションの種類
|
type | True | string |
ブロック アクションの種類です。ブロックの追加が不要な場合は空のままにします。 |
戻り値
- 本文
- Policy
テナントの DLP ポリシーを削除する
テナントの DLP ポリシーを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ポリシー
|
policy | True | string |
ポリシーの名前フィールドです。 |
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
- 応答
- object
テナントの DLP ポリシーを取得する
テナントの DLP ポリシーを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ポリシー
|
policy | True | string |
ポリシーの名前フィールドです。 |
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
- 本文
- Policy
テナントの DLP ポリシーを更新する
DLP ポリシー内のフィールドを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ポリシー
|
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 ポリシー制約 environmentFilter1 のパラメーター filterType です。 |
ビジネス データの説明
|
description | string |
ポリシーのビジネス データ グループの説明です。 |
|
コネクタ ID
|
id | string |
ビジネス データ コネクタ ID フィールドです。 |
|
コネクタ名
|
name | string |
ビジネス データ コネクタ名フィールドです。 |
|
コネクタの種類
|
type | string |
ビジネス データ コネクタの種類フィールドです。 |
|
非ビジネス データの説明
|
description | string |
ポリシーの非ビジネス データ グループの説明です。 |
|
コネクタ ID
|
id | string |
非ビジネス データ コネクタ ID フィールドです。 |
|
コネクタ名
|
name | string |
非ビジネス データ コネクタ名フィールドです。 |
|
コネクタの種類
|
type | string |
非ビジネス データ コネクタの種類フィールドです。 |
|
既定のグループ
|
defaultApiGroup | True | string |
新しいコネクタが自動的に追加されるグループです。 |
種類
|
type | True | string |
ポリシー規則の apiGroupRule の種類です。 |
apiGroup
|
apiGroup | True | string |
ポリシー規則の apiGroupRule パラメーター apiGroup です。 |
ブロック アクションの種類
|
type | True | string |
ブロック アクションの種類です。ブロックの追加が不要な場合は空のままにします。 |
戻り値
- 本文
- Policy
データベースのプロビジョニングの状態を取得する
プロビジョニング処理の状態を確認するために使用されます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
操作
|
operationName | True | string |
操作の名前です。 この URI 全体が /provisionInstance から場所ヘッダーとして返され、この値が含まれます。 |
API バージョン
|
api-version | string |
API の日付値です。 |
ブロックできないコネクタの一覧
DLP ポリシーでブロックできないコネクタの一覧を返します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
|
array of object | ||
ID
|
id | string | |
unblockable
|
metadata.unblockable | boolean |
ユーザーを強制的に同期する
PowerApps ユーザーを CRM に同期するために使用します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
ObjectId
|
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 | |
iconUri
|
metadata.iconUri | string | |
displayName
|
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 |
非ビジネス データ コネクタ ID フィールドです。 |
|
コネクタ名
|
name | string |
非ビジネス データ コネクタ名フィールドです。 |
|
コネクタの種類
|
type | string |
非ビジネス データ コネクタの種類フィールドです。 |
|
既定のグループ
|
defaultApiGroup | True | string |
新しいコネクタが自動的に追加されるグループです。 |
種類
|
type | True | string |
ポリシー規則の apiGroupRule の種類です。 |
apiGroup
|
apiGroup | True | string |
ポリシー規則の apiGroupRule パラメーター apiGroup です。 |
ブロック アクションの種類
|
type | True | string |
ブロック アクションの種類です。ブロックの追加が不要な場合は空のままにします。 |
戻り値
- 本文
- Policy
環境の DLP ポリシーを削除する
環境の DLP ポリシーを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
ポリシー
|
policy | True | string |
ポリシーの名前フィールドです。 |
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
- 応答
- object
環境の DLP ポリシーを取得する
環境の DLP ポリシーを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
ポリシー
|
policy | True | string |
ポリシーの名前フィールドです。 |
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
- 本文
- Policy
環境の DLP ポリシーを更新する
環境の DLP ポリシーを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
ポリシー
|
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 |
非ビジネス データ コネクタ ID フィールドです。 |
|
コネクタ名
|
name | string |
非ビジネス データ コネクタ名フィールドです。 |
|
コネクタの種類
|
type | string |
非ビジネス データ コネクタの種類フィールドです。 |
|
既定のグループ
|
defaultApiGroup | True | string |
新しいコネクタが自動的に追加されるグループです。 |
種類
|
type | True | string |
ポリシー規則の apiGroupRule の種類です。 |
apiGroup
|
apiGroup | True | string |
ポリシー規則の apiGroupRule パラメーター apiGroup です。 |
ブロック アクションの種類
|
type | True | string |
ブロック アクションの種類です。ブロックの追加が不要な場合は空のままにします。 |
戻り値
- 本文
- Policy
環境のロール割り当てを編集する
環境のアクセス許可を設定します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
API バージョン
|
api-version | string |
API の日付値です。 |
|
プリンシパル電子メール
|
string |
ユーザーのプリンシパル電子メールです。 |
||
プリンシパル テナント ID
|
tenantId | string |
ユーザーのプリンシパル テナント ID です。 |
|
プリンシパル オブジェクト ID
|
id | string |
ユーザーのプリンシパル オブジェクト ID です。 |
|
プリンシパルの種類
|
type | string |
ユーザーのプリンシパルの種類です。 |
|
ロールの定義 ID
|
id | string |
ロールの定義 ID です。 Format: /providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/{environment}/{roleName}. |
|
ID
|
id | string |
id フィールドです。 |
戻り値
- 本文
- RoleAssignment
環境の削除を検証する
環境が削除可能かどうかを確認するために使用します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
環境を作成する
新しい環境を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
API バージョン
|
api-version | True | string |
API の日付値です。 |
場所
|
location | True | string |
環境が展開されている地域です。 |
表示名
|
displayName | True | string |
環境のバニティ名です。 |
環境 SKU
|
environmentSku | True | string |
環境の種類です。 |
戻り値
環境オブジェクトです。
- 本文
- Environment
環境を削除する
環境を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
環境オブジェクトです。
- 本文
- Environment
環境を更新する
環境のプロパティを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
API バージョン
|
api-version | string |
API の日付値です。 |
|
説明
|
description | string | ||
displayName
|
displayName | string | ||
securityGroupId
|
securityGroupId | string |
環境を管理者として取得する
1 つの環境を管理者として返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
環境オブジェクトです。
- 本文
- Environment
環境ロールの割り当て一覧を作成する
CDS for Apps のない環境に対するアクセス許可の一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
API バージョン
|
api-version | string |
API の日付値です。 |
戻り値
環境一覧を管理者として作成する
環境の一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
API バージョン
|
api-version | string |
API の日付値です。 |
|
トークンをスキップする
|
$skiptoken | string |
応答の次のページを取得するために使用する入力です。 |
|
ページ サイズ
|
$top | integer |
応答に含まれる環境の数です。 |
|
プロパティを展開する
|
$expand | string |
応答プロパティを展開するためのアクセスを許可します。 |
戻り値
環境操作の状態を取得する (プレビュー)
環境の操作 (削除など) の状態を確認するために使用します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
環境
|
environment | True | string |
環境の名前です。 |
操作
|
operationName | True | string |
操作の名前です。 |
API バージョン
|
api-version | string |
API の日付値です。 |
定義
ResourceArray[Policy]
名前 | パス | 型 | 説明 |
---|---|---|---|
値
|
value | array of Policy |
ポリシー
名前 | パス | 型 | 説明 |
---|---|---|---|
ポリシー ID
|
id | string |
ポリシー ID フィールドです。 |
ポリシーの種類
|
type | string |
ポリシーの種類フィールドです。 |
ポリシー名
|
name | string |
ポリシー名フィールドです。 |
表示名
|
properties.displayName | string |
API ポリシーの表示名です。 |
作成時刻
|
properties.createdTime | date-time |
API ポリシーの作成時刻です。 |
作成者
|
properties.createdBy | Principal[CreatedBy] |
ポリシー作成者のプリンシパル オブジェクトです。 |
変更時刻
|
properties.lastModifiedTime | date-time |
API ポリシーの変更時刻です。 |
変更者
|
properties.lastModifiedBy | Principal[ModifiedBy] |
ポリシー変更者のプリンシパル オブジェクトです。 |
スキーマ バージョン
|
properties.definition.$schema | PolicySchema |
API ポリシー定義の $schema です。 |
タイプ
|
properties.definition.constraints.environmentFilter1.type | string |
ポリシーの environmentFilter の種類です。 |
環境
|
properties.definition.constraints.environmentFilter1.parameters.environments | PolicyEnvironments |
ポリシー環境です。 |
フィルターの種類
|
properties.definition.constraints.environmentFilter1.parameters.filterType | string |
API ポリシー制約 environmentFilter1 のパラメーター filterType です。 |
apiGroups
|
properties.definition.apiGroups | PolicyApiGroups | |
既定のグループ
|
properties.definition.defaultApiGroup | PolicyDefaultApiGroup |
新しいコネクタが自動的に追加されるグループです。 |
規則
|
properties.definition.rules | PolicyRules |
ポリシー規則オブジェクトです。 |
ResourceArray[PolicyV2]
名前 | パス | 型 | 説明 |
---|---|---|---|
値
|
value | array of PolicyV2 |
PolicyV2
名前 | パス | 型 | 説明 |
---|---|---|---|
名前
|
name | string | |
displayName
|
displayName | string | |
defaultConnectorsClassification
|
defaultConnectorsClassification | string | |
connectorGroups
|
connectorGroups | array of object | |
分類
|
connectorGroups.classification | string | |
コネクタ
|
connectorGroups.connectors | array of object | |
ID
|
connectorGroups.connectors.id | string | |
名前
|
connectorGroups.connectors.name | string | |
種類
|
connectorGroups.connectors.type | string | |
environmentType
|
environmentType | string | |
環境
|
environments | array of object | |
ID
|
environments.id | string | |
種類
|
environments.type | string | |
名前
|
environments.name | string | |
displayName
|
createdBy.displayName | string | |
createdTime
|
createdTime | string | |
displayName
|
lastModifiedBy.displayName | string | |
lastModifiedTime
|
lastModifiedTime | string | |
isLegacySchemaVersion
|
isLegacySchemaVersion | boolean |
ResourceArray[Environment]
名前 | パス | 型 | 説明 |
---|---|---|---|
値
|
value | array of Environment |
環境値のオブジェクト配列です。 |
次のリンク
|
nextLink | string |
環境一覧の次のページを取得する URL です。 |
環境
環境オブジェクトです。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
環境 ID フィールドです。 |
タイプ
|
type | string |
環境の種類フィールドです。 |
件名
|
name | string |
環境名フィールドです。 |
場所
|
location | string |
環境の場所フィールドです。 |
Azure 地域のヒント
|
properties.azureRegionHint | string |
環境の azureRegionHint フィールドです。 |
表示名
|
properties.displayName | string |
環境の表示名です。 |
作成時刻
|
properties.createdTime | date-time |
環境の作成時刻です。 |
作成者
|
properties.createdBy | Principal[CreatedBy] |
ポリシー作成者のプリンシパル オブジェクトです。 |
lastModifiedTime
|
properties.lastModifiedTime | date-time |
環境の lastModified の日時です。 |
変更者
|
properties.lastModifiedBy | Principal[ModifiedBy] |
ポリシー変更者のプリンシパル オブジェクトです。 |
プロビジョニングの状態
|
properties.provisioningState | string |
環境の provisioningState です。 |
容量
|
properties.capacity | array of object | |
capacityType
|
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 | |
addonType
|
properties.addons.addonType | string | |
allocated
|
properties.addons.allocated | number | |
addonUnit
|
properties.addons.addonUnit | string | |
作成の種類
|
properties.creationType | string |
環境の作成の種類です。 |
環境 SKU
|
properties.environmentSku | string |
環境の SKU ID です。 |
環境の種類
|
properties.environmentType | string |
環境の種類です。 |
既定
|
properties.isDefault | boolean |
既定の環境かどうかです。 |
ビジネス アプリ プラットフォーム
|
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 |
非ビジネス データ コネクタ ID フィールドです。 |
コネクタ名
|
apis.name | string |
非ビジネス データ コネクタ名フィールドです。 |
コネクタの種類
|
apis.type | string |
非ビジネス データ コネクタの種類フィールドです。 |
PolicyDefaultApiGroup
ValidateDeleteResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
削除可能
|
canInitiateDelete | boolean |
環境は削除可能です。 |
エラー配列
|
errors | array of object |
エラー配列 |
コード
|
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 | array of object |
環境ロールの割り当て値オブジェクト配列です。 |
ID
|
value.id | string |
環境ロールの割り当て ID フィールドです。 |
種類
|
value.type | string |
環境ロールの割り当ての種類フィールドです。 |
名前
|
value.name | string |
環境ロールの割り当てフィールド名です。 |
scope
|
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 です。 |
displayName
|
value.properties.principal.displayName | string |
環境ロールの割り当てプリンシパル displayName です。 |
電子メール
|
value.properties.principal.email | string |
環境ロールの割り当てプリンシパル電子メールです。 |
種類
|
value.properties.principal.type | string |
環境ロールの割り当てプリンシパルの種類です。 |
RoleAssignment
名前 | パス | 型 | 説明 |
---|---|---|---|
追加
|
add | array of object |
環境ロールの割り当て追加オブジェクトです。 |
ID
|
add.roleAssignment.id | string |
環境ロールの割り当ての roleAssignment ID フィールドです。 |
種類
|
add.roleAssignment.type | string |
環境ロールの割り当ての roleAssignment の種類フィールドです。 |
名前
|
add.roleAssignment.name | string |
環境ロールの割り当ての roleAssignment 名フィールドです。 |
scope
|
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 |
環境ロールの割り当て roleDefinition の名前フィールドです。 |
ID
|
add.roleAssignment.properties.principal.id | string |
環境ロールの割り当てプリンシパル オブジェクト ID です。 |
displayName
|
add.roleAssignment.properties.principal.displayName | string |
環境ロールの割り当てプリンシパル displayName です。 |
電子メール
|
add.roleAssignment.properties.principal.email | string |
環境ロールの割り当てプリンシパル電子メールです。 |
種類
|
add.roleAssignment.properties.principal.type | string |
環境ロールの割り当てプリンシパルの種類です。 |
httpStatus
|
add.httpStatus | string |
環境ロールの割り当ての httpStatus です。 |
プリンシパル[ModifiedBy]
ポリシー変更者のプリンシパル オブジェクトです。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
変更者のプリンシパル オブジェクト ID です。 |
表示名です
|
displayName | string |
変更者のプリンシパル displayName です。 |
電子メール
|
string |
変更者のプリンシパルです。 |
|
タイプ
|
type | string |
変更者のプリンシパルの種類です。 |
テナント ID
|
tenantId | string |
変更者のプリンシパル テナント ID です。 |
UPN
|
userPrincipalName | string |
変更者の userPrincipalNameです。 |
プリンシパル[CreatedBy]
ポリシー作成者のプリンシパル オブジェクトです。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
API ポリシー作成者のプリンシパル オブジェクト ID です。 |
表示名です
|
displayName | string |
API ポリシー作成者のプリンシパル displayName です。 |
電子メール
|
string |
API ポリシー作成者のプリンシパル電子メールです。 |
|
タイプ
|
type | string |
API ポリシー作成者のプリンシパルの種類です。 |
テナント ID
|
tenantId | string |
API ポリシー作成者のプリンシパル テナント ID です。 |
UPN
|
userPrincipalName | string |
API ポリシー作成者の userPrincipalName です。 |
場所
名前 | パス | 型 | 説明 |
---|---|---|---|
値
|
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 | 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 |
通貨の表示名です。 |
言語
名前 | パス | 型 | 説明 |
---|---|---|---|
値
|
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 |
言語がテナントの既定フィールドです。 |
オブジェクト
’オブジェクト’ という種類です。