共用方式為


New-AzSynapseWorkspace

建立 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>]

Description

New-AzSynapseWorkspace Cmdlet 會建立 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 的資源群組中,建立名為 ContosoWorkspace 的 Synapse Analytics 工作區,以使用 ContosoAdlGenStorage 數據存放區。

範例 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 的資源群組中,建立名為 ContosoWorkspace 的 Synapse Analytics 工作區,以使用 ContosoAdlGenStorage 數據存放區。 工作區會聯機到名為 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 的資源群組中,建立名為 ContosoWorkspace 的 Synapse Analytics 工作區,以使用 ContosoAdlGenStorage 數據存放區,並將使用者指派的受控識別從 ResourceGroup ContosoResourceGroup 新增至工作區。

範例 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

此命令會建立名為 ContosoWorkspace 的 Synapse Analytics 工作區,該工作區會使用 ContosoAdlGenStorage 數據存放區,在名為 ContosoResourceGroup 的資源群組中,使用指定的密鑰標識符啟用客戶自控密鑰的雙重加密,並將受控識別設定為系統指派。 建立之後,我們可以呼叫 Get-AzSynapseWorkspace,以取得工作區的加密屬性。

參數

-AsJob

在背景執行 Cmdlet

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Confirm

在執行 Cmdlet 之前,提示您進行確認。

類型:SwitchParameter
別名:cf
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-DefaultDataLakeStorageAccountName

預設的ADLS Gen2記憶體帳戶名稱。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-DefaultDataLakeStorageFilesystem

預設的 ADLS Gen2 檔案系統。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

類型:IAzureContextContainer
別名:AzContext, AzureRmContext, AzureCredential
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-EnablePublicNetworkAccess

啟用或停用工作區的公用網路存取。 可能的值包括:'Enabled'、'Disabled'

類型:Boolean
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-EncryptionKeyIdentifier

密鑰標識碼的格式應為:https://{keyvaultname}.vault.azure.net/keys/{keyname}。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-EncryptionKeyName

工作區加密金鑰名稱。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-GitRepository

Git 存放庫設定。 將工作區聯機至原始檔控制和共同作業的存放庫,以在工作區管線上工作

類型:PSWorkspaceRepositoryConfiguration
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Location

應建立資源的 Azure 區域。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-ManagedResourceGroupName

保存輔助資源的容器。 根據預設,可以在指定名稱時建立。 請注意,此欄位不得與 ResourceGroupName 相同

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ManagedVirtualNetwork

Azure Synapse 工作區專用的 Synapse 受控虛擬網路名稱。

類型:PSManagedVirtualNetworkSettings
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Name

Synapse 工作區的名稱。

類型:String
別名:WorkspaceName
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-ResourceGroupName

資源組名。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-SqlAdministratorLoginCredential

SQL 系統管理員認證。

類型:PSCredential
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-Tag

與資源相關聯之標籤的字串、字串字典。

類型:Hashtable
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-UserAssignedIdentityId

使用者指派的工作區受控識別標識碼。

類型:List<T>[String]
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-UserAssignedIdentityInEncryption

工作區加密中使用的使用者指派身分識別資源標識碼

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-UseSystemAssignedIdentityInEncryption

指定是否要在工作區加密中使用系統指派的身分識別

類型:Object
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。

類型:SwitchParameter
別名:wi
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

輸入

輸出