Invoke-ASCmd

Référence

Module:: SQLServer

Permet aux administrateurs de base de données d’exécuter un script XMLA, un script TMSL, une requête DAX (Data Analysis Expressions), une requête MDX (Multidimensional Expressions) ou une instruction DMX (Data Mining Extensions) sur une instance d’Analysis Services.

Syntaxe

Invoke-ASCmd
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ASCmd
      [-Database <String>]
      [-Query <String>]
      [-ConnectionString <String>]
      [-QueryTimeout <Int32>]
      [-ConnectionTimeout <Int32>]
      [-TraceFile <String>]
      [-Variables <String[]>]
      [-TraceTimeout <Int32>]
      [-TraceLevel <TraceLevelOption>]
      [-TraceFileFormat <TraceFileFormatOption>]
      [-TraceFileDelimiter <String>]
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ASCmd
      [-Database <String>]
      [-ConnectionString <String>]
      [-InputFile <String>]
      [-QueryTimeout <Int32>]
      [-ConnectionTimeout <Int32>]
      [-TraceFile <String>]
      [-Variables <String[]>]
      [-TraceTimeout <Int32>]
      [-TraceLevel <TraceLevelOption>]
      [-TraceFileFormat <TraceFileFormatOption>]
      [-TraceFileDelimiter <String>]
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ASCmd
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ASCmd
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Les applets de commande exécutent ces requêtes ou scripts dans des fichiers d’entrée.

Le script passé est une commande XMLA et les commandes suivantes sont prises en charge : Alter, Backup, Batch, BeginTransaction, Cancel, ClearCache, CommitTransaction, Create, Delete, DesignAggregations, Drop, Insert, Lock, MergePartitions, NotifyTableChange, Process, Restore, RollbackTransaction, Statement (utilisé pour exécuter des requêtes MDX et des instructions DMX), Subscribe, Synchronize, Unlock, Update, UpdateCells.

Ce script accepte également les commandes JSON conçues pour s’exécuter sur une base de données tabulaire avec le mode de compatibilité 1200 ou version ultérieure.

Module requirements: version 21+ on PowerShell 5.1; version 21 (recent preview) or version 22+ on PowerShell 7.x.

Exemples

Appeler la découverte

Invoke-ASCmd -Server:localhost -Query "<Discover xmlns='urn:schemas-microsoft-com:xml-analysis'><RequestType>DBSCHEMA_CATALOGS</RequestType><Restrictions /><Properties /></Discover>"

Appeler la découverte 2

Invoke-ASCmd -Database "Adventure Works DW 2008R2" -Query "<Discover xmlns='urn:schemas-microsoft-com:xml-analysis'><RequestType>DISCOVER_DATASOURCES</RequestType><Restrictions></Restrictions><Properties></Properties></Discover>"

Appeler sélectionner

Invoke-ASCmd -Database "Adventure Works DW 2008R2" -Query "SELECT {[Measures].[Internet Sales Amount]} ON COLUMNS, BOTTOMCOUNT(NONEMPTY(DESCENDANTS( [Customer].[Customer Geography].[All Customers], [Customer].[Customer Geography].[Customer]), ( [Measures].[Internet Sales Amount] ) ), 10, ( [Measures].[Internet Sales Amount] )) ON ROWS FROM [Adventure Works] WHERE ( [Date].[Calendar].[Calendar Year].&[2008] )"

Appeler sélectionner 2

Invoke-ASCmd -Database "Adventure Works DW 2008R2" -Query "SELECT MODEL_CATALOG, MODEL_NAME, ATTRIBUTE_NAME, NODE_NAME FROM [Forecasting].CONTENT"

Appeler avec un fichier xmla

Invoke-ASCmd -InputFile C:\MyFolder\DiscoverConnections.xmla

<# DiscoverConnections.xmla is as follows:

 <Discover xmlns="urn:schemas-microsoft-com:xml-analysis">
   <RequestType>DISCOVER_CONNECTIONS</RequestType>
   <Restrictions />
   <Properties>
     <PropertyList>
       <Content>Data</Content>
     </PropertyList>
   </Properties>
 </Discover>

#>

Paramètres

-ApplicationId

ID d’application du principal de service.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-CertificateThumbprint

Empreinte numérique du certificat pour le principal de service.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:	SwitchParameter
Alias:	cf
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ConnectionString

Spécifie la chaîne de connexion.

