Update-AzSynapseWorkspace
Aggiorna un'area di lavoro di Synapse Analytics.
Sintassi
SetByNameParameterSet (Impostazione predefinita)
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>]
Descrizione
Il cmdlet Update-AzSynapseWorkspace aggiorna un'area di lavoro di Azure Synapse Analytics.
Esempio
Esempio 1
Update-AzSynapseWorkspace -Name ContosoWorkspace -Tag @{'key'='value'}
Questo comando aggiorna i tag per l'area di lavoro di Azure Synapse Analytics specificata.
Esempio 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Update-AzSynapseWorkspace -Tag @{'key'='value1'}
Questo comando aggiorna i tag per l'area di lavoro di Azure Synapse Analytics specificata tramite pipeline.
Esempio 3
Update-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace -Tag @{'key'='value2'}
Questo comando aggiorna i tag per l'area di lavoro di Azure Synapse Analytics specificata tramite pipeline con ID risorsa.
Esempio 4
$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main
Update-AzSynapseWorkspace -Name ContosoWorkspace -GitRepository $config
Questo comando aggiorna il repository Git a cui è connessa l'area di lavoro per l'area di lavoro di Azure Synapse Analytics specificata.
Esempio 5
Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True
Questo comando aggiorna l'area di lavoro di Azure Synapse Analytics specificata per abilitare l'accesso alla rete pubblica.
Esempio 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
Questo comando aggiorna l'area di lavoro per aggiungere identità gestite assegnate dall'utente in $uamilist.
Esempio 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]
Questo comando rimuove le identità gestite assegnate dall'utente $uamilist[0] dall'area di lavoro.
Esempio 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
Questo comando aggiorna l'area di lavoro con identità gestite assegnate dall'utente $uamilist che copriranno le identità correnti.
Esempio 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
Questi comandi illustrano come ruotare la chiave di crittografia di un'area di lavoro Synapse e usano l'identità gestita assegnata dal sistema per accedere ad Azure Key Vault.
Esempio 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
Questo comando aggiorna l'identità gestita di crittografia dell'area di lavoro come Assegnata dall'utente e specifica un ID identità assegnato dall'utente per accedere alla chiave gestita dal cliente archiviata nell'insieme di credenziali delle chiavi. Dopo l'aggiornamento, è possibile chiamare Get-AzSynapseWorkspace per ottenere le proprietà di crittografia dell'area di lavoro.
Parametri
-AsJob
Eseguire il cmdlet in background
Proprietà dei parametri
Tipo: SwitchParameter
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-Confirm
Richiede conferma prima di eseguire il cmdlet.
Proprietà dei parametri
Tipo: SwitchParameter
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False Alias: cfr
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-DefaultProfile
Le credenziali, l’account, il tenant e la sottoscrizione usati per comunicare con Azure.
Proprietà dei parametri
Tipo: IAzureContextContainer
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False Alias: AzContext, AzureRmContext, AzureCredential
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-EnablePublicNetworkAccess
Abilitare o disabilitare l'accesso alla rete pubblica all'area di lavoro. I valori possibili includono: 'Enabled', 'Disabled'
Proprietà dei parametri
Tipo: Boolean
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-EncryptionKeyName
Nome della chiave di crittografia dell'area di lavoro.
Proprietà dei parametri
Tipo: String
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-GitRepository
Impostazioni repository Git. Connettere l'area di lavoro al repository per il controllo del codice sorgente e la collaborazione per il lavoro sulle pipeline dell'area di lavoro
Proprietà dei parametri
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
oggetto di input dell'area di lavoro, in genere passato attraverso la pipeline.
Tipo: PSSynapseWorkspace
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
SetByInputObjectParameterSet
Posizione: Named Obbligatorio: True Valore dalla pipeline: True Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-ManagedVirtualNetwork
Impostazioni della rete virtuale gestita.
Proprietà dei parametri
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-Name
Nome dell'area di lavoro di Synapse.
Proprietà dei parametri
Tipo: String
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False Alias: NomeSpazioDiLavoro
Set di parametri
SetByNameParameterSet
Posizione: Named Obbligatorio: True Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-ResourceGroupName
Nome del gruppo di risorse.
Proprietà dei parametri
Tipo: String
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
Set di parametri
SetByNameParameterSet
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-ResourceId
Identificatore della risorsa dell'area di lavoro di Synapse.
Proprietà dei parametri
Tipo: String
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
Set di parametri
SetByResourceIdParameterSet
Posizione: Named Obbligatorio: True Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-SqlAdministratorLoginPassword
Nuova password amministratore SQL per l'area di lavoro.
Proprietà dei parametri
Tipo: SecureString
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-Tag
Stringa, dizionario di stringhe di tag associati alla risorsa.
Proprietà dei parametri
Tipo: Hashtable
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-UserAssignedIdentityAction
L'azione deve essere specificata quando si aggiungono/rimuovono/impostano identità gestite assegnate dall'utente per l'area di lavoro.
Le azioni supportate sono: Add Remove Set Add significa aggiungere identità gestite assegnate dall'utente per l'area di lavoro, Remove significa rimuovere le identità gestite assegnate dall'utente dall'area di lavoro, Impostare può essere usato quando si desidera aggiungere e rimuovere identità gestite assegnate dall'utente contemporaneamente.
Proprietà dei parametri
Tipo: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Valore predefinito: None Valori accettati: Add, Remove, Set Supporta i caratteri jolly: False DontShow: False
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-UserAssignedIdentityId
ID identità gestita assegnata dall'utente per l'area di lavoro.
Proprietà dei parametri
Tipo: List<T> [ String ]
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-UserAssignedIdentityInEncryption
ID risorsa identità assegnata dall'utente usato nella crittografia dell'area di lavoro
Proprietà dei parametri
Tipo: String
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-UseSystemAssignedIdentityInEncryption
specificando se usare o meno l'identità assegnata dal sistema in Crittografia dell'area di lavoro
Proprietà dei parametri
Tipo: Object
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
-WhatIf
Mostra gli effetti dell'esecuzione del cmdlet.
Il cmdlet non viene eseguito.
Proprietà dei parametri
Tipo: SwitchParameter
Valore predefinito: None Supporta i caratteri jolly: False DontShow: False Alias: Wi
Set di parametri
(All)
Posizione: Named Obbligatorio: False Valore dalla pipeline: False Valore dalla pipeline in base al nome della proprietà: False Valore dagli argomenti rimanenti: False
CommonParameters
Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters .
Output
