Udostępnij za pośrednictwem

Update-AzSynapseWorkspace

  • Odwołanie
Moduł:
Az.Synapse

Aktualizuje obszar roboczy usługi Synapse Analytics.

Składnia

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

Opis

Polecenie cmdlet Update-AzSynapseWorkspace aktualizuje obszar roboczy usługi Azure Synapse Analytics.

Przykłady

Przykład 1

Update-AzSynapseWorkspace -Name ContosoWorkspace -Tag @{'key'='value'}

To polecenie aktualizuje tagi dla określonego obszaru roboczego usługi Azure Synapse Analytics.

Przykład 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Update-AzSynapseWorkspace -Tag @{'key'='value1'}

To polecenie aktualizuje tagi dla określonego obszaru roboczego usługi Azure Synapse Analytics za pośrednictwem potoku.

Przykład 3

Update-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace -Tag @{'key'='value2'}

To polecenie aktualizuje tagi dla określonego obszaru roboczego usługi Azure Synapse Analytics za pośrednictwem potoku z identyfikatorem zasobu.

Przykład 4

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

To polecenie aktualizuje repozytorium Git, w którym obszarze roboczym jest zainstalowany obszar roboczy dla określonego obszaru roboczego usługi Azure Synapse Analytics.This commands updates Git repository is conneceted to for the specififed Azure Synapse Analytics workspace .This commands updates Git repository is conneceted to for the specififed Azure Synapse Analytics workspace.

Przykład 5

Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True

To polecenie aktualizuje spekulowany obszar roboczy usługi Azure Synapse Analytics, aby umożliwić dostęp do sieci publicznej.

Przykład 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

To polecenie aktualizuje obszar roboczy, aby dodać tożsamości zarządzane przypisane przez użytkownika w $uamilist.

Przykład 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]

To polecenie usuwa tożsamości zarządzane przypisane przez użytkownika $uamilist[0] z obszaru roboczego.

Przykład 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

To polecenie aktualizuje obszar roboczy z tożsamościami zarządzanymi przypisanymi przez użytkownika $uamilist, które będą obejmować bieżące tożsamości.

Przykład 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

To polecenie pokazuje, jak obrócić klucz szyfrowania obszaru roboczego usługi Synapse i używa przypisanej przez system tożsamości zarządzanej w celu uzyskania dostępu do usługi Azure Key Vault.

Przykład 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

To polecenie aktualizuje tożsamość zarządzaną szyfrowania obszaru roboczego jako Przypisano użytkownika i określa identyfikator tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do klucza zarządzanego przez klienta przechowywanego w magazynie kluczy. Po zaktualizowaniu można wywołać Get-AzSynapseWorkspace metodę w celu pobrania właściwości szyfrowania obszaru roboczego.

Parametry

-AsJob

Uruchamianie polecenia cmdlet w tle

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-EnablePublicNetworkAccess

Włączanie lub wyłączanie dostępu do sieci publicznej do obszaru roboczego. Możliwe wartości to: "Włączone", "Wyłączone"

Typ:Boolean
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-EncryptionKeyName

Nazwa klucza szyfrowania obszaru roboczego.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-GitRepository

Ustawienia repozytorium Git. Łączenie obszaru roboczego z repozytorium na potrzeby kontroli źródła i współpracy w celu pracy nad potokami obszaru roboczego

Typ:PSWorkspaceRepositoryConfiguration
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-InputObject

obiekt wejściowy obszaru roboczego, zwykle przekazywany przez potok.

Typ:PSSynapseWorkspace
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ManagedVirtualNetwork

Ustawienia zarządzanej sieci wirtualnej.

Typ:PSManagedVirtualNetworkSettings
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Name

Nazwa obszaru roboczego usługi Synapse.

Typ:String
Aliasy:WorkspaceName
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-ResourceGroupName

Nazwa grupy zasobów.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-ResourceId

Identyfikator zasobu obszaru roboczego usługi Synapse.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-SqlAdministratorLoginPassword

Nowe hasło administratora SQL dla obszaru roboczego.

Typ:SecureString
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Tag

Ciąg, słownik ciągów tagów skojarzonych z zasobem.

Typ:Hashtable
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-UserAssignedIdentityAction

Akcja musi być określona podczas dodawania/usuwania/ustawiania tożsamości zarządzanych przypisanych przez użytkownika dla obszaru roboczego. Obsługiwane akcje to: Dodaj opcję Usuń ustaw dodaj środki, aby dodać tożsamości zarządzane przypisane przez użytkownika dla obszaru roboczego, usuń środki usuwania tożsamości zarządzanych przypisanych przez użytkownika z obszaru roboczego. Ustawienie można użyć, gdy chcesz dodać i usunąć tożsamości zarządzane przypisane przez użytkownika w tym samym czasie.

Typ:Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Dopuszczalne wartości:Add, Remove, Set
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-UserAssignedIdentityId

Identyfikator tożsamości zarządzanej przypisanej przez użytkownika dla obszaru roboczego.

Typ:List<T>[String]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-UserAssignedIdentityInEncryption

Identyfikator zasobu tożsamości przypisanej przez użytkownika używany w szyfrowaniu obszaru roboczego

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-UseSystemAssignedIdentityInEncryption

określanie, czy należy używać tożsamości przypisanej przez system w funkcji szyfrowania obszaru roboczego, czy też nie

Typ:Object
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

PSSynapseWorkspace

Dane wyjściowe

PSSynapseWorkspace