Notez que d’autres propriétés au niveau de la connexion telles que le serveur, la base de données, etc. sont ignorées lorsque cette propriété est spécifiée et que ces propriétés doivent donc être incluses dans la chaîne de connexion.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ConnectionTimeout

Spécifie le nombre de secondes avant que la connexion à l’instance Analysis Services expire. La valeur de délai d’expiration doit être un entier compris entre 0 et 65534. Si 0 est spécifié, les tentatives de connexion n’expirent pas.

Type:	Int32
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Credential

Si ce paramètre est spécifié, le nom d’utilisateur et le mot de passe transmis sont utilisés pour se connecter à l’instance d’Analysis Server spécifiée. Si aucune information d’identification n’est spécifiée, le compte Windows par défaut de l’utilisateur qui exécute l’outil sera utilisé.

Type:	PSCredential
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Database

Spécifie la base de données sur laquelle une requête MDX ou une instruction DMX s’exécute. Le paramètre de base de données est ignoré lorsque l’applet de commande exécute un script XMLA, car le nom de la base de données est incorporé dans le script XMLA.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-InputFile

Identifie le fichier qui contient le script XMLA, la requête MDX, l’instruction DMX ou le script TMSL (au format JSON). Vous devez spécifier une valeur pour le InputFile ou le paramètre *Query *lors de l’utilisation d’Invoke-AsCmd.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ProgressAction

Détermine comment PowerShell répond aux mises à jour de progression générées par un script, une applet de commande ou un fournisseur, telles que les barres de progression générées par l’applet de commande Write-Progress. L’applet de commande Write-Progress crée des barres de progression qui affichent l’état d’une commande.

Type:	ActionPreference
Alias:	proga
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Query

Spécifie le script, la requête ou l’instruction réel directement sur la ligne de commande au lieu d’un fichier.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-QueryTimeout

Spécifie le nombre de secondes avant l’expiration des requêtes. Si aucune valeur de délai d’expiration n’est spécifiée, les requêtes n’expirent pas. Le délai d’expiration doit être un entier compris entre 1 et 65535.

Type:	Int32
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Server

Spécifie éventuellement l’instance de serveur à laquelle se connecter s’il n’est pas actuellement dans le répertoire du fournisseur SQLAS.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ServicePrincipal

Spécifie que cette connexion utilise le principal de service.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-TenantId

ID de locataire du principal de service.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-TraceFile

Identifie un fichier qui reçoit des événements de trace Analysis Services lors de l’exécution du script XMLA, de la requête MDX ou de l’instruction DMX. Si le fichier existe déjà, il est automatiquement remplacé (à l’exception des fichiers de trace créés à l’aide des paramètres -TraceLevel :Duration et -TraceLevel :DurationResult).

Les noms de fichiers qui contiennent des espaces doivent être placés entre guillemets (« »).

Si le nom de fichier n’est pas valide, un message d’erreur est généré.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-TraceFileDelimiter

Spécifie un caractère unique comme délimiteur de fichier de trace lorsque vous spécifiez csv comme format pour le fichier de trace qui utilise le paramètre -TraceFileFormat.

La valeur par défaut est | (canal ou barre verticale).

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-TraceFileFormat

Spécifie le format de fichier du paramètre -TraceFile (si ce paramètre est spécifié).

La valeur par défaut est « Csv ».

Type:	TraceFileFormatOption
Valeurs acceptées:	Csv, Text
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-TraceLevel

Spécifie les données collectées et enregistrées dans le fichier de trace. Les valeurs possibles sont High, Medium, Low, Duration, DurationResult.

Type:	TraceLevelOption
Valeurs acceptées:	High, Medium, Low, Duration, DurationResult
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-TraceTimeout

Spécifie le nombre de secondes que le moteur Analysis Services attend avant de terminer la trace (si vous spécifiez le paramètre -TraceFile).

La trace est considérée comme terminée si aucun message de trace n’a été enregistré pendant la période spécifiée.

La valeur de délai d’attente de trace par défaut est de 5 secondes.

Type:	Int32
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Variables

Spécifie des variables de script supplémentaires. Chaque variable est une paire nom-valeur. Si la valeur contient des espaces incorporés ou des caractères de contrôle, elle doit être placée entre guillemets doubles. Utilisez un tableau PowerShell pour spécifier plusieurs variables et leurs valeurs.

Type:	String[]
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:	SwitchParameter
Alias:	wi
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

Entrées

PSObject

Sorties

string

Notes

Prise en charge sur toutes les instances Analysis Services, notamment PowerBI Premium

Partager via