Partager via

Invoke-PowerBIRestMethod

Module:
MicrosoftPowerBIMgmt.Profile Module

Exécute un appel REST au service Power BI, avec l’URL et le corps spécifiés.

Syntaxe

Default (Par défaut) 

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

Description

Appelle une requête REST sur le service Power BI à l’aide du profil avec lequel vous êtes connecté. Le verbe REST peut être spécifié à l’aide du paramètre -Method. Le paramètre -Body est requis pour les verbes POST, PUT et PATCH. Avant d’exécuter cette commande, veillez à vous connecter à l’aide de Connect-PowerBIServiceAccount.

Exemples

Exemple 1

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

Appelle l’URL https://api.powerbi.com/v1.0/myorg/groups avec la méthode GET\verb.

Paramètres

-Body

Corps de la requête, également appelé contenu. Cela est facultatif, sauf si la méthode de requête est POST, PUT ou PATCH.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ContentType

Type de contenu à spécifier à l’intérieur de l’en-tête de la demande. La valeur par défaut est « application/json ».

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Headers

En-têtes facultatifs à inclure avec la requête.

Propriétés du paramètre

Type:Hashtable
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Method

Type de méthode de requête HTTP\verbe à effectuer avec l’appel.

Propriétés du paramètre

Type:PowerBIWebRequestMethod
Valeur par défaut:None
Valeurs acceptées:Get, Post, Delete, Put, Patch, Options
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Organization

Nom de l’organisation ou GUID de locataire à inclure dans l’URL. La valeur par défaut est « myorg ».

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-OutFile

Fichier de sortie dans lequel écrire le contenu de la réponse. Le chemin d’accès spécifié ne doit pas exister.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-TimeoutSec

Spécifie la durée pendant laquelle la requête peut être en attente avant qu’elle expire. Entrez une valeur en secondes. La saisie d’une valeur de 0 spécifie un délai d’attente indéfini.

Propriétés du paramètre

Type:Int32
Valeur par défaut:100
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Url

URL relative ou absolue de l’entité Power BI à accéder. Par exemple, si vous souhaitez accéder à https://api.powerbi.com/v1.0/myorg/groups, spécifiez « groupes » ou transmettez l’URL entière.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Version

Version de l’API à inclure dans l’URL. La valeur par défaut est « v1.0 ». Ignoré si -Url est une URL absolue.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

None

Sorties

System.Object