Update-AzSynapseWorkspace

모듈:

Az.Synapse

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>]

Description

Update-AzSynapseWorkspace cmdlet은 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'}

이 명령은 리소스 ID가 있는 파이프라인을 통해 지정된 Azure Synapse Analytics 작업 영역에 대한 태그를 업데이트합니다.

예시 4

$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main
Update-AzSynapseWorkspace -Name ContosoWorkspace -GitRepository $config

이 명령은 지정된 Azure Synapse Analytics 작업 영역에 대해 연결되는 작업 영역이 Git 리포지토리를 업데이트합니다.

예시 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 사용자 할당 관리 ID를 추가합니다.

예제 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]

이 명령은 작업 영역에서 사용자 할당 관리 ID $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

이 명령은 현재 ID를 다루는 사용자 할당 관리 ID $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 작업 영역의 암호화 키를 회전하는 방법을 보여 하며 시스템 할당 관리 ID를 사용하여 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

이 명령은 작업 영역 암호화 관리 ID를 사용자 할당으로 업데이트하고 사용자 할당 ID를 지정하여 키 자격 증명 모음에 저장된 고객 관리형 키에 액세스합니다. 업데이트한 후 호출 Get-AzSynapseWorkspace 하여 작업 영역의 암호화 속성을 가져올 수 있습니다.

매개 변수

-AsJob

백그라운드에서 cmdlet 실행

형식:	SwitchParameter
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-Confirm

cmdlet을 실행하기 전에 확인 메시지가 표시됩니다.

형식:	SwitchParameter
별칭:	cf
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-DefaultProfile

Azure와의 통신에 사용되는 자격 증명, 계정, 테넌트 및 구독입니다.

형식:	IAzureContextContainer
별칭:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-EnablePublicNetworkAccess

작업 영역에 대한 공용 네트워크 액세스를 사용하거나 사용하지 않도록 설정합니다. 가능한 값은 'Enabled', 'Disabled'입니다.

형식:	Boolean
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-EncryptionKeyName

작업 영역 암호화 키 이름입니다.

형식:	String
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-GitRepository

Git 리포지토리 설정입니다. 작업 영역 파이프라인에서 작업하기 위한 소스 제어 및 공동 작업을 위해 작업 영역을 리포지토리에 연결

형식:	PSWorkspaceRepositoryConfiguration
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-InputObject

일반적으로 파이프라인을 통해 전달되는 작업 영역 입력 개체입니다.

형식:	PSSynapseWorkspace
Position:	Named
Default value:	None
필수:	True
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-ManagedVirtualNetwork

관리형 Virtual Network 설정.

형식:	PSManagedVirtualNetworkSettings
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-Name

Synapse 작업 영역의 이름입니다.

형식:	String
별칭:	WorkspaceName
Position:	Named
Default value:	None
필수:	True
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-ResourceGroupName

리소스 그룹 이름

형식:	String
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-ResourceId

Synapse 작업 영역의 리소스 식별자입니다.

형식:	String
Position:	Named
Default value:	None
필수:	True
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-SqlAdministratorLoginPassword

작업 영역에 대한 새 SQL 관리자 암호입니다.

형식:	SecureString
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-Tag

리소스와 연결된 태그의 문자열 사전입니다.

형식:	Hashtable
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-UserAssignedIdentityAction

작업 영역에 대한 사용자 할당 관리 ID를 추가/제거/설정할 때 작업을 지정해야 합니다. 지원되는 작업은 작업 영역에 대해 사용자 할당 관리 ID를 추가하는 추가 방법 추가, 작업 영역에서 사용자 할당 관리 ID를 제거하는 방법 제거, 사용자가 할당한 관리 ID를 동시에 추가 및 제거하려는 경우 Set를 사용할 수 있습니다.

형식:	Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
허용되는 값:	Add, Remove, Set
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-UserAssignedIdentityId

작업 영역에 대해 사용자가 할당한 관리 ID ID입니다.

형식:	List<T>[String]
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-UserAssignedIdentityInEncryption

작업 영역 암호화에 사용되는 사용자 할당 ID 리소스 ID

형식:	String
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-UseSystemAssignedIdentityInEncryption

작업 영역 암호화에서 시스템 할당 ID를 사용할지 여부 지정

형식:	Object
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-WhatIf

cmdlet이 실행될 경우 결과 동작을 표시합니다. cmdlet이 실행되지 않습니다.

형식:	SwitchParameter
별칭:	wi
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

입력

PSSynapseWorkspace

출력

PSSynapseWorkspace