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 コマンドレットは、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'}

このコマンドは、指定された Azure Synapse Analytics ワークスペースのタグをリソース ID でパイプライン経由で更新します。

$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

このコマンドは、ワークスペースを更新して、ユーザー割り当てマネージド ID を$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]

このコマンドにより、ユーザー割り当てマネージド ID $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

このコマンドは、現在の ID に対応するユーザー割り当てマネージド ID $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 ワークスペースの暗号化キーをローテーションする方法を示しており、システム割り当てマネージド ID を使用して Azure Key Vault にアクセスします。

$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 をユーザー割り当てとして更新し、キー コンテナーに格納されているカスタマー マネージド キーにアクセスするためのユーザー割り当て ID を指定します。 更新後、 Get-AzSynapseWorkspace を呼び出してワークスペースの Encryption プロパティを取得できます。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。