Udostępnij przez

Invoke-PowerBIRestMethod

Moduł:
MicrosoftPowerBIMgmt.Profile Module

Wykonuje wywołanie REST do usługi Power BI z określonym adresem URL i treścią.

Składnia

Default (Domyślna) 

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

Opis

Wywołuje żądanie REST względem usługi Power BI przy użyciu profilu, za pomocą którego się zalogowano. Czasownik REST można określić przy użyciu parametru -Method. Parametr -Body jest wymagany dla czasowników POST, PUT i PATCH. Przed uruchomieniem tego polecenia upewnij się, że logujesz się przy użyciu polecenia Connect-PowerBIServiceAccount.

Przykłady

Przykład 1

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

Wywołuje https://api.powerbi.com/v1.0/myorg/groups adresu URL za pomocą metody GET\verb.

Parametry

-Body

Treść żądania, znana również jako zawartość. Jest to opcjonalne, chyba że metoda żądania to POST, PUT lub PATCH.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ContentType

Typ zawartości do określenia wewnątrz nagłówka żądania. Wartość domyślna to "application/json".

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Headers

Opcjonalne nagłówki do uwzględnienia w żądaniu.

Właściwości parametru

Typ:Hashtable
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Method

Typ metody żądania HTTP\verb do wykonania za pomocą wywołania.

Właściwości parametru

Typ:PowerBIWebRequestMethod
Domyślna wartość:None
Dopuszczalne wartości:Get, Post, Delete, Put, Patch, Options
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Organization

Nazwa organizacji lub identyfikator GUID dzierżawy do uwzględnienia w adresie URL. Wartość domyślna to "myorg".

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-OutFile

Plik wyjściowy do zapisywania zawartości odpowiedzi na. Określona ścieżka pliku nie może istnieć.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-TimeoutSec

Określa, jak długo żądanie może być oczekiwane, zanim upłynie limit czasu. Wprowadź wartość w sekundach. Wprowadzenie wartości 0 określa limit czasu nieokreślony.

Właściwości parametru

Typ:Int32
Domyślna wartość:100
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Url

Względny lub bezwzględny adres URL jednostki usługi Power BI, do której chcesz uzyskać dostęp. Jeśli na przykład chcesz uzyskać dostęp do https://api.powerbi.com/v1.0/myorg/groups, określ "grupy" lub przekaż cały adres URL.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Version

Wersja interfejsu API do uwzględnienia w adresie URL. Wartość domyślna to "v1.0". Ignorowane, jeśli -Url jest bezwzględnym adresem URL.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

None

Dane wyjściowe

System.Object