你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 cmdlet 创建 Azure Synapse Analytics 工作区。

示例

示例 1

$password = ConvertTo-SecureString "Password123!" -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 工作区，该工作区使用 ContosoAdlGen存储 数据存储。

示例 2

$config = New-AzSynapseManagedVirtualNetworkConfig -PreventDataExfiltration -AllowedAadTenantIdsForLinking ContosoTenantId
$password = ConvertTo-SecureString "Password123!" -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 "Password123!" -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 "Password123!" -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 工作区，该工作区使用 ContosoAdlGen存储 数据存储。 工作区连接到名为 ContosoRepo 的 Git 存储库。

示例 5

$password = ConvertTo-SecureString "Password123!" -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 工作区，该工作区使用 ContosoAdlGen存储 数据存储，并将从 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 工作区，该工作区使用 ContosoAdlGen存储 数据存储，并使用具有指定密钥标识符的客户管理的密钥启用双重加密，并将托管标识设置为系统分配。 创建后，我们可以调用 Get-AzSynapseWorkspace 以获取工作区的加密属性。

参数

-AsJob

在后台运行 cmdlet

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultDataLakeStorageAccountName

默认 ADLS Gen2 存储帐户名称。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultDataLakeStorageFilesystem

默认的 ADLS Gen2 文件系统。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnablePublicNetworkAccess

启用或禁用对工作区的公共网络访问。 可能的值包括：“Enabled”、“Disabled”

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EncryptionKeyIdentifier

密钥标识符的格式应为：https://{keyvaultname}.vault.azure.net/keys/{keyname}。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EncryptionKeyName

工作区加密密钥名称。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GitRepository

Git 存储库设置。 连接工作区到存储库进行源代码管理和协作，以便处理工作区管道

Type:PSWorkspaceRepositoryConfiguration
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

应在其中创建资源的 Azure 区域。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ManagedResourceGroupName

包含辅助资源的容器。 默认情况下，可以在指定名称时创建。 请注意，此字段不能与 ResourceGroupName 相同

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ManagedVirtualNetwork

专用于 Azure Synapse 工作区的 Synapse 托管虚拟网络的名称。

Type:PSManagedVirtualNetworkSettings
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Synapse 工作区的名称。

Type:String
Aliases:WorkspaceName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

资源组名称。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SqlAdministratorLoginCredential

SQL 管理员凭据。

Type:PSCredential
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Tag

与资源关联的标记的字符串字符串字典。

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UserAssignedIdentityId

用户分配的工作区托管标识 ID。

Type:List<T>[String]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserAssignedIdentityInEncryption

工作区加密中使用的用户分配的标识资源 ID

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseSystemAssignedIdentityInEncryption

指定是否在工作区加密中使用系统分配的标识

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

String

Hashtable

PSCredential

输出

PSSynapseWorkspace