次の方法で共有


Export-AzSynapseKqlScript

KQL スクリプトをエクスポートします。

構文

ExportByName (既定)

Export-AzSynapseKqlScript
    -WorkspaceName <String>
    -OutputFolder <String>
    [-Name <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ExportByObject

Export-AzSynapseKqlScript
    -WorkspaceObject <PSSynapseWorkspace>
    -OutputFolder <String>
    [-Name <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ExportByInputObject

Export-AzSynapseKqlScript
    -InputObject <PSKqlScriptResource>
    -OutputFolder <String>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

説明

Export-AzSynapseKqlScript コマンドレットは、Azure Synapse KQL スクリプトを kusto クエリ (.kql) ファイルにエクスポートします。 KQL スクリプトの名前は、エクスポートされたファイルの名前になります。 KQL スクリプトの名前を指定すると、その KQL スクリプトがエクスポートされます。 名前を指定しない場合、コマンドレットはワークスペース内のすべての KQL スクリプトをエクスポートします。

例 1

Export-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -OutputFolder "C:\KqlScript"

ワークスペース ContosoWorkspace 内のすべての KQL スクリプトをフォルダー "C:\KqlScript" にエクスポートします。

例 2

Export-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -Name ContosoKqlScript -OutputFolder "C:\KqlScript"

ワークスペース ContosoWorkspace 内の ContosoKqlScript という名前の 1 つの KQL スクリプトをフォルダー "C:\KqlScript" にエクスポートします。

例 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Export-AzSynapseKqlScript -Name ContosoKqlScript -OutputFolder "C:\KqlScript"

ワークスペース ContosoWorkspace 内の ContosoKqlScript という名前の 1 つの KQL スクリプトを、パイプライン経由でフォルダー "C:\KqlScript" にエクスポートします。

例 4

$KqlScript = Get-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -Name ContosoKqlScript
$KqlScript | Export-AzSynapseKqlScript -OutputFolder "C:\KqlScript"

ワークスペース ContosoWorkspace 内の ContosoKqlScript という名前の 1 つの KQL スクリプトを、パイプライン経由でフォルダー "C:\KqlScript" にエクスポートします。

パラメーター

-AsJob

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

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

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

パラメーター セット

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

-DefaultProfile

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

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

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

パラメーター セット

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

-InputObject

KQL スクリプト オブジェクト。

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

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

パラメーター セット

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

-Name

KQL スクリプト名。

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

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

パラメーター セット

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

-OutputFolder

KQL スクリプトを配置するフォルダー。

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

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

パラメーター セット

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

-WorkspaceName

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

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

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

パラメーター セット

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

-WorkspaceObject

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

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

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

パラメーター セット

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

CommonParameters

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

入力

PSSynapseWorkspace

PSKqlScriptResource

出力

FileInfo