Update-AzSynapseWorkspace

Módulo:

Az.Synapse

Atualiza um espaço de trabalho do Synapse Analytics.

Sintaxe

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

O cmdlet Update-AzSynapseWorkspace do atualiza um espaço de trabalho do Azure Synapse Analytics.

Exemplos

Exemplo 1

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

Este comando atualiza as tags para o espaço de trabalho especificado do Azure Synapse Analytics.

Exemplo 2

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

Este comando atualiza marcas para o espaço de trabalho especificado do Azure Synapse Analytics através do pipeline.

Exemplo 3

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

Este comando atualiza as tags para o espaço de trabalho especificado do Azure Synapse Analytics por meio do pipeline com ID de recurso.

Exemplo 4

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

Este comando atualiza o repositório Git ao qual o espaço de trabalho está vinculado para o espaço de trabalho especificado do Azure Synapse Analytics.

Exemplo 5

Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True

Este comando atualiza o espaço de trabalho especificado do Azure Synapse Analytics para habilitar o acesso à rede pública.

Exemplo 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

Este comando atualiza o espaço de trabalho para adicionar identificações gerenciadas atribuídas ao usuário no $uamilist.

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

Este comando remove identificações gerenciadas atribuídas pelo usuário $uamilist[0] do espaço de trabalho.

Exemplo 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

Este comando atualiza o espaço de trabalho com identificações gerenciadas atribuídas pelo usuário $uamilist que cobrirão as identidades atuais.

Exemplo 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

Esses comandos demonstram como girar a chave de criptografia de um espaço de trabalho Synapse e está usando a Identidade Gerenciada Atribuída pelo Sistema para acessar o Cofre de Chaves do Azure.

Exemplo 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

Este comando atualiza a Identidade Gerenciada de Criptografia do espaço de trabalho como Atribuído pelo Usuário e especifica um ID de identidade atribuído ao usuário para acessar sua chave gerenciada pelo cliente armazenada no cofre de chaves. Após a atualização, podemos chamar Get-AzSynapseWorkspace para obter as propriedades de criptografia do espaço de trabalho.

Parâmetros

-AsJob

Executar cmdlet em segundo plano

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Tipo:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-EnablePublicNetworkAccess

Habilite ou desabilite o acesso à rede pública ao espaço de trabalho. Os valores possíveis incluem: 'Ativado', 'Desativado'

Tipo:	Boolean
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-EncryptionKeyName

O nome da chave de criptografia do espaço de trabalho.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-GitRepository

Configurações do repositório Git. Conecte o espaço de trabalho ao repositório para controle do código-fonte e colaboração para o trabalho em seus pipelines de espaço de trabalho

Tipo:	PSWorkspaceRepositoryConfiguration
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-InputObject

objeto de entrada do espaço de trabalho, geralmente passado pelo pipeline.

Tipo:	PSSynapseWorkspace
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-ManagedVirtualNetwork

Configurações de rede virtual gerenciadas.

Tipo:	PSManagedVirtualNetworkSettings
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Name

Nome do espaço de trabalho Sinapse.

Tipo:	String
Aliases:	WorkspaceName
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ResourceGroupName

Nome do grupo de recursos.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ResourceId

Identificador de recurso do espaço de trabalho Sinapse.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-SqlAdministratorLoginPassword

A nova senha de administrador SQL para o espaço de trabalho.

Tipo:	SecureString
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Tag

Um dicionário string,string de tags associadas ao recurso.

Tipo:	Hashtable
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-UserAssignedIdentityAction

A ação deve ser especificada quando você adiciona/remove/define identidades gerenciadas atribuídas pelo usuário para o espaço de trabalho. As ações suportadas são: Adicionar Remover Conjunto Adicionar significa adicionar identidades gerenciadas atribuídas ao usuário para o espaço de trabalho, Remover significa remover identidades gerenciadas atribuídas ao usuário do espaço de trabalho, Definir pode ser usado quando você deseja adicionar e remover identidades gerenciadas atribuídas ao usuário ao mesmo tempo.

Tipo:	Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Valores aceites:	Add, Remove, Set
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-UserAssignedIdentityId

ID de identidade gerenciada atribuída pelo usuário para o espaço de trabalho.

Tipo:	List<T>[String]
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-UserAssignedIdentityInEncryption

ID do recurso de identidade atribuído pelo usuário usado na criptografia de espaço de trabalho

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-UseSystemAssignedIdentityInEncryption

especificando se a identidade atribuída ao sistema deve ser usada na Criptografia de Espaço de Trabalho ou não

Tipo:	Object
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

Entradas

PSSynapseWorkspace

Saídas

PSSynapseWorkspace