Invoke-ASCmd

リファレンス

モジュール:: SQLServer

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

構文

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

説明

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

渡されるスクリプトは 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>"

Select の呼び出し

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

Select 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。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CertificateThumbprint

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ConnectionString

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

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ConnectionTimeout

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

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Credential

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

型:	PSCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Database

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputFile

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ProgressAction

スクリプト、コマンドレット、またはプロバイダーによって生成された進行状況の更新 (Write-Progress コマンドレットによって生成された進行状況バーなど) に対する PowerShell の応答方法を決定します。 Write-Progress コマンドレットは、コマンドの状態を示す進行状況バーを作成します。

型:	ActionPreference
Aliases:	proga
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Query

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-QueryTimeout

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

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Server

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ServicePrincipal

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TenantId

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TraceFile

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

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

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TraceFileDelimiter

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

既定値は |(パイプ、または垂直バー)。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TraceFileFormat

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

既定値は "Csv" です。

型:	TraceFileFormatOption
指定可能な値:	Csv, Text
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TraceLevel

トレースファイルに収集および記録されるデータを指定します。指定できる値は、High、Medium、Low、Duration、DurationResult です。

型:	TraceLevelOption
指定可能な値:	High, Medium, Low, Duration, DurationResult
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TraceTimeout

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

指定した期間中にトレースメッセージが記録されていない場合、トレースは完了したと見なされます。

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

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Variables

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

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSObject

出力

string

メモ

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

次の方法で共有