Delen via


Update-AzSynapseWorkspace

Hiermee werkt u een Synapse Analytics-werkruimte bij.

Syntaxis

SetByNameParameterSet (Standaard)

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

SetByInputObjectParameterSet

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

Description

De cmdlet Update-AzSynapseWorkspace werkt een Azure Synapse Analytics-werkruimte bij.

Voorbeelden

Voorbeeld 1

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

Met deze opdracht worden tags bijgewerkt voor de opgegeven Azure Synapse Analytics-werkruimte.

Voorbeeld 2

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

Met deze opdrachten worden tags bijgewerkt voor de opgegeven Azure Synapse Analytics-werkruimte via een pijplijn.

Voorbeeld 3

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

Met deze opdrachten worden tags bijgewerkt voor de opgegeven Azure Synapse Analytics-werkruimte via pijplijn met resource-id.

Voorbeeld 4

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

Met deze opdrachten wordt de Git-opslagplaats bijgewerkt waarmee de werkruimte is verbonden voor de opgegeven Azure Synapse Analytics-werkruimte.

Voorbeeld 5

Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True

Met deze opdrachten wordt de opgegeven Azure Synapse Analytics-werkruimte bijgewerkt om openbare netwerktoegang in te schakelen.

Voorbeeld 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

Met deze opdrachten wordt de werkruimte bijgewerkt om door de gebruiker toegewezen beheerde identiteiten toe te voegen in $uamilist.

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

Met deze opdrachten verwijdert u door de gebruiker toegewezen beheerde identiteiten $uamilist[0] uit de werkruimte.

Voorbeeld 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

Met deze opdrachten wordt de werkruimte bijgewerkt met door de gebruiker toegewezen beheerde identiteiten $uamilist die betrekking hebben op huidige identiteiten.

Voorbeeld 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

Met deze opdrachten wordt gedemonstreerd hoe u de versleutelingssleutel van een Synapse-werkruimte roteert en deze gebruikmaakt van door het systeem toegewezen beheerde identiteit voor toegang tot de Azure Key Vault.

Voorbeeld 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

Met deze opdrachten wordt de door de gebruiker toegewezen beheerde identiteit voor werkruimteversleuteling bijgewerkt en wordt een door de gebruiker toegewezen id opgegeven voor toegang tot de door de klant beheerde sleutel die is opgeslagen in de sleutelkluis. Na het bijwerken kunnen we aanroepen Get-AzSynapseWorkspace om versleutelingseigenschappen van de werkruimte op te halen.

Parameters

-AsJob

Cmdlet op de achtergrond uitvoeren

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-DefaultProfile

De referenties, accounts, tenants en abonnementen die worden gebruikt voor communicatie met Azure.

Parametereigenschappen

Type:IAzureContextContainer
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:AzContext, AzureRmContext, AzureCredential

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-EnablePublicNetworkAccess

Openbare netwerktoegang tot werkruimte in- of uitschakelen. Mogelijke waarden zijn: 'Ingeschakeld', 'Uitgeschakeld'

Parametereigenschappen

Type:Boolean
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-EncryptionKeyName

De naam van de versleutelingssleutel voor de werkruimte.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-GitRepository

Instellingen voor Git-opslagplaats. Werkruimte verbinden met de opslagplaats voor broncodebeheer en samenwerking voor werk aan uw werkruimtepijplijnen

Parametereigenschappen

Type:PSWorkspaceRepositoryConfiguration
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-InputObject

werkruimte-invoerobject, meestal doorgegeven via de pijplijn.

Parametereigenschappen

Type:PSSynapseWorkspace
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

SetByInputObjectParameterSet
Position:Named
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ManagedVirtualNetwork

Instellingen voor beheerd virtueel netwerk.

Parametereigenschappen

Type:PSManagedVirtualNetworkSettings
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Name

Naam van Synapse-werkruimte.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:WerkruimteNaam

Parametersets

SetByNameParameterSet
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ResourceGroupName

Naam van de resourcegroep.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

SetByNameParameterSet
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ResourceId

Resource-id van Synapse-werkruimte.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

SetByResourceIdParameterSet
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-SqlAdministratorLoginPassword

Het nieuwe SQL-beheerderswachtwoord voor de werkruimte.

Parametereigenschappen

Type:SecureString
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Tag

Een tekenreeks, tekenreekswoordenlijst met tags die zijn gekoppeld aan de resource.

Parametereigenschappen

Type:Hashtable
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-UserAssignedIdentityAction

Actie moet worden opgegeven wanneer u door de gebruiker toegewezen beheerde identiteiten toevoegt/verwijdert/instelt voor de werkruimte. De ondersteunde acties zijn: Add Remove Set Add means to add user assigned managed identities for workspace, Remove means to remove user assigned managed identities from workspace, Set can be used when you want to add and remove user assigned managed identities at same time.

Parametereigenschappen

Type:Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+UserAssignedManagedIdentityActionType
Default value:None
Geaccepteerde waarden:Add, Remove, Set
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-UserAssignedIdentityId

Door de gebruiker toegewezen beheerde identiteit-id voor werkruimte.

Parametereigenschappen

Type:

List<T>[String]

Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-UserAssignedIdentityInEncryption

Door de gebruiker toegewezen id-resource-id die wordt gebruikt in werkruimteversleuteling

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-UseSystemAssignedIdentityInEncryption

opgeven of de door het systeem toegewezen identiteit moet worden gebruikt in Werkruimteversleuteling of niet

Parametereigenschappen

Type:Object
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-WhatIf

Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

PSSynapseWorkspace

Uitvoerwaarden

PSSynapseWorkspace