Update-AzSynapseWorkspace
Обновления рабочей области Synapse Analytics.
Синтаксис
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>] Описание
Командлет Update-AzSynapseWorkspace обновляет рабочую область Azure Synapse Analytics.
Примеры
Пример 1
Update-AzSynapseWorkspace -Name ContosoWorkspace -Tag @{'key'='value'}Эти команды обновляют теги для указанной рабочей области Azure Synapse Analytics.
Пример 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Update-AzSynapseWorkspace -Tag @{'key'='value1'}Эти команды обновляют теги для указанной рабочей области Azure Synapse Analytics с помощью конвейера.
Пример 3
Update-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace -Tag @{'key'='value2'}Эти команды обновляют теги для указанной рабочей области Azure Synapse Analytics с помощью конвейера с идентификатором ресурса.
Пример 4
$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main
Update-AzSynapseWorkspace -Name ContosoWorkspace -GitRepository $configЭти команды обновляют репозиторий Git, в котором рабочая область является указанной для указанной рабочей области Azure Synapse Analytics.
Пример 5
Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $TrueЭти команды обновляют рабочая область Azure Synapse Analytics, чтобы включить доступ к общедоступной сети.
Пример 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Эта команда обновляет рабочую область, чтобы добавить назначенные пользователем управляемые идентификаторы в $uamilist.
Пример 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]Эта команда удаляет назначенные пользователем управляемые идентификаторы $uamilist[0] из рабочей области.
Пример 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Эта команда обновляет рабочую область с назначенными пользователем управляемыми идентификаторами $uamilist, которые будут охватывать текущие удостоверения.
Пример 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В этих командах показано, как повернуть ключ шифрования рабочей области Synapse и использовать управляемое удостоверение, назначенное системой, для доступа к Azure Key Vault.
Пример 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Эти команды обновляют управляемое удостоверение для шифрования рабочей области в качестве назначенного пользователем идентификатора и укажите идентификатор, назначенный пользователем, чтобы получить доступ к ключу, управляемому клиентом, хранящимся в хранилище ключей. После обновления можно вызвать Get-AzSynapseWorkspace для получения свойств шифрования рабочей области.
Параметры
-AsJob
Запуск командлета в фоновом режиме
| Тип: | SwitchParameter |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Запрос подтверждения перед выполнением командлета.
| Тип: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.
| Тип: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnablePublicNetworkAccess
Включение или отключение доступа к рабочей области общедоступной сети. Возможные значения: "Включено", "Отключено"
| Тип: | Boolean |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EncryptionKeyName
Имя ключа шифрования рабочей области.
| Тип: | String |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GitRepository
Параметры репозитория Git. Подключение рабочую область в репозиторий для управления версиями и совместной работы для работы с конвейерами рабочей области
| Тип: | PSWorkspaceRepositoryConfiguration |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Входной объект рабочей области, обычно передаваемый через конвейер.
| Тип: | PSSynapseWorkspace |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ManagedVirtualNetwork
Управляемые виртуальная сеть Параметры.
| Тип: | PSManagedVirtualNetworkSettings |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Имя рабочей области Synapse.
| Тип: | String |
| Aliases: | WorkspaceName |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Имя группы ресурсов.
| Тип: | String |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceId
Идентификатор ресурса рабочей области Synapse.
| Тип: | String |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SqlAdministratorLoginPassword
Новый пароль администратора SQL для рабочей области.
| Тип: | SecureString |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
Строковый словарь тегов, связанных с ресурсом.
| Тип: | Hashtable |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserAssignedIdentityAction
Действие должно быть указано при добавлении или удалении или установке управляемых удостоверений, назначенных пользователем для рабочей области. Поддерживаемые действия: Добавление добавления набора средств для добавления назначенных пользователем управляемых удостоверений для рабочей области, Удаление означает удаление назначенных пользователем управляемых удостоверений из рабочей области, установка может использоваться, если вы хотите добавить и удалить назначенные пользователем управляемые удостоверения одновременно.
| Тип: | Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType |
| допустимые значения: | Add, Remove, Set |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserAssignedIdentityId
Идентификатор управляемого удостоверения, назначаемого пользователем для рабочей области.
| Тип: | List<T>[String] |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserAssignedIdentityInEncryption
Идентификатор ресурса назначаемого пользователем удостоверения, используемый в шифровании рабочей области
| Тип: | String |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseSystemAssignedIdentityInEncryption
указание того, следует ли использовать назначенное системой удостоверение в шифровании рабочей области или нет
| Тип: | Object |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется.
| Тип: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| значение по умолчанию: | None |
| Обязательно: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Входные данные
Выходные данные
Azure PowerShell
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по