Update-AzSynapseWorkspace
Memperbarui ruang kerja Synapse Analytics.
Sintaks
SetByNameParameterSet (Default)
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>]
Deskripsi
Cmdlet Update-AzSynapseWorkspace memperbarui ruang kerja Azure Synapse Analytics.
Contoh
Contoh 1
Update-AzSynapseWorkspace -Name ContosoWorkspace -Tag @{'key'='value'}
Perintah ini memperbarui tag untuk ruang kerja Azure Synapse Analytics yang ditentukan.
Contoh 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Update-AzSynapseWorkspace -Tag @{'key'='value1'}
Perintah ini memperbarui tag untuk ruang kerja Azure Synapse Analytics yang ditentukan melalui alur.
Contoh 3
Update-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace -Tag @{'key'='value2'}
Perintah ini memperbarui tag untuk ruang kerja Azure Synapse Analytics yang ditentukan melalui alur dengan ID sumber daya.
Contoh 4
$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main
Update-AzSynapseWorkspace -Name ContosoWorkspace -GitRepository $config
Perintah ini memperbarui repositori Git yang terhubung ke ruang kerja untuk ruang kerja Azure Synapse Analytics yang ditentukan.
Contoh 5
Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True
Perintah ini memperbarui ruang kerja Azure Synapse Analytics yang ditentukan untuk mengaktifkan akses jaringan publik.
Contoh 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
Perintah ini memperbarui ruang kerja untuk menambahkan identitas terkelola yang ditetapkan pengguna di $uamilist.
Contoh 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]
Perintah ini menghapus identitas terkelola yang ditetapkan pengguna $uamilist[0] dari ruang kerja.
Contoh 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
Perintah ini memperbarui ruang kerja dengan identitas terkelola yang ditetapkan pengguna $uamilist yang akan mencakup identitas saat ini.
Contoh 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
Perintah ini menunjukkan cara memutar kunci enkripsi ruang kerja Synapse, dan menggunakan System Assigned Managed Identity untuk mengakses Azure Key Vault.
Contoh 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
Perintah ini memperbarui Enkripsi Identitas Terkelola ruang kerja sebagai Ditetapkan Pengguna dan menentukan ID identitas yang ditetapkan pengguna untuk mengakses kunci yang dikelola pelanggan yang disimpan di brankas kunci. Setelah memperbarui, kita dapat memanggil Get-AzSynapseWorkspace untuk mendapatkan properti Enkripsi ruang kerja.
Parameter
-AsJob
Jalankan cmdlet di latar belakang
Properti parameter
Jenis: SwitchParameter
Nilai default: None
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-Confirm
Meminta konfirmasi sebelum menjalankan cmdlet.
Properti parameter
Jenis: SwitchParameter
Nilai default: None
Mendukung wildcard: False
DontShow: False
Alias: Cf
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-DefaultProfile
Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan Azure.
Properti parameter
Jenis: IAzureContextContainer
Nilai default: None
Mendukung wildcard: False
DontShow: False
Alias: AzContext, AzureRmContext, AzureCredential
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-EnablePublicNetworkAccess
Aktifkan atau Nonaktifkan akses jaringan publik ke ruang kerja. Nilai yang mungkin termasuk: 'Diaktifkan', 'Dinonaktifkan'
Properti parameter
Jenis: Boolean
Nilai default: None
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-EncryptionKeyName
Nama kunci enkripsi ruang kerja.
Properti parameter
Jenis: String
Nilai default: None
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-GitRepository
Pengaturan Repositori Git. Menyambungkan ruang kerja ke repositori untuk kontrol sumber dan kolaborasi untuk bekerja pada alur ruang kerja Anda
Properti parameter
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
objek input ruang kerja, biasanya melewati alur.
SetByInputObjectParameterSet
Position: Named
Wajib: True
Nilai dari alur: True
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-ManagedVirtualNetwork
Pengaturan Jaringan Virtual Terkelola.
Properti parameter
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-Name
Nama ruang kerja Synapse.
Properti parameter
Jenis: String
Nilai default: None
Mendukung wildcard: False
DontShow: False
Alias: Nama Ruang Kerja
Kumpulan parameter
SetByNameParameterSet
Position: Named
Wajib: True
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-ResourceGroupName
Nama grup sumber daya.
Properti parameter
Jenis: String
Nilai default: None
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
SetByNameParameterSet
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-ResourceId
Pengidentifikasi sumber daya ruang kerja Synapse.
Properti parameter
Jenis: String
Nilai default: None
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
SetByResourceIdParameterSet
Position: Named
Wajib: True
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-SqlAdministratorLoginPassword
Kata sandi administrator SQL baru untuk ruang kerja.
Properti parameter
Jenis: SecureString
Nilai default: None
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-Tag
String, kamus string tag yang terkait dengan sumber daya.
Properti parameter
Jenis: Hashtable
Nilai default: None
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-UserAssignedIdentityAction
Tindakan harus ditentukan saat Anda menambahkan/menghapus/mengatur identitas terkelola yang ditetapkan pengguna untuk ruang kerja.
Tindakan yang didukung adalah: Tambahkan Hapus Atur Tambahkan sarana untuk menambahkan identitas terkelola yang ditetapkan pengguna untuk ruang kerja, Menghapus sarana untuk menghapus identitas terkelola yang ditetapkan pengguna dari ruang kerja, Atur dapat digunakan saat Anda ingin menambahkan dan menghapus identitas terkelola yang ditetapkan pengguna secara bersamaan.
Properti parameter
Jenis: Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Nilai default: None
Nilai yang diterima: Add, Remove, Set
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-UserAssignedIdentityId
Id identitas terkelola yang ditetapkan pengguna untuk ruang kerja.
Properti parameter
Jenis: List<T> [ String ]
Nilai default: None
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-UserAssignedIdentityInEncryption
Id sumber daya identitas yang ditetapkan pengguna yang digunakan dalam Enkripsi Ruang Kerja
Properti parameter
Jenis: String
Nilai default: None
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-UseSystemAssignedIdentityInEncryption
menentukan apakah akan menggunakan identitas yang ditetapkan sistem di Enkripsi Ruang Kerja atau tidak
Properti parameter
Jenis: Object
Nilai default: None
Mendukung wildcard: False
DontShow: False
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
-WhatIf
Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan.
Cmdlet tidak dijalankan.
Properti parameter
Jenis: SwitchParameter
Nilai default: None
Mendukung wildcard: False
DontShow: False
Alias: wi
Kumpulan parameter
(All)
Position: Named
Wajib: False
Nilai dari alur: False
Nilai dari alur berdasarkan nama properti: False
Nilai dari argumen yang tersisa: False
CommonParameters
Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters .
Output