Update-AzSynapseWorkspace

Update-AzSynapseWorkspace
    -Name <String>
    [-ResourceGroupName <String>]
    [-Tag <Hashtable>]
    [-SqlAdministratorLoginPassword <SecureString>]
    [-ManagedVirtualNetwork <PSManagedVirtualNetworkSettings>]
    [-EncryptionKeyName <String>]
    [-UserAssignedIdentityInEncryption <String>]
    [-UseSystemAssignedIdentityInEncryption <Object>]
    [-GitRepository <PSWorkspaceRepositoryConfiguration>]
    [-UserAssignedIdentityAction <UserAssignedManagedIdentityActionType>]
    [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>]
    [-EnablePublicNetworkAccess <Boolean>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update-AzSynapseWorkspace
    -InputObject <PSSynapseWorkspace>
    [-Tag <Hashtable>]
    [-SqlAdministratorLoginPassword <SecureString>]
    [-ManagedVirtualNetwork <PSManagedVirtualNetworkSettings>]
    [-EncryptionKeyName <String>]
    [-UserAssignedIdentityInEncryption <String>]
    [-UseSystemAssignedIdentityInEncryption <Object>]
    [-GitRepository <PSWorkspaceRepositoryConfiguration>]
    [-UserAssignedIdentityAction <UserAssignedManagedIdentityActionType>]
    [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>]
    [-EnablePublicNetworkAccess <Boolean>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update-AzSynapseWorkspace
    -ResourceId <String>
    [-Tag <Hashtable>]
    [-SqlAdministratorLoginPassword <SecureString>]
    [-ManagedVirtualNetwork <PSManagedVirtualNetworkSettings>]
    [-EncryptionKeyName <String>]
    [-UserAssignedIdentityInEncryption <String>]
    [-UseSystemAssignedIdentityInEncryption <Object>]
    [-GitRepository <PSWorkspaceRepositoryConfiguration>]
    [-UserAssignedIdentityAction <UserAssignedManagedIdentityActionType>]
    [-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>]
    [-EnablePublicNetworkAccess <Boolean>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update-AzSynapseWorkspace cmdlet 更新 Azure Synapse Analytics 工作区。

Update-AzSynapseWorkspace -Name ContosoWorkspace -Tag @{'key'='value'}

此命令更新指定 Azure Synapse Analytics 工作区的标记。

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Update-AzSynapseWorkspace -Tag @{'key'='value1'}

此命令通过管道更新指定 Azure Synapse Analytics 工作区的标记。

Update-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace -Tag @{'key'='value2'}

此命令通过资源 ID 通过管道更新指定的 Azure Synapse Analytics 工作区的标记。

$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main
Update-AzSynapseWorkspace -Name ContosoWorkspace -GitRepository $config

此命令将更新为指定的 Azure Synapse Analytics 工作区连接到的 Git 存储库。

Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True

此命令将更新指定的 Azure Synapse Analytics 工作区以启用公用网络访问。

$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup
$uamilist = New-Object System.Collections.Generic.List[string]
foreach($uami in $uamis){
	$uamilist.Add($uami.Id)
}

Update-AzSynapseWorkspace -Name ContosoWorkspace -UserAssignedIdentityAction Add -UserAssignedIdentityId $uamilist

此命令将更新工作区，以在$uamilist中添加用户分配的托管标识。

$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup
$uamilist = New-Object System.Collections.Generic.List[string]
foreach($uami in $uamis){
	$uamilist.Add($uami.Id)
}

Update-AzSynapseWorkspace -Name ContosoWorkspace -UserAssignedIdentityAction Remove -UserAssignedIdentityId $uamilist[0]

此命令从工作区中删除用户分配的托管标识$uamilist[0]。

$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup
$uamilist = New-Object System.Collections.Generic.List[string]
foreach($uami in $uamis){
	$uamilist.Add($uami.Id)
}

Update-AzSynapseWorkspace -Name ContosoWorkspace -UserAssignedIdentityAction Set -UserAssignedIdentityId $uamilist

此命令使用用户分配的托管标识$uamilist更新工作区，这些标识将涵盖当前标识。

##Add a temp key to the workspace
New-AzSynapseWorkspaceKey -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name TempKey -EncryptionKeyIdentifier https://contosoKeyVault.vault.azure.net/keys/TempKey

##Update the workspace and set the temp key as the TDE protector
Update-AzSynapseWorkspace -WorkspaceName ContosoWorkspace -EncryptionKeyName TempKey -UseSystemAssignedIdentityInEncryption $true

##Note, we need to create a new key version for the original encryption key of the Azure key vault before moving to next steps.

##Update the workspace and set the encryption key back after we created a new key version.
Update-AzSynapseWorkspace -WorkspaceName ContosoWorkspace -EncryptionKeyName default -UseSystemAssignedIdentityInEncryption $true

##Remove the temp key
Remove-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name TempKey

此命令演示如何轮换 Synapse 工作区的加密密钥，并使用系统分配的托管标识访问 Azure 密钥库。

$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup
$identityId = $uamis[0].Id
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Update-AzSynapseWorkspace -UseSystemAssignedIdentityInEncryption $false -UserAssignedIdentityInEncryption $identityId
$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
--------------------                                                                                                                                        -------------------------
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/ContosoResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uaminame                     False

此命令将工作区加密托管标识更新为用户分配，并指定用户分配的标识 ID 以访问存储在密钥保管库中的客户管理的密钥。 更新后，我们可以调用 Get-AzSynapseWorkspace 以获取工作区的加密属性。

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。