Update-AzSynapseWorkspace

Referencia

Módulo:: Az.Synapse

Novedades un área de trabajo de Synapse Analytics.

Syntax

Update-AzSynapseWorkspace
      [-ResourceGroupName <String>]
      -Name <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>]

Description

El cmdlet Update-AzSynapseWorkspace actualiza un área de trabajo de Azure Synapse Analytics.

Ejemplos

Ejemplo 1

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

Estos comandos actualizan las etiquetas del área de trabajo de Azure Synapse Analytics especificada.

Ejemplo 2

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

Estos comandos actualizan las etiquetas del área de trabajo de Azure Synapse Analytics especificada a través de la canalización.

Ejemplo 3

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

Estos comandos actualizan las etiquetas del área de trabajo de Azure Synapse Analytics especificada a través de la canalización con el identificador de recurso.

Ejemplo 4

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

Este comando actualiza el repositorio de Git al que se conceda el área de trabajo para el área de trabajo de Azure Synapse Analytics especificada.

Ejemplo 5

Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True

Estos comandos actualizan el área de trabajo de Azure Synapse Analytics especificada para habilitar el acceso a la red pública.

Ejemplo 6

$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

Estos comandos actualizan el área de trabajo para agregar identidades administradas asignadas por el usuario en $uamilist.

Ejemplo 7

$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]

Estos comandos quitan las identidades administradas asignadas por el usuario $uamilist[0] del área de trabajo.

Ejemplo 8

$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

Estos comandos actualizan el área de trabajo con identidades administradas asignadas por el usuario $uamilist que cubrirán las identidades actuales.

Ejemplo 9

##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 encrytion 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

En estos comandos se muestra cómo rotar la clave de cifrado de un área de trabajo de Synapse y se usa la identidad administrada asignada por el sistema para acceder a Azure Key Vault.

Ejemplo 10

$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

Estos comandos actualizan la identidad administrada de cifrado del área de trabajo como asignada por el usuario y especifican un identificador de identidad asignado por el usuario para acceder a la clave administrada por el cliente almacenada en el almacén de claves. Después de la actualización, se puede llamar Get-AzSynapseWorkspace a para obtener las propiedades cifrado del área de trabajo.

Parámetros

-AsJob

Ejecución del cmdlet en segundo plano

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

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

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

-DefaultProfile

Credenciales, cuenta, inquilino y suscripción usados para la comunicación con Azure.

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

-EnablePublicNetworkAccess

Habilite o deshabilite el acceso de red pública al área de trabajo. Los valores posibles son: "Enabled", "Disabled"

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

-EncryptionKeyName

Nombre de la clave de cifrado del área de trabajo.

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

-GitRepository

Configuración del repositorio de Git. Conectar área de trabajo en el repositorio para el control de código fuente y la colaboración para trabajar en las canalizaciones del área de trabajo

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

-InputObject

objeto de entrada del área de trabajo, que normalmente se pasa a través de la canalización.

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

-ManagedVirtualNetwork

Configuración de red virtual administrada.

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

-Name

Nombre del área de trabajo de Synapse.

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

-ResourceGroupName

Nombre del grupo de recursos.

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

-ResourceId

Identificador de recurso del área de trabajo de Synapse.

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

-SqlAdministratorLoginPassword

Nueva contraseña de administrador de SQL para el área de trabajo.

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

-Tag

Un diccionario de cadenas de etiquetas asociadas al recurso.

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

-UserAssignedIdentityAction

La acción debe especificarse al agregar, quitar o establecer identidades administradas asignadas por el usuario para el área de trabajo. Las acciones admitidas son: Add Remove Set Add significa agregar identidades administradas asignadas por el usuario para el área de trabajo, Quitar medios para quitar identidades administradas asignadas por el usuario del área de trabajo, Set se puede usar cuando quiera agregar y quitar identidades administradas asignadas por el usuario al mismo tiempo.

Type:	Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Accepted values:	Add, Remove, Set
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserAssignedIdentityId

Identificador de identidad administrada asignada por el usuario para el área de trabajo.

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

-UserAssignedIdentityInEncryption

Identificador de recurso de identidad asignado por el usuario usado en el cifrado del área de trabajo

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

-UseSystemAssignedIdentityInEncryption

especificar si se va a usar la identidad asignada por el sistema en el cifrado del área de trabajo o no

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

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

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

Entradas

PSSynapseWorkspace

Salidas