Invoke-PowerBIRestMethod

  • リファレンス
モジュール:
MicrosoftPowerBIMgmt.Profile

指定した 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 パラメーターを使用して指定できます。 -Body パラメーターは、動詞 POST、PUT、PATCH に必要です。 このコマンドを実行する前に、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 でない限り、これは省略可能です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContentType

要求のヘッダー内で指定するコンテンツ タイプ。 既定値は 'application/json' です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Headers

要求に含める省略可能なヘッダー。

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Method

呼び出しで行う HTTP 要求メソッド\動詞の種類。

Type:PowerBIWebRequestMethod
Accepted values:Get, Post, Delete, Put, Patch, Options
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Organization

URL に含める組織名またはテナント GUID。 既定値は 'myorg' です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutFile

応答コンテンツを書き込むための出力ファイル。 指定されたファイル パスは存在できません。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TimeoutSec

タイムアウトするまでの要求の保留期間を指定します。値を秒単位で入力します。 値 0 を入力すると、不定のタイムアウトが指定されます。

Type:Int32
Position:Named
Default value:100
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Url

アクセスする Power BI エンティティの相対 URL または絶対 URL。 たとえば、アクセス https://api.powerbi.com/v1.0/myorg/groupsする場合は、"グループ" を指定するか、URL 全体を渡します。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Version

URL に含める API のバージョン。 既定値は 'v1.0' です。 Url が絶対 URL の場合は無視されます。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

None

出力

System.Object

メモ