Compartir a través de

Update-AzSynapseWorkspace

  • Referencia
Módulo:
Az.Synapse

Actualiza un área de trabajo de Synapse Analytics.

Sintaxis

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 actualizar, podemos llamar a Get-AzSynapseWorkspace para obtener las propiedades de cifrado del área de trabajo.

Parámetros

-AsJob

Ejecución del cmdlet en segundo plano

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Tipo:SwitchParameter
Alias:cf
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-EnablePublicNetworkAccess

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

Tipo:Boolean
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-EncryptionKeyName

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

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-GitRepository

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

Tipo:PSWorkspaceRepositoryConfiguration
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-InputObject

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

Tipo:PSSynapseWorkspace
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-ManagedVirtualNetwork

Configuración de red virtual administrada.

Tipo:PSManagedVirtualNetworkSettings
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Name

Nombre del área de trabajo de Synapse.

Tipo:String
Alias:WorkspaceName
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ResourceGroupName

Nombre del grupo de recursos.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ResourceId

Identificador de recurso del área de trabajo de Synapse.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-SqlAdministratorLoginPassword

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

Tipo:SecureString
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Tag

Un diccionario de cadenas de etiquetas asociadas al recurso.

Tipo:Hashtable
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín: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.

Tipo:Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Valores aceptados:Add, Remove, Set
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-UserAssignedIdentityId

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

Tipo:List<T>[String]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-UserAssignedIdentityInEncryption

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

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-UseSystemAssignedIdentityInEncryption

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

Tipo:Object
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-WhatIf

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

Tipo:SwitchParameter
Alias:wi
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Entradas

PSSynapseWorkspace

Salidas

PSSynapseWorkspace