次の方法で共有


New-AzSynapseKqlScript

ワークスペース内の KQL スクリプトを作成または更新します。

構文

SetByName (既定)

New-AzSynapseKqlScript
    -WorkspaceName <String>
    -DefinitionFile <String>
    [-Name <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByNameAndKustoPoolDatabase

New-AzSynapseKqlScript
    -WorkspaceName <String>
    -KustoPoolName <String>
    -KustoPoolDatabaseName <String>
    -DefinitionFile <String>
    [-Name <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByObject

New-AzSynapseKqlScript
    -WorkspaceObject <PSSynapseWorkspace>
    -DefinitionFile <String>
    [-Name <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByObjectAndKustoPoolDatabase

New-AzSynapseKqlScript
    -WorkspaceObject <PSSynapseWorkspace>
    -KustoPoolName <String>
    -KustoPoolDatabaseName <String>
    -DefinitionFile <String>
    [-Name <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

New-AzSynapseKqlScript コマンドレットは、ワークスペースで KQL スクリプトを作成または更新します。

例 1

New-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -DefinitionFile "C:\samples\KqlScript.kql"

このコマンドは、ContosoWorkspace という名前のワークスペース内の Kusto クエリ ファイル KqlScript.kql から KQL スクリプトを作成または更新します。

例 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseKqlScript -DefinitionFile "C:\samples\KqlScript.kql"

このコマンドは、パイプラインを介して ContosoWorkspace という名前のワークスペース内の Kusto クエリ ファイル KqlScript.kql から KQL スクリプトを作成または更新します。

例 3

New-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -DefinitionFile "C:\samples\KqlScript.kql" -KustoPoolName ContosoKustoPool -KustoPoolDatabaseName ContosoKustoPoolDatabase

このコマンドは、Kusto クエリ ファイル KqlScript.kql から KqlScript を作成または更新します。このファイルは、ContosoWorkspace という名前のワークスペース内の ContosoKustoPoolDatabase にアタッチされます。

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行する

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Confirm

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

パラメーターのプロパティ

型:IAzureContextContainer
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefinitionFile

KQL ファイルのパス。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:File

パラメーター セット

(All)
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-KustoPoolDatabaseName

Synapse Kusto データベースの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

SetByNameAndKustoPoolDatabase
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SetByObjectAndKustoPoolDatabase
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-KustoPoolName

Synapse Kusto プールの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

SetByNameAndKustoPoolDatabase
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SetByObjectAndKustoPoolDatabase
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Name

KQL スクリプト名。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:KqlScriptName

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WhatIf

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

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:ウィスコンシン

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WorkspaceName

Synapse ワークスペースの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

SetByName
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SetByNameAndKustoPoolDatabase
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WorkspaceObject

ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。

パラメーターのプロパティ

型:PSSynapseWorkspace
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

SetByObject
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SetByObjectAndKustoPoolDatabase
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

入力

PSSynapseWorkspace

出力

PSKqlScriptResource