Share via

Update-AzSynapseWorkspace

  • Referenz
Modul:
Az.Synapse

Aktualisiert einen Synapse Analytics-Arbeitsbereich.

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

Beschreibung

Das Cmdlet Update-AzSynapseWorkspace aktualisiert einen Azure Synapse Analytics-Arbeitsbereich.

Beispiele

Beispiel 1

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

Mit diesen Befehlen werden Tags für den angegebenen Azure Synapse Analytics-Arbeitsbereich aktualisiert.

Beispiel 2

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

Mit diesen Befehlen werden Tags für den angegebenen Azure Synapse Analytics-Arbeitsbereich über die Pipeline aktualisiert.

Beispiel 3

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

Mit diesen Befehlen werden Tags für den angegebenen Azure Synapse Analytics-Arbeitsbereich über die Pipeline mit Ressourcen-ID aktualisiert.

Beispiel 4

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

Mit diesen Befehlen wird das Git-Repository aktualisiert, dem der Arbeitsbereich für den angegebenen Azure Synapse Analytics-Arbeitsbereich zugeordnet ist.

Beispiel 5

Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True

Mit diesen Befehlen wird der angegebene Azure Synapse Analytics-Arbeitsbereich aktualisiert, um den Zugriff auf öffentliche Netzwerke zu ermöglichen.

Beispiel 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

Mit diesen Befehlen wird der Arbeitsbereich aktualisiert, um in $uamilist vom Benutzer zugewiesene verwaltete Identites hinzuzufügen.

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

Mit diesen Befehlen werden vom Benutzer zugewiesene verwaltete Identitäten $uamilist[0] aus dem Arbeitsbereich entfernt.

Beispiel 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

Mit diesen Befehlen wird der Arbeitsbereich mit vom Benutzer zugewiesenen verwalteten Identitäten $uamilist aktualisiert, die aktuelle Identitäten abdecken.

Beispiel 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

Diese Befehle veranschaulichen, wie der Verschlüsselungsschlüssel eines Synapse-Arbeitsbereichs gedreht wird, und es verwendet vom System zugewiesene verwaltete Identität, um auf den Azure Key Vault zuzugreifen.

Beispiel 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

Mit diesen Befehlen wird der Arbeitsbereich "Verschlüsselung verwaltete Identität als vom Benutzer zugewiesen" aktualisiert und eine vom Benutzer zugewiesene Identitäts-ID angegeben, um auf ihren im Schlüsseltresor gespeicherten schlüsselverwalteten Schlüssel zuzugreifen. Nach dem Aktualisieren können wir aufrufen Get-AzSynapseWorkspace , um Verschlüsselungseigenschaften des Arbeitsbereichs abzurufen.

Parameter

-AsJob

Cmdlet im Hintergrund ausführen

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

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

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

-EnablePublicNetworkAccess

Aktivieren oder Deaktivieren des öffentlichen Netzwerkzugriffs auf den Arbeitsbereich. Mögliche Werte sind: "Enabled", "Disabled"

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

-EncryptionKeyName

Der Name des Arbeitsbereichsverschlüsselungsschlüssels.

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

-GitRepository

Git-Repository Einstellungen. Verbinden Arbeitsbereich zum Repository für Quellcodeverwaltung und Zusammenarbeit für die Arbeit an Ihren Arbeitsbereichspipelinen

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

-InputObject

Arbeitsbereichseingabeobjekt, in der Regel durch die Pipeline übergeben.

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

-ManagedVirtualNetwork

Verwaltetes virtuelles Netzwerk Einstellungen.

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

-Name

Name des Synapse-Arbeitsbereichs.

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

-ResourceGroupName

Ressourcengruppenname

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

-ResourceId

Ressourcenbezeichner des Synapse-Arbeitsbereichs.

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

-SqlAdministratorLoginPassword

Das neue SQL-Administratorkennwort für den Arbeitsbereich.

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

-Tag

Eine Zeichenfolge, ein Zeichenfolgenwörterbuch mit Tags, die der Ressource zugeordnet sind.

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

-UserAssignedIdentityAction

Die Aktion muss angegeben werden, wenn Sie vom Benutzer zugewiesene verwaltete Identitäten für den Arbeitsbereich hinzufügen/entfernen/festlegen. Die unterstützten Aktionen sind: Hinzufügen von "Satz hinzufügen" Mittel zum Hinzufügen von vom Benutzer zugewiesenen verwalteten Identitäten für Arbeitsbereich, Entfernen Von Mitteln zum Entfernen von vom Benutzer zugewiesenen verwalteten Identitäten aus dem Arbeitsbereich, Set kann verwendet werden, wenn Sie verwaltete Benutzeridentitäten gleichzeitig hinzufügen und entfernen möchten.

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

Vom Benutzer zugewiesene verwaltete Identitäts-ID für den Arbeitsbereich.

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

-UserAssignedIdentityInEncryption

Benutzer zugewiesene Identitätsressourcen-ID, die in der Arbeitsbereichsverschlüsselung verwendet wird

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

-UseSystemAssignedIdentityInEncryption

Angeben, ob die vom System zugewiesene Identität in der Arbeitsbereichsverschlüsselung verwendet werden soll oder nicht

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

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

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

Eingaben

PSSynapseWorkspace

Ausgaben

PSSynapseWorkspace