Export-AzSynapseKqlScript

モジュール:

Az.Synapse

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

構文

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

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

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:\KqlScirpt"

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

例 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
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

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

-InputObject

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

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

-Name

KQL スクリプト名。

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

-OutputFolder

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

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

-WorkspaceName

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

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

-WorkspaceObject

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

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

入力

PSSynapseWorkspace

PSKqlScriptResource

出力

FileInfo