Update-AzSynapseWorkspace
Обновляет рабочую область Synapse Analytics.
Синтаксис
SetByNameParameterSet (по умолчанию)
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>]
Описание
Командлет 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 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
В этих командах показано, как повернуть ключ шифрования рабочей области 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
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-Confirm
Запрашивает подтверждение перед запуском cmdlet.
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: cf
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.
Свойства параметра
Тип: IAzureContextContainer
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-EnablePublicNetworkAccess
Включение или отключение доступа к рабочей области общедоступной сети. Возможные значения: "Включено", "Отключено"
Свойства параметра
Тип: Boolean
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-EncryptionKeyName
Имя ключа шифрования рабочей области.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-GitRepository
Параметры репозитория Git. Подключение рабочей области к репозиторию для управления версиями и совместной работы для работы с конвейерами рабочей области
Свойства параметра
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
Входной объект рабочей области, обычно передаваемый через конвейер.
Тип: PSSynapseWorkspace
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
SetByInputObjectParameterSet
Position: Named
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-ManagedVirtualNetwork
Управляемые виртуальная сеть параметры.
Свойства параметра
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-Name
Имя рабочей области Synapse.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: Название рабочего пространства
Наборы параметров
SetByNameParameterSet
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-ResourceGroupName
Имя группы ресурсов.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
SetByNameParameterSet
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-ResourceId
Идентификатор ресурса рабочей области Synapse.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
SetByResourceIdParameterSet
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-SqlAdministratorLoginPassword
Новый пароль администратора SQL для рабочей области.
Свойства параметра
Тип: SecureString
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-Tag
Строковый словарь тегов, связанных с ресурсом.
Свойства параметра
Тип: Hashtable
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-UserAssignedIdentityAction
Действие должно быть указано при добавлении или удалении или установке управляемых удостоверений, назначенных пользователем для рабочей области.
Поддерживаемые действия: Добавление добавления набора средств для добавления назначенных пользователем управляемых удостоверений для рабочей области, Удаление означает удаление назначенных пользователем управляемых удостоверений из рабочей области, установка может использоваться, если вы хотите добавить и удалить назначенные пользователем управляемые удостоверения одновременно.
Свойства параметра
Тип: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Default value: None
Допустимые значения: Add, Remove, Set
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-UserAssignedIdentityId
Идентификатор управляемого удостоверения, назначаемого пользователем для рабочей области.
Свойства параметра
Тип: List<T> [ String ]
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-UserAssignedIdentityInEncryption
Идентификатор ресурса назначаемого пользователем удостоверения, используемый в шифровании рабочей области
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-UseSystemAssignedIdentityInEncryption
указание того, следует ли использовать назначенное системой удостоверение в шифровании рабочей области или нет
Свойства параметра
Тип: Object
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-WhatIf
Показывает, что произойдет, если командлет будет запущен.
Командлет не запускается.
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: wi
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters .
Выходные данные