Invoke-ASCmd

  • リファレンス
モジュール:
SQLServer

データベース管理者は、Analysis Services のインスタンスに対して XMLA スクリプト、TMSL スクリプト、データ分析式 (DAX) クエリ、多次元式 (MDX) クエリ、またはデータ マイニング拡張機能 (DMX) ステートメントを実行できます。

構文

Invoke-ASCmd
      [-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>]
      [-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>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-ASCmd
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-ASCmd
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

データベース管理者は、Analysis Services のインスタンスに対して XMLA スクリプト、TMSL スクリプト、データ分析式 (DAX) クエリ、多次元式 (MDX) クエリ、またはデータ マイニング拡張機能 (DMX) ステートメントを実行できます。

入力ファイル内でこれらのクエリまたはスクリプトを実行するコマンドレット。

渡されるスクリプトは XMLA コマンドであり、Alter、Backup、Batch、BeginTransaction、Cancel、ClearCache、CommitTransaction、Create、Delete、DesignAggregations、Drop、Insert、Lock、MergePartitions、NotifyTableChange、Process、Restore、RollbackTransaction、Statement (MDX クエリと DMX ステートメントの実行に使用)、Subscribe、Synchronize、Unlock、Update、UpdateCells の各コマンドがサポートされています。

このスクリプトでは、互換性モードが 1200 以上の表形式データベースに対して実行するように設計された JSON コマンドも受け入れられます。

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

例

探索の呼び出し

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

探索を呼び出す 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>"

選択を呼び出す

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] )"

呼び出しの選択 2

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

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>

#>

パラメーター

-ApplicationId

サービス プリンシパルのアプリケーション ID。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CertificateThumbprint

サービス プリンシパルの証明書の拇印。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionString

接続文字列を指定します。

サーバー、データベースなどの他の接続レベルのプロパティに注意してください。は、このプロパティが指定されている場合は無視されるため、これらのプロパティを接続文字列に含む必要があります。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionTimeout

Analysis Services インスタンスへの接続がタイムアウトするまでの秒数を指定します。タイムアウト値は、0 ~ 65534 の整数である必要があります。 0 を指定した場合、接続の試行はタイムアウトしません。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

このパラメーターを指定した場合は、指定された Analysis Server インスタンスへの接続に、渡されたユーザー名とパスワードが使用されます。 資格情報を指定していない場合は、ツールを実行しているユーザーの既定の Windows アカウントが使用されます。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Database

MDX クエリまたは DMX ステートメントの実行対象であるデータベースを指定します。 XMLA スクリプトにはデータベース名が埋め込まれているため、コマンドレットで XMLA スクリプトを実行する場合、Database パラメーターは無視されます。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputFile

XMLA スクリプト、MDX クエリ、DMX ステートメント、または TMSL スクリプト (JSON 形式) が記述されているファイルを指定します。 Invoke-AsCmd を使用する場合は、 InputFile または *Query *パラメーターの値を指定する必要があります。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Query

ファイル内にではなくコマンド ラインから直接、実際のスクリプト、クエリ、またはステートメントを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-QueryTimeout

クエリがタイムアウトするまでの秒数を指定します。タイムアウト値が指定されていない場合、クエリはタイムアウトしません。タイムアウトは、1 ~ 65535 の整数である必要があります。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Server

SQLAS Provider ディレクトリに現在存在しない場合は、接続するサーバー インスタンスを必要に応じて指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServicePrincipal

この接続でサービス プリンシパルを使用することを指定します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TenantId

サービス プリンシパルのテナント ID。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TraceFile

XMLA スクリプト、MDX クエリ、または DMX ステートメントの実行中に Analysis Services トレース イベントを受信するファイルを識別します。 ファイルが既に存在する場合は、自動的に上書きされます (-TraceLevel:Duration および -TraceLevel:DurationResult パラメーター設定を使用して作成されたトレース ファイルを除く)。

スペースを含むファイル名は、引用符 ("") で囲む必要があります。

ファイル名が無効な場合は、エラー メッセージが生成されます。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TraceFileDelimiter

-TraceFileFormat パラメーターを使用するトレース ファイルの形式として csv を指定する場合は、トレース ファイルの区切り記号として 1 文字を指定します。

既定値は | (パイプ、つまり縦棒) です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TraceFileFormat

-TraceFile パラメーターのファイル形式を指定します (このパラメーターが指定されている場合)。

既定値は "Csv" です。

Type:TraceFileFormatOption
Accepted values:Csv, Text
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TraceLevel

トレース ファイルにどのようなデータを集めて記録するかを指定します。 指定できる値は、High、Medium、Low、Duration、DurationResult です。

Type:TraceLevelOption
Accepted values:High, Medium, Low, Duration, DurationResult
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TraceTimeout

Analysis Services エンジンがトレースを終了するまで待機する秒数を指定します (-TraceFile パラメーターを指定した場合)。

指定された秒数の間、トレース メッセージが記録されなかった場合、トレースが終了したと見なされます。

トレース タイムアウトの既定値は 5 秒です。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Variables

追加のスクリプト変数を指定します。 各変数は、名前と値のペアです。 スペースや制御文字が値に含まれている場合は、二重引用符で囲む必要があります。 複数の変数とその値を指定するには、PowerShell 配列を使用します。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSObject

出力

string

メモ

PowerBI Premium を含むすべての Analysis Services インスタンスでサポートされます