次の方法で共有


Set-AzSynapseSqlScript

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

構文

SetByName (既定)

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

SetByNameAndSqlPool

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

SetByObject

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

SetByObjectAndSqlPool

Set-AzSynapseSqlScript
    -WorkspaceObject <PSSynapseWorkspace>
    -SqlPoolName <String>
    -SqlDatabaseName <String>
    -DefinitionFile <String>
    [-Name <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
規定値: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

SQL ファイルのパス。

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

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

パラメーター セット

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

-Description

SQL スクリプトの説明。

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

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

パラメーター セット

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

-FolderPath

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

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

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

パラメーター セット

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

-Name

SQL スクリプト名。

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

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

パラメーター セット

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

-ResultLimit

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

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

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

パラメーター セット

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

-SqlDatabaseName

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

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

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

パラメーター セット

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

-SqlPoolName

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

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

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

パラメーター セット

SetByNameAndSqlPool
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
SetByObjectAndSqlPool
配置:Named
必須:True
パイプラインからの値: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
SetByNameAndSqlPool
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WorkspaceObject

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

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

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

パラメーター セット

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

CommonParameters

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

入力

PSSynapseWorkspace

出力

PSSqlScriptResource