Update-AzSynapseWorkspace
Aktualisiert einen Synapse Analytics-Arbeitsbereich.
Syntax
SetByNameParameterSet (Standard)
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>]
SetByResourceIdParameterSet
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'}
Dieser Befehl aktualisiert Tags für den angegebenen Azure Synapse Analytics-Arbeitsbereich.
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, mit dem der Arbeitsbereich für den angegebenen Azure Synapse Analytics-Arbeitsbereich verbunden 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 Identitäten 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 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
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
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-Confirm
Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: vgl
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-DefaultProfile
Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure
Parametereigenschaften
Typ: IAzureContextContainer
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: AzContext, AzureRmContext, AzureCredential
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-EnablePublicNetworkAccess
Aktivieren oder Deaktivieren des öffentlichen Netzwerkzugriffs auf den Arbeitsbereich. Mögliche Werte sind: "Enabled", "Disabled"
Parametereigenschaften
Typ: Boolean
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-EncryptionKeyName
Der Name des Arbeitsbereichsverschlüsselungsschlüssels.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-GitRepository
Git Repository-Einstellungen. Verbinden des Arbeitsbereichs mit dem Repository für die Quellcodeverwaltung und Zusammenarbeit für die Arbeit an Ihren Arbeitsbereichspipelinen
Parametereigenschaften
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
Arbeitsbereichseingabeobjekt, in der Regel durch die Pipeline übergeben.
Typ: PSSynapseWorkspace
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
SetByInputObjectParameterSet
Position: Named Obligatorisch: True Wert aus Pipeline: True Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-ManagedVirtualNetwork
Verwaltete Einstellungen für virtuelle Netzwerke.
Parametereigenschaften
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-Name
Name des Synapse-Arbeitsbereichs.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: Arbeitsbereichsname
Parametersätze
SetByNameParameterSet
Position: Named Obligatorisch: True Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-ResourceGroupName
Ressourcengruppenname
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
SetByNameParameterSet
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-ResourceId
Ressourcenbezeichner des Synapse-Arbeitsbereichs.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
SetByResourceIdParameterSet
Position: Named Obligatorisch: True Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-SqlAdministratorLoginPassword
Das neue SQL-Administratorkennwort für den Arbeitsbereich.
Parametereigenschaften
Typ: SecureString
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-Tag
Eine Zeichenfolge, ein Zeichenfolgenwörterbuch mit Tags, die der Ressource zugeordnet sind.
Parametereigenschaften
Typ: Hashtable
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: 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.
Parametereigenschaften
Typ: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Standardwert: None Zulässige Werte: Add, Remove, Set Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-UserAssignedIdentityId
Vom Benutzer zugewiesene verwaltete Identitäts-ID für den Arbeitsbereich.
Parametereigenschaften
Typ: List<T> [ String ]
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-UserAssignedIdentityInEncryption
Benutzer zugewiesene Identitätsressourcen-ID, die in der Arbeitsbereichsverschlüsselung verwendet wird
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-UseSystemAssignedIdentityInEncryption
Angeben, ob die vom System zugewiesene Identität in der Arbeitsbereichsverschlüsselung verwendet werden soll oder nicht
Parametereigenschaften
Typ: Object
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-WhatIf
Zeigt, was passiert, wenn das Cmdlet ausgeführt wird.
Das Cmdlet wird nicht ausgeführt.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: Wi
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters .
Ausgaben
