Set-AzSynapseNotebook
ワークスペース内のノートブックを作成または更新します。
構文
Set-AzSynapseNotebook
-WorkspaceName <String>
[-Name <String>]
[-FolderPath <String>]
-DefinitionFile <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSynapseNotebook
-WorkspaceName <String>
[-Name <String>]
[-FolderPath <String>]
-SparkPoolName <String>
[-ExecutorSize <String>]
-ExecutorCount <Int32>
-DefinitionFile <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSynapseNotebook
-WorkspaceObject <PSSynapseWorkspace>
[-Name <String>]
[-FolderPath <String>]
-DefinitionFile <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSynapseNotebook
-WorkspaceObject <PSSynapseWorkspace>
[-Name <String>]
[-FolderPath <String>]
-SparkPoolName <String>
[-ExecutorSize <String>]
-ExecutorCount <Int32>
-DefinitionFile <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-AzSynapseNotebook コマンドレットは、ワークスペース内のノートブックを作成または更新します。
例
例 1
Set-AzSynapseNotebook -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\notebook.ipynb"
WorkspaceName : ContosoWorkspace
Properties : Microsoft.Azure.Commands.Synapse.Models.PSNotebook
Name : notebook
このコマンドは、ContosoWorkspace という名前のワークスペースにノートブック ファイル notebook.ipynb からノートブックを作成または更新します。
例 2
Set-AzSynapseNotebook -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\notebook.ipynb" -FolderPath ContosoFolder
このコマンドは、ノートブック ファイル notebook.ipynb からノートブックを作成または更新し、ContosoWorkspace という名前のワークスペースにノートブックを配置するフォルダー パス ContosoFolder を指定します。
例 3
Set-AzSynapseNotebook -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\notebook.ipynb" -FolderPath ContosoFolder/SubFolder
このコマンドは、ノートブック ファイル notebook.ipynb からノートブックを作成または更新し、ContosoWorkspace という名前のワークスペースにノートブックを配置する複数レベルのフォルダー パス ContosoFolder/SubFolder を指定します。
例 4
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Set-AzSynapseNotebook -DefinitionFile "C:\\samples\\notebook.ipynb"
このコマンドは、パイプラインを介して ContosoWorkspace という名前のワークスペースにノートブック ファイル notebook.ipynb からノートブックを作成または更新します。
例 5
Set-AzSynapseNotebook -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\notebook.ipynb" -SparkPoolName ContosoSparkPool -ExecutorCount 2
このコマンドは、ContosoSparkPool に接続し、ContosoWorkspace という名前のワークスペースで 2 つの Executor を使用するノートブック ファイル notebook.ipynb からノートブックを作成または更新します。
パラメーター
-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
JSON ファイルのパス。
型: | String |
Aliases: | File |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ExecutorCount
ジョブの指定された Spark プールに割り当てられる Executor の数。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ExecutorSize
ジョブの指定された Spark プールに割り当てられた Executor に使用されるコアとメモリの数。
型: | String |
指定可能な値: | Small, Medium, Large, XLarge, XXLarge, XXXLarge |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-FolderPath
このノートブックが存在するフォルダー。 [rootFolder/subFolder] などの複数レベルのパスを指定すると、ノートブックは一番下のレベルに表示されます。 指定しない場合、このノートブックはルート レベルで表示されます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
ノートブック名。
型: | String |
Aliases: | NotebookName |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SparkPoolName
Synapse Spark プールの名前。
型: | 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 |