次の方法で共有

New-AzSynapseWorkspace

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

Synapse Analytics ワークスペースを作成します。

構文

New-AzSynapseWorkspace
   -ResourceGroupName <String>
   -Name <String>
   -Location <String>
   [-Tag <Hashtable>]
   -DefaultDataLakeStorageAccountName <String>
   -DefaultDataLakeStorageFilesystem <String>
   -SqlAdministratorLoginCredential <PSCredential>
   [-ManagedVirtualNetwork <PSManagedVirtualNetworkSettings>]
   [-EncryptionKeyName <String>]
   [-EncryptionKeyIdentifier <String>]
   [-UserAssignedIdentityInEncryption <String>]
   [-UseSystemAssignedIdentityInEncryption <Object>]
   [-AsJob]
   [-ManagedResourceGroupName <String>]
   [-GitRepository <PSWorkspaceRepositoryConfiguration>]
   [-EnablePublicNetworkAccess <Boolean>]
   [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

New-AzSynapseWorkspace コマンドレットは、Azure Synapse Analytics ワークスペースを作成します。

例

例 1

$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password)
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds

このコマンドは、ContosoResourceGroup という名前のリソース グループに ContosoAdlGenStorage データ ストアを使用する ContosoWorkspace という名前の Synapse Analytics ワークスペースを作成します。

例 2

$config = New-AzSynapseManagedVirtualNetworkConfig -PreventDataExfiltration -AllowedAadTenantIdsForLinking ContosoTenantId
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password)
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -ManagedVirtualNetwork $config

最初のコマンドは、マネージド仮想ネットワーク構成を作成します。 その後、残りのメソッドは構成を使用して新しい Synapse ワークスペースを作成します。

例 3

$config = New-AzSynapseManagedVirtualNetworkConfig -PreventDataExfiltration -AllowedAadTenantIdsForLinking ContosoTenantId
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password)
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -ManagedVirtualNetwork $config -EnablePublicNetworkAccess $True

最初のコマンドは、マネージド仮想ネットワーク構成を作成します。 次に、残りの方法では、構成を使用して、マネージド仮想ネットワークとパブリック ネットワーク アクセスが有効になっている新しい Synapse ワークスペースを作成します。

例 4

$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password)
$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -GitRepository $config

このコマンドは、ContosoResourceGroup という名前のリソース グループに ContosoAdlGenStorage データ ストアを使用する ContosoWorkspace という名前の Synapse Analytics ワークスペースを作成します。 ワークスペースは ContosoRepo という Git リポジトリに接続されています。

例 5

$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password)
$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup
$uamilist = New-Object System.Collections.Generic.List[string]
foreach($uami in $uamis){
	$uamilist.Add($uami.Id)
}
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -UserAssignedIdentityId $uamilist

このコマンドは、ContosoResourceGroup という名前のリソース グループに ContosoAdlGenStorage データ ストアを使用する ContosoWorkspace という名前の Synapse Analytics ワークスペースを作成し、ResourceGroup ContosoResourceGroup からワークスペースに取得するユーザー割り当てマネージド ID を追加します。

例 6

New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -EncryptionKeyIdentifier $identifier -UseSystemAssignedIdentityInEncryption $true
$ws = Get-AzSynapseWorkspace -name ContosoWorkspace
$ws.Encryption.CustomerManagedKeyDetails.Key

Name    KeyVaultUrl
----    -----------
default https://contosoKeyValut.vault.azure.net/keys/testkey

$ws = Get-AzSynapseWorkspace -name ContosoWorkspace
$ws.Encryption.CustomerManagedKeyDetails.KekIdentity

UserAssignedIdentity UseSystemAssignedIdentity
-------------------- -------------------------
                                          True

このコマンドは、ContosoResourceGroup という名前のリソース グループに ContosoAdlGenStorage データ ストアを使用する ContosoWorkspace という名前の Synapse Analytics ワークスペースを作成し、指定したキー識別子を持つカスタマー マネージド キーによる二重暗号化を有効にし、マネージド ID をシステム割り当てとして設定します。 作成後、 Get-AzSynapseWorkspace を呼び出してワークスペースの Encryption プロパティを取得できます。

パラメーター

-AsJob

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

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

-Confirm

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

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

-DefaultDataLakeStorageAccountName

既定の ADLS Gen2 ストレージ アカウント名。

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

-DefaultDataLakeStorageFilesystem

既定の ADLS Gen2 ファイル システム。

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

-DefaultProfile

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

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

-EnablePublicNetworkAccess

ワークスペースへのパブリック ネットワーク アクセスを有効または無効にします。 使用可能な値は、'Enabled'、'Disabled' です。

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

-EncryptionKeyIdentifier

キー識別子は、https://{keyvaultname}.vault.azure.net/keys/{keyname} の形式にする必要があります。

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

-EncryptionKeyName

ワークスペース暗号化キーの名前。

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

-GitRepository

Git リポジトリの設定。 ワークスペースをリポジトリに接続してソース管理とコラボレーションを行い、ワークスペース パイプラインでの作業を行う

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

-Location

リソースを作成する必要がある Azure リージョン。

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

-ManagedResourceGroupName

補助的なリソースを保持するコンテナー。 名前を指定できる間、既定で作成されます。 このフィールドは ResourceGroupName と同じにすることはできません。

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

-ManagedVirtualNetwork

Azure Synapse ワークスペース専用の Synapse マネージド仮想ネットワークの名前。

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

-Name

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

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

-ResourceGroupName

リソース グループ名。

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

-SqlAdministratorLoginCredential

SQL 管理者の資格情報。

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

-Tag

リソースに関連付けられているタグの文字列、文字列ディクショナリ。

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

-UserAssignedIdentityId

ワークスペースのユーザー割り当てマネージド ID。

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

-UserAssignedIdentityInEncryption

Workspace Encryption で使用されるユーザー割り当て ID リソース ID

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

-UseSystemAssignedIdentityInEncryption

Workspace Encryption でシステム割り当て ID を使用するかどうかを指定する

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

-WhatIf

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

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

入力

String

Hashtable

PSCredential

出力

PSSynapseWorkspace