New-AzSynapseWorkspace
Tworzy obszar roboczy usługi Synapse Analytics.
Składnia
New-AzSynapseWorkspace
-ResourceGroupName <String>
-Name <String>
-Location <String>
[-Tag <Hashtable>]
-DefaultDataLakeStorageAccountName <String>
-DefaultDataLakeStorageFilesystem <String>
-SqlAdministratorLoginCredential <PSCredential>
[-ManagedVirtualNetwork <PSManagedVirtualNetworkSettings>]
[-EncryptionKeyName <String>]
[-EncryptionKeyIdentifier <String>]
[-UserAssignedIdentityInEncryption <String>]
[-UseSystemAssignedIdentityInEncryption <Object>]
[-AsJob]
[-ManagedResourceGroupName <String>]
[-GitRepository <PSWorkspaceRepositoryConfiguration>]
[-EnablePublicNetworkAccess <Boolean>]
[-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Opis
Polecenie cmdlet New-AzSynapseWorkspace tworzy obszar roboczy usługi Azure Synapse Analytics.
Przykłady
Przykład 1
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password)
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds
To polecenie tworzy obszar roboczy usługi Synapse Analytics o nazwie ContosoWorkspace, który używa magazynu danych ContosoAdlGenStorage w grupie zasobów o nazwie ContosoResourceGroup.
Przykład 2
$config = New-AzSynapseManagedVirtualNetworkConfig -PreventDataExfiltration -AllowedAadTenantIdsForLinking ContosoTenantId
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password)
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -ManagedVirtualNetwork $config
Pierwsze polecenie tworzy konfigurację zarządzanej sieci wirtualnej. Następnie pozostałe metody używają konfiguracji do utworzenia nowego obszaru roboczego usługi Synapse.
Przykład 3
$config = New-AzSynapseManagedVirtualNetworkConfig -PreventDataExfiltration -AllowedAadTenantIdsForLinking ContosoTenantId
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password)
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -ManagedVirtualNetwork $config -EnablePublicNetworkAccess $True
Pierwsze polecenie tworzy konfigurację zarządzanej sieci wirtualnej. Następnie pozostałe metody używają konfiguracji do tworzenia nowego obszaru roboczego usługi Synapse z włączoną zarządzaną siecią wirtualną i włączonym dostępem do sieci publicznej.
Przykład 4
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password)
$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -GitRepository $config
To polecenie tworzy obszar roboczy usługi Synapse Analytics o nazwie ContosoWorkspace, który używa magazynu danych ContosoAdlGenStorage w grupie zasobów o nazwie ContosoResourceGroup. Obszar roboczy jest połączony z repozytorium Git o nazwie ContosoRepo.
Przykład 5
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ("ContosoUser", $password)
$uamis = Get-AzUserAssignedIdentity -ResourceGroupName ContosoResourceGroup
$uamilist = New-Object System.Collections.Generic.List[string]
foreach($uami in $uamis){
$uamilist.Add($uami.Id)
}
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -UserAssignedIdentityId $uamilist
To polecenie tworzy obszar roboczy usługi Synapse Analytics o nazwie ContosoWorkspace, który używa magazynu danych ContosoAdlGenStorage w grupie zasobów o nazwie ContosoResourceGroup i dodaj tożsamości zarządzane przypisane przez użytkownika, które są uzyskiwane z grupy zasobów ContosoResourceGroup do obszaru roboczego.
Przykład 6
New-AzSynapseWorkspace -ResourceGroupName ContosoResourceGroup -Name ContosoWorkspace -Location northeurope -DefaultDataLakeStorageAccountName ContosoAdlGen2Storage -DefaultDataLakeStorageFilesystem ContosoFileSystem -SqlAdministratorLoginCredential $creds -EncryptionKeyIdentifier $identifier -UseSystemAssignedIdentityInEncryption $true
$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
-------------------- -------------------------
True
To polecenie tworzy obszar roboczy usługi Synapse Analytics o nazwie ContosoWorkspace, który używa magazynu danych ContosoAdlGenStorage w grupie zasobów o nazwie ContosoResourceGroup i włącz podwójne szyfrowanie za pomocą klucza zarządzanego przez klienta z określonym identyfikatorem klucza i ustaw tożsamość zarządzaną jako przypisaną przez system. Po utworzeniu można wywołać Get-AzSynapseWorkspace
, aby uzyskać 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 |
-DefaultDataLakeStorageAccountName
Domyślna nazwa konta magazynu usługi ADLS Gen2.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-DefaultDataLakeStorageFilesystem
Domyślny system plików usługi ADLS Gen2.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
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 |
-EncryptionKeyIdentifier
Identyfikator klucza powinien być w formacie: https://{keyvaultname}.vault.azure.net/keys/{keyname}.
Typ: | String |
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 |
-Location
Region świadczenia usługi Azure, w którym należy utworzyć zasób.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-ManagedResourceGroupName
Kontener, który przechowuje zasoby pomocnicze. Utworzono domyślnie, gdy można określić nazwę. Należy pamiętać, że to pole nie może być takie samo jak w przypadku właściwości ResourceGroupName
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-ManagedVirtualNetwork
Nazwa sieci wirtualnej zarządzanej przez usługę Synapse dedykowanej dla obszaru roboczego usługi Azure Synapse.
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: | True |
Akceptowanie symboli wieloznacznych: | False |
-ResourceGroupName
Nazwa grupy zasobów.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-SqlAdministratorLoginCredential
Poświadczenia administratora SQL.
Typ: | PSCredential |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
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: | True |
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, jeśli polecenie cmdlet zostanie uruchomione. Polecenie cmdlet nie jest uruchamiane.
Typ: | SwitchParameter |
Aliasy: | wi |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |