Compartilhar via

Invoke-PowerBIRestMethod

Módulo:
MicrosoftPowerBIMgmt.Profile Module

Executa uma chamada REST para o serviço do Power BI, com a URL e o corpo especificados.

Sintaxe

Default (Padrão) 

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

Description

Invoca uma solicitação REST no serviço do Power BI usando o perfil com o qual você está conectado. O verbo REST pode ser especificado usando o parâmetro -Method. O parâmetro -Body é necessário para os verbos POST, PUT e PATCH. Antes de executar esse comando, faça logon usando Connect-PowerBIServiceAccount.

Exemplos

Exemplo 1

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

Invoca a URL https://api.powerbi.com/v1.0/myorg/groups com o método GET\verbo.

Parâmetros

-Body

Corpo da solicitação, também conhecido como conteúdo. Isso é opcional, a menos que o método de solicitação seja POST, PUT ou PATCH.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ContentType

Tipo de conteúdo a ser especificado dentro do cabeçalho da solicitação. O padrão é "application/json".

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Headers

Cabeçalhos opcionais a serem incluídos com a solicitação.

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Method

Tipo de método de solicitação HTTP\verbo a ser feita com a chamada.

Propriedades do parâmetro

Tipo:PowerBIWebRequestMethod
Valor padrão:None
Valores aceitos:Get, Post, Delete, Put, Patch, Options
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Organization

Nome da organização ou GUID de locatário a ser incluído na URL. O padrão é 'myorg'.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-OutFile

Arquivo de saída para o qual gravar o conteúdo da resposta. O caminho do arquivo especificado não deve existir.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-TimeoutSec

Especifica quanto tempo a solicitação pode ficar pendente antes de atingir o tempo limite. Insira um valor em segundos. Inserir um valor de 0 especifica um tempo limite indefinido.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:100
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Url

URL relativa ou absoluta da entidade do Power BI que você deseja acessar. Por exemplo, se você quiser acessar https://api.powerbi.com/v1.0/myorg/groups, especifique "grupos" ou passe toda a URL.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Version

Versão da API a ser incluída na URL. O padrão é 'v1.0'. Ignorado se -Url é uma URL absoluta.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

None

Saídas

System.Object