Update-AzSynapseWorkspace
Aktualizuje pracovní prostor Synapse Analytics.
Syntax
SetByNameParameterSet (Výchozí)
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
Rutina Update-AzSynapseWorkspace aktualizuje pracovní prostor Azure Synapse Analytics.
Příklady
Příklad 1
Update-AzSynapseWorkspace -Name ContosoWorkspace -Tag @{'key'='value'}
Tento příkaz aktualizuje značky pro zadaný pracovní prostor Azure Synapse Analytics.
Příklad 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Update-AzSynapseWorkspace -Tag @{'key'='value1'}
Tento příkaz aktualizuje značky pro zadaný pracovní prostor Azure Synapse Analytics prostřednictvím kanálu.
Příklad 3
Update-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace -Tag @{'key'='value2'}
Tyto příkazy aktualizují značky pro zadaný pracovní prostor Azure Synapse Analytics prostřednictvím kanálu s ID prostředku.
Příklad 4
$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main
Update-AzSynapseWorkspace -Name ContosoWorkspace -GitRepository $config
Tyto příkazy aktualizují úložiště Git, ke kterému je pracovní prostor připojený pro zadaný pracovní prostor Azure Synapse Analytics.
Příklad 5
Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True
Tyto příkazy aktualizují zadaný pracovní prostor Azure Synapse Analytics tak, aby umožňoval přístup k veřejné síti.
Příklad 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
Tento příkaz aktualizuje pracovní prostor a přidá spravované identity přiřazené uživatelem do $uamilist.
Příklad 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]
Tyto příkazy odeberou spravované identity přiřazené uživatelem $uamilist[0] z pracovního prostoru.
Příklad 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
Tento příkaz aktualizuje pracovní prostor pomocí spravovaných identit přiřazených uživatelem $uamilist, které budou zahrnovat aktuální identity.
Příklad 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
Tyto příkazy ukazují, jak otočit šifrovací klíč pracovního prostoru Synapse a používá spravovanou identitu přiřazenou systémem pro přístup ke službě Azure Key Vault.
Příklad 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
Tento příkaz aktualizuje spravovanou identitu šifrování pracovního prostoru jako přiřazenou uživatelem a určí ID identity přiřazené uživatelem pro přístup k klíči spravovanému zákazníkem uloženým v trezoru klíčů. Po aktualizaci můžeme volat Get-AzSynapseWorkspace , abychom získali vlastnosti šifrování pracovního prostoru.
Parametry
-AsJob
Spuštění rutiny na pozadí
Vlastnosti parametru
Typ: SwitchParameter
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-Confirm
Před spuštěním cmdletu vás vyzve k potvrzení.
Vlastnosti parametru
Typ: SwitchParameter
Default value: None Podporuje zástupné znaky: False DontShow: False Aliasy: viz
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-DefaultProfile
Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.
Vlastnosti parametru
Typ: IAzureContextContainer
Default value: None Podporuje zástupné znaky: False DontShow: False Aliasy: AzContext, AzureRmContext, AzureCredential
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-EnablePublicNetworkAccess
Povolte nebo zakažte přístup k veřejné síti k pracovnímu prostoru. Mezi možné hodnoty patří: Enabled(Povoleno), Disabled (Zakázáno).
Vlastnosti parametru
Typ: Boolean
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-EncryptionKeyName
Název šifrovacího klíče pracovního prostoru.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-GitRepository
Nastavení úložiště Git. Připojení pracovního prostoru k úložišti pro správu zdrojového kódu a spolupráci pro práci v kanálech pracovního prostoru
Vlastnosti parametru
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
vstupní objekt pracovního prostoru, obvykle předávaný kanálem.
SetByInputObjectParameterSet
Position: Named Povinné: True Hodnota z kanálu: True Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-ManagedVirtualNetwork
Nastavení spravované virtuální sítě
Vlastnosti parametru
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-Name
Název pracovního prostoru Synapse
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False Aliasy: Název pracoviště
Sady parametrů
SetByNameParameterSet
Position: Named Povinné: True Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-ResourceGroupName
Název skupiny prostředků.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
SetByNameParameterSet
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-ResourceId
Identifikátor prostředku pracovního prostoru Synapse
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
SetByResourceIdParameterSet
Position: Named Povinné: True Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-SqlAdministratorLoginPassword
Nové heslo správce SQL pro pracovní prostor.
Vlastnosti parametru
Typ: SecureString
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-Tag
Řetězcový slovník značek přidružených k prostředku.
Vlastnosti parametru
Typ: Hashtable
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-UserAssignedIdentityAction
Akce musí být zadána, když přidáte, odeberete nebo nastavíte spravované identity přiřazené uživatelem pro pracovní prostor.
Podporované akce jsou: Přidání možnosti Přidat sadu přidat prostředky pro přidání spravovaných identit přiřazených uživatelem pro pracovní prostor, Odebrání znamená odebrání spravovaných identit přiřazených uživatelem z pracovního prostoru. Sadu můžete použít, když chcete přidat a odebrat spravované identity přiřazené uživatelem najednou.
Vlastnosti parametru
Typ: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Default value: None Přípustné hodnoty: Add, Remove, Set Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-UserAssignedIdentityId
ID spravované identity přiřazené uživatelem pro pracovní prostor
Vlastnosti parametru
Typ: List<T> [ String ]
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-UserAssignedIdentityInEncryption
ID prostředku identity přiřazené uživatelem použitého v šifrování pracovního prostoru
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-UseSystemAssignedIdentityInEncryption
určení, jestli se má použít identita přiřazená systémem v šifrování pracovního prostoru, nebo ne
Vlastnosti parametru
Typ: Object
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-WhatIf
Ukazuje, co se stane, když se příkaz spustí.
Příkazový modul nebyl spuštěn.
Vlastnosti parametru
Typ: SwitchParameter
Default value: None Podporuje zástupné znaky: False DontShow: False Aliasy: Wi
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters .
Výstupy
