次の方法で共有

Set-AzSynapseSqlScript

  • リファレンス
モジュール:
Az.Synapse

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

構文

Set-AzSynapseSqlScript
   -WorkspaceName <String>
   [-Name <String>]
   -DefinitionFile <String>
   [-ResultLimit <Int32>]
   [-FolderPath <String>]
   [-Description <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzSynapseSqlScript
   -WorkspaceName <String>
   -SqlPoolName <String>
   -SqlDatabaseName <String>
   [-Name <String>]
   -DefinitionFile <String>
   [-ResultLimit <Int32>]
   [-FolderPath <String>]
   [-Description <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzSynapseSqlScript
   -WorkspaceObject <PSSynapseWorkspace>
   [-Name <String>]
   -DefinitionFile <String>
   [-ResultLimit <Int32>]
   [-FolderPath <String>]
   [-Description <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzSynapseSqlScript
   -WorkspaceObject <PSSynapseWorkspace>
   -SqlPoolName <String>
   -SqlDatabaseName <String>
   [-Name <String>]
   -DefinitionFile <String>
   [-ResultLimit <Int32>]
   [-FolderPath <String>]
   [-Description <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzSynapseSqlScript コマンドレットは、ワークスペース内に SQL スクリプトを作成または更新します。

例

例 1

Set-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\sqlscript.sql"

このコマンドは、ContosoWorkspace という名前のワークスペースにsqlscript.sql SQL スクリプト ファイルから SQL スクリプトを作成または更新します。

例 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Set-AzSynapseSqlScript -DefinitionFile "C:\\samples\\sqlscript.sql"

このコマンドは、ContosoWorkspace という名前のワークスペースにsqlscript.sql SQL スクリプト ファイルから SQL スクリプトを作成または更新します。

例 3

Set-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\sqlscript.sql"  -SqlPoolName Contososqlpool -SqlDatabaseName Contosodatabase

このコマンドは、ContosoSqlPool に接続し、ContosoWorkspace というワークスペース内の Contosodatabase という名前のデータベースを使用する SQL スクリプト ファイルsqlscript.sqlから SQL スクリプトを作成または更新します。

パラメーター

-AsJob

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

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

-Confirm

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

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

-DefaultProfile

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

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

-DefinitionFile

SQL ファイルのパス。

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

-Description

SQL スクリプトの説明。

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

-FolderPath

この SQL スクリプトが存在するフォルダー。 [rootFolder/subFolder] などの複数レベルのパスを指定すると、SqlScript が一番下のレベルに表示されます。 指定しない場合、この SQL スクリプトはルート レベルで表示されます。

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

-Name

SQL スクリプト名。

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

-ResultLimit

結果の制限、制限なしの場合は '-1'。

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

-SqlDatabaseName

SQL スクリプトで使用するデータベース。

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

-SqlPoolName

SQL スクリプトが接続する SQL プール。

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

-WhatIf

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

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

-WorkspaceName

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

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

-WorkspaceObject

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

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

入力

PSSynapseWorkspace

出力

PSSqlScriptResource