Invoke-PowerBIRestMethod
指定した URL と本文を使用して、Power BI サービスへの REST 呼び出しを実行します。
構文
Invoke-PowerBIRestMethod
-Url <String>
-Method <PowerBIWebRequestMethod>
[-Body <String>]
[-OutFile <String>]
[-ContentType <String>]
[-Headers <Hashtable>]
[-TimeoutSec <Int32>]
[-Organization <String>]
[-Version <String>]
[<CommonParameters>]
説明
ログインしているプロファイルを使用して、Power BI サービスに対して REST 要求を呼び出します。 REST 動詞は、-Method パラメーターを使用して指定できます。 動詞 POST、PUT、PATCH には、-Body パラメーターが必要です。 このコマンドを実行する前に、Connect-PowerBIServiceAccount を使用してログインしてください。
例
例 1
PS C:\> Invoke-PowerBIRestMethod -Url 'groups' -Method Get
GET メソッド\verb を使用して URL https://api.powerbi.com/v1.0/myorg/groups を呼び出します。
パラメーター
-Body
要求の本文。コンテンツとも呼ばれます。 要求メソッドが POST、PUT、または PATCH でない限り、これは省略可能です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ContentType
要求のヘッダー内で指定するコンテンツ タイプ。 既定値は 'application/json' です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Headers
要求に含める省略可能なヘッダー。
型: | Hashtable |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Method
呼び出しで行う HTTP 要求メソッド\動詞の型。
型: | PowerBIWebRequestMethod |
指定可能な値: | Get, Post, Delete, Put, Patch, Options |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Organization
URL に含める組織名またはテナント GUID。 既定値は 'myorg' です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-OutFile
応答コンテンツを書き込むための出力ファイル。 指定されたファイル パスは存在しない必要があります。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-TimeoutSec
タイムアウトするまでの要求の保留期間を指定します。値を秒単位で入力します。 値 0 を入力すると、無期限のタイムアウトが指定されます。
型: | Int32 |
配置: | Named |
規定値: | 100 |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Url
アクセスする Power BI エンティティの相対 URL または絶対 URL。 たとえば、https://api.powerbi.com/v1.0/myorg/groupsにアクセスする場合は、'groups' を指定するか、URL 全体を渡します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Version
URL に含める API のバージョン。 既定値は 'v1.0' です。 -Url が絶対 URL の場合は無視されます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
None
出力
System.Object