Update-AzSynapseWorkspace
Uppdaterar en Synapse Analytics-arbetsyta.
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>]
Description
Cmdleten Update-AzSynapseWorkspace uppdaterar en Azure Synapse Analytics-arbetsyta.
Exempel
Exempel 1
Update-AzSynapseWorkspace -Name ContosoWorkspace -Tag @{'key'='value'}
Det här kommandot uppdaterar taggar för den angivna Azure Synapse Analytics-arbetsytan.
Exempel 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Update-AzSynapseWorkspace -Tag @{'key'='value1'}
Det här kommandot uppdaterar taggar för den angivna Azure Synapse Analytics-arbetsytan via pipeline.
Exempel 3
Update-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace -Tag @{'key'='value2'}
Det här kommandot uppdaterar taggar för den angivna Azure Synapse Analytics-arbetsytan via pipeline med resurs-ID.
Exempel 4
$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main
Update-AzSynapseWorkspace -Name ContosoWorkspace -GitRepository $config
Det här kommandot uppdaterar Git-lagringsplatsen som arbetsytan är ansluten till för den angivna Azure Synapse Analytics-arbetsytan.
Exempel 5
Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True
De här kommandona uppdaterar den angivna Azure Synapse Analytics-arbetsytan för att aktivera åtkomst till offentliga nätverk.
Exempel 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
Det här kommandot uppdaterar arbetsytan för att lägga till användartilldelade hanterade identiteter i $uamilist.
Exempel 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]
De här kommandona tar bort användartilldelade hanterade identiteter $uamilist[0] från arbetsytan.
Exempel 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
Det här kommandot uppdaterar arbetsytan med användartilldelade hanterade identiteter $uamilist som täcker aktuella identiteter.
Exempel 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
De här kommandona visar hur du roterar krypteringsnyckeln för en Synapse-arbetsyta och använder systemtilldelad hanterad identitet för att få åtkomst till Azure Key Vault.
Exempel 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
Det här kommandot uppdaterar arbetsytans krypteringshanterade identitet som Användartilldelad och anger ett användartilldelat identitets-ID för åtkomst till din kundhanterade nyckel som lagras i nyckelvalvet. Efter uppdateringen kan vi anropa Get-AzSynapseWorkspace för att hämta krypteringsegenskaper för arbetsytan.
Parametrar
-AsJob
Kör cmdlet i bakgrunden
Parameteregenskaper
Typ: SwitchParameter
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
Parameteregenskaper
Typ: SwitchParameter
Standardvärde: None Stöder jokertecken: False DontShow: False Alias: jfr
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-DefaultProfile
Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.
Parameteregenskaper
Typ: IAzureContextContainer
Standardvärde: None Stöder jokertecken: False DontShow: False Alias: AzContext, AzureRmContext, AzureCredential
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-EnablePublicNetworkAccess
Aktivera eller inaktivera offentlig nätverksåtkomst till arbetsytan. Möjliga värden är: "Aktiverad", "Inaktiverad"
Parameteregenskaper
Typ: Boolean
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-EncryptionKeyName
Namnet på arbetsytans krypteringsnyckel.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-GitRepository
Inställningar för Git-lagringsplats. Ansluta arbetsytan till lagringsplatsen för källkontroll och samarbete för arbete med dina arbetsytepipelines
Parameteregenskaper
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
indataobjekt för arbetsytan, som vanligtvis skickas via pipelinen.
SetByInputObjectParameterSet
Position: Named Obligatorisk: True Värde från pipeline: True Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-ManagedVirtualNetwork
Inställningar för hanterat virtuellt nätverk.
Parameteregenskaper
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-Name
Namnet på Synapse-arbetsytan.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False Alias: ArbetsytaNamn
Parameteruppsättningar
SetByNameParameterSet
Position: Named Obligatorisk: True Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-ResourceGroupName
Namn på resursgrupp.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
SetByNameParameterSet
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-ResourceId
Resursidentifierare för Synapse-arbetsyta.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
SetByResourceIdParameterSet
Position: Named Obligatorisk: True Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-SqlAdministratorLoginPassword
Det nya SQL-administratörslösenordet för arbetsytan.
Parameteregenskaper
Typ: SecureString
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-Tag
En sträng,strängordlista med taggar som är associerade med resursen.
Parameteregenskaper
Typ: Hashtable
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-UserAssignedIdentityAction
Åtgärden måste anges när du lägger till/tar bort/anger användartilldelade hanterade identiteter för arbetsytan.
De åtgärder som stöds är: Lägg till Lägg till lägg till verktyg för att lägga till användartilldelade hanterade identiteter för arbetsytan, Ta bort innebär att ta bort användartilldelade hanterade identiteter från arbetsytan, Set kan användas när du vill lägga till och ta bort användartilldelade hanterade identiteter samtidigt.
Parameteregenskaper
Typ: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Standardvärde: None Godkända värden: Add, Remove, Set Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-UserAssignedIdentityId
Användartilldelad hanterad identitets-ID för arbetsyta.
Parameteregenskaper
Typ: List<T> [ String ]
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-UserAssignedIdentityInEncryption
Användartilldelat identitetsresurs-ID som används i arbetsytekryptering
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-UseSystemAssignedIdentityInEncryption
ange om systemtilldelad identitet ska användas i arbetsytekryptering eller inte
Parameteregenskaper
Typ: Object
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-WhatIf
Visar vad som skulle hända om kommandot körs.
Cmdleten körs inte.
Parameteregenskaper
Typ: SwitchParameter
Standardvärde: None Stöder jokertecken: False DontShow: False Alias: Wi
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters .
Utdata
