Invoke-PowerBIRestMethod

Модуль:

MicrosoftPowerBIMgmt.Profile Module

Выполняет вызов REST к службе Power BI с указанным URL-адресом и текстом.

Синтаксис

Default (по умолчанию)

Invoke-PowerBIRestMethod
    -Url <String>
    -Method <PowerBIWebRequestMethod>
    [-Body <String>]
    [-OutFile <String>]
    [-ContentType <String>]
    [-Headers <Hashtable>]
    [-TimeoutSec <Int32>]
    [-Organization <String>]
    [-Version <String>]
    [<CommonParameters>]

Описание

Вызывает запрос REST к службе Power BI, используя профиль, с помощью вошедшего в систему профиля. Команду REST можно указать с помощью параметра -Method. Параметр -Body необходим для команд POST, PUT и PATCH. Перед выполнением этой команды обязательно выполните вход с помощью Connect-PowerBIServiceAccount.

Примеры

Пример 1

PS C:\> Invoke-PowerBIRestMethod -Url 'groups' -Method Get

Вызывает URL-адрес https://api.powerbi.com/v1.0/myorg/groups с помощью метода GET\verb.

Параметры

-Body

Текст запроса, также известный как содержимое. Это необязательно, если метод запроса не является POST, PUT или PATCH.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ContentType

Тип контента для указания внутри заголовка запроса. Значение по умолчанию — application/json.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Headers

Необязательные заголовки для включения в запрос.

Свойства параметра

Тип:	Hashtable
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Method

Тип метода HTTP-запроса\verb для выполнения вызова.

Свойства параметра

Тип:	PowerBIWebRequestMethod
Default value:	None
Допустимые значения:	Get, Post, Delete, Put, Patch, Options
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Organization

Имя организации или GUID клиента для включения в URL-адрес. По умолчанию используется myorg.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-OutFile

Выходной файл для записи содержимого ответа в. Указанный путь к файлу не должен существовать.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-TimeoutSec

Указывает время ожидания запроса до истечения времени ожидания. Введите значение в секундах. При вводе значения 0 указывается неопределенное время ожидания.

Свойства параметра

Тип:	Int32
Default value:	100
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Url

Относительный или абсолютный URL-адрес сущности Power BI, к которой требуется получить доступ. Например, если вы хотите получить доступ к https://api.powerbi.com/v1.0/myorg/groups, укажите "группы" или передайте весь URL-адрес.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Version

Версия API для включения в URL-адрес. Значение по умолчанию — v1.0. Игнорируется, если -Url является абсолютным URL-адресом.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

None

Выходные данные

System.Object