Invoke-PowerBIRestMethod
使用指定的 URL 和正文执行对 Power BI 服务的 REST 调用。
语法
Default (默认值)
Invoke-PowerBIRestMethod
-Url <String>
-Method <PowerBIWebRequestMethod>
[-Body <String>]
[-OutFile <String>]
[-ContentType <String>]
[-Headers <Hashtable>]
[-TimeoutSec <Int32>]
[-Organization <String>]
[-Version <String>]
[<CommonParameters>]
说明
使用登录的配置文件针对 Power BI 服务调用 REST 请求。
可以使用 -Method 参数指定 REST 谓词。 谓词 POST、PUT 和 PATCH 需要 -Body 参数。
运行此命令之前,请确保使用 Connect-PowerBIServiceAccount 登录。
示例
示例 1
PS C:\> Invoke-PowerBIRestMethod -Url 'groups' -Method Get
使用 GET 方法\谓词调用 URL https://api.powerbi.com/v1.0/myorg/groups。
参数
-Body
请求正文,也称为 内容。 除非请求方法是 POST、PUT 或 PATCH,否则这是可选的。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ContentType
在请求的标头内指定的内容类型。 默认值为“application/json”。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
要包含在请求中的可选标头。
| 类型: | Hashtable
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Method
要通过调用进行的 HTTP 请求方法\谓词的类型。
参数属性
| 类型: | PowerBIWebRequestMethod
|
| 默认值: | None |
| 接受的值: | Get, Post, Delete, Put, Patch, Options |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Organization
要包含在 URL 中的组织名称或租户 GUID。 默认值为“myorg”。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-OutFile
用于将响应内容写入到的输出文件。 指定的文件路径不得存在。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-TimeoutSec
指定请求在超时之前可以等待多长时间。以秒为单位输入值。 输入值 0 指定无限期超时。
参数属性
| 类型: | Int32
|
| 默认值: | 100 |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Url
要访问的 Power BI 实体的相对或绝对 URL。 例如,如果要访问 https://api.powerbi.com/v1.0/myorg/groups,请指定“组”或传入整个 URL。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Version
要包含在 URL 中的 API 版本。 默认值为“v1.0”。 如果 -Url 是绝对 URL,则忽略。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
None
输出
System.Object