你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
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>]
说明
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
此命令在名为 ContosoResourceGroup 的资源组中创建名为 ContosoWorkspace 的 Synapse Analytics 工作区,该工作区使用 ContosoAdlGenStorage 数据存储,并使用指定的密钥标识符启用客户管理的密钥的双重加密,并将托管标识设置为系统分配。 创建后,我们可以调用 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
-UserAssignedIdentityInEncryption
工作区加密中使用的用户分配的标识资源 ID
类型: | 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 |