Admin - Profiles GetProfilesAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

組織のサービス プリンシパル プロファイルの一覧を返します。

アクセス許可

ユーザーは管理者権限を持っているか、サービス プリンシパルを使用して認証する必要があります。

必要なスコープ

Tenant.Read.All または Tenant.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/admin/profiles

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/profiles?$filter={$filter}&$top={$top}&$skip={$skip}

URI パラメーター

名前	/	必須	型	説明
$filter	query		string	'id'、'displayName'、または 'servicePrincipalId' を使用して、ブール条件に基づいて結果をフィルター処理します。 'eq' 演算子のみをサポートします。
$skip	query		integer int32	最初の n 個の結果をスキップします。 top で を使用して、最初の 5000 を超える結果をフェッチします。
$top	query		integer int32	最初の n 個の結果のみを返します。 このパラメーターは、1 から 5000 の範囲である必要があります。

応答

名前	型	説明
200 OK	AdminServicePrincipalProfiles	OK

例

Get a specific service principal profile by id using filter

Get service principal profiles by their parent servicePrincipalId using filter

Get a specific service principal profile by id using filter

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/profiles?$filter=id%20eq%20'3b211778-e7a5-4d73-8187-f10824047724'

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "3b211778-e7a5-4d73-8187-f10824047724",
      "displayName": "My new profile",
      "servicePrincipalId": "12345678-e7a5-4d73-8187-f10824041234"
    }
  ]
}

Get service principal profiles by their parent servicePrincipalId using filter

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/profiles?$filter=servicePrincipalId%20eq%20'12345678-e7a5-4d73-8187-f10824041234'

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "3b211778-e7a5-4d73-8187-f10824047724",
      "displayName": "My new profile",
      "servicePrincipalId": "12345678-e7a5-4d73-8187-f10824041234"
    },
    {
      "id": "43211778-e7a5-4d73-8187-f10824044321",
      "displayName": "My new profile2",
      "servicePrincipalId": "12345678-e7a5-4d73-8187-f10824041234"
    }
  ]
}

定義

名前	説明
AdminServicePrincipalProfile	Power BI サービス プリンシパル プロファイル。 マルチテナント ソリューションPower BI Embeddedにのみ関連します。
AdminServicePrincipalProfiles	Power BI サービス プリンシパル プロファイル コレクションの Odata 応答ラッパー。

AdminServicePrincipalProfile

Power BI サービス プリンシパル プロファイル。 マルチテナント ソリューションPower BI Embeddedにのみ関連します。

名前	型	説明
displayName	string	サービス プリンシパル プロファイル名
id	string	サービス プリンシパル プロファイル ID
servicePrincipalId	string	サービス プリンシパル ID

AdminServicePrincipalProfiles

Power BI サービス プリンシパル プロファイル コレクションの Odata 応答ラッパー。

名前	型	説明
odata.context	string	OData コンテキスト
value	AdminServicePrincipalProfile[]	サービス プリンシパル プロファイルコレクション