diff --git a/src/Synapse/Synapse.Autorest/help/Add-AzSynapseKustoPoolLanguageExtension.md b/src/Synapse/Synapse.Autorest/docs/Add-AzSynapseKustoPoolLanguageExtension.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Add-AzSynapseKustoPoolLanguageExtension.md rename to src/Synapse/Synapse.Autorest/docs/Add-AzSynapseKustoPoolLanguageExtension.md diff --git a/src/Synapse/Synapse.Autorest/docs/Az.Synapse.md b/src/Synapse/Synapse.Autorest/docs/Az.Synapse.md index 1f2f36961001..6b25b62aad10 100644 --- a/src/Synapse/Synapse.Autorest/docs/Az.Synapse.md +++ b/src/Synapse/Synapse.Autorest/docs/Az.Synapse.md @@ -11,15 +11,90 @@ Locale: en-US Microsoft Azure PowerShell: Synapse cmdlets ## Az.Synapse Cmdlets +### [Add-AzSynapseKustoPoolLanguageExtension](Add-AzSynapseKustoPoolLanguageExtension.md) +Add a list of language extensions that can run within KQL queries. + ### [Get-AzSynapseKustoPool](Get-AzSynapseKustoPool.md) Gets a Kusto pool. +### [Get-AzSynapseKustoPoolAttachedDatabaseConfiguration](Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) +Returns an attached database configuration. + +### [Get-AzSynapseKustoPoolDatabase](Get-AzSynapseKustoPoolDatabase.md) +Returns a database. + +### [Get-AzSynapseKustoPoolDatabasePrincipalAssignment](Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md) +Gets a Kusto pool database principalAssignment. + +### [Get-AzSynapseKustoPoolDataConnection](Get-AzSynapseKustoPoolDataConnection.md) +Returns a data connection. + +### [Get-AzSynapseKustoPoolFollowerDatabase](Get-AzSynapseKustoPoolFollowerDatabase.md) +Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool. + +### [Get-AzSynapseKustoPoolLanguageExtension](Get-AzSynapseKustoPoolLanguageExtension.md) +Returns a list of language extensions that can run within KQL queries. + +### [Get-AzSynapseKustoPoolPrincipalAssignment](Get-AzSynapseKustoPoolPrincipalAssignment.md) +Gets a Kusto pool principalAssignment. + +### [Get-AzSynapseKustoPoolSku](Get-AzSynapseKustoPoolSku.md) +Lists eligible SKUs for Kusto Pool resource. + +### [Invoke-AzSynapseDetachKustoPoolFollowerDatabase](Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md) +Detaches all followers of a database owned by this Kusto Pool. + ### [New-AzSynapseKustoPool](New-AzSynapseKustoPool.md) Create or update a Kusto pool. +### [New-AzSynapseKustoPoolAttachedDatabaseConfiguration](New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) +Creates or updates an attached database configuration. + +### [New-AzSynapseKustoPoolDatabase](New-AzSynapseKustoPoolDatabase.md) +Creates or updates a database. + +### [New-AzSynapseKustoPoolDatabasePrincipalAssignment](New-AzSynapseKustoPoolDatabasePrincipalAssignment.md) +Creates a Kusto pool database principalAssignment. + +### [New-AzSynapseKustoPoolDataConnection](New-AzSynapseKustoPoolDataConnection.md) +Creates or updates a data connection. + +### [New-AzSynapseKustoPoolPrincipalAssignment](New-AzSynapseKustoPoolPrincipalAssignment.md) +Create a Kusto pool principalAssignment. + ### [Remove-AzSynapseKustoPool](Remove-AzSynapseKustoPool.md) Deletes a Kusto pool. +### [Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration](Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) +Deletes the attached database configuration with the given name. + +### [Remove-AzSynapseKustoPoolDatabase](Remove-AzSynapseKustoPoolDatabase.md) +Deletes the database with the given name. + +### [Remove-AzSynapseKustoPoolDatabasePrincipalAssignment](Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md) +Deletes a Kusto pool principalAssignment. + +### [Remove-AzSynapseKustoPoolDataConnection](Remove-AzSynapseKustoPoolDataConnection.md) +Deletes the data connection with the given name. + +### [Remove-AzSynapseKustoPoolLanguageExtension](Remove-AzSynapseKustoPoolLanguageExtension.md) +Remove a list of language extensions that can run within KQL queries. + +### [Remove-AzSynapseKustoPoolPrincipalAssignment](Remove-AzSynapseKustoPoolPrincipalAssignment.md) +Deletes a Kusto pool principalAssignment. + +### [Start-AzSynapseKustoPool](Start-AzSynapseKustoPool.md) +Starts a Kusto pool. + +### [Stop-AzSynapseKustoPool](Stop-AzSynapseKustoPool.md) +Stops a Kusto pool. + ### [Update-AzSynapseKustoPool](Update-AzSynapseKustoPool.md) Update a Kusto Kusto Pool. +### [Update-AzSynapseKustoPoolDatabase](Update-AzSynapseKustoPoolDatabase.md) +Updates a database. + +### [Update-AzSynapseKustoPoolDataConnection](Update-AzSynapseKustoPoolDataConnection.md) +Updates a data connection. + diff --git a/src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md b/src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md rename to src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md diff --git a/src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolDataConnection.md b/src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolDataConnection.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolDataConnection.md rename to src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolDataConnection.md diff --git a/src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolDatabase.md b/src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolDatabase.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolDatabase.md rename to src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolDatabase.md diff --git a/src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md b/src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md rename to src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md diff --git a/src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolFollowerDatabase.md b/src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolFollowerDatabase.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolFollowerDatabase.md rename to src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolFollowerDatabase.md diff --git a/src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolLanguageExtension.md b/src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolLanguageExtension.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolLanguageExtension.md rename to src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolLanguageExtension.md diff --git a/src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolPrincipalAssignment.md b/src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolPrincipalAssignment.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolPrincipalAssignment.md rename to src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolPrincipalAssignment.md diff --git a/src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolSku.md b/src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolSku.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPoolSku.md rename to src/Synapse/Synapse.Autorest/docs/Get-AzSynapseKustoPoolSku.md diff --git a/src/Synapse/Synapse.Autorest/help/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md b/src/Synapse/Synapse.Autorest/docs/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md rename to src/Synapse/Synapse.Autorest/docs/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md diff --git a/src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md b/src/Synapse/Synapse.Autorest/docs/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md rename to src/Synapse/Synapse.Autorest/docs/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md diff --git a/src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPoolDataConnection.md b/src/Synapse/Synapse.Autorest/docs/New-AzSynapseKustoPoolDataConnection.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPoolDataConnection.md rename to src/Synapse/Synapse.Autorest/docs/New-AzSynapseKustoPoolDataConnection.md diff --git a/src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPoolDatabase.md b/src/Synapse/Synapse.Autorest/docs/New-AzSynapseKustoPoolDatabase.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPoolDatabase.md rename to src/Synapse/Synapse.Autorest/docs/New-AzSynapseKustoPoolDatabase.md diff --git a/src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md b/src/Synapse/Synapse.Autorest/docs/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md rename to src/Synapse/Synapse.Autorest/docs/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md diff --git a/src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPoolPrincipalAssignment.md b/src/Synapse/Synapse.Autorest/docs/New-AzSynapseKustoPoolPrincipalAssignment.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPoolPrincipalAssignment.md rename to src/Synapse/Synapse.Autorest/docs/New-AzSynapseKustoPoolPrincipalAssignment.md diff --git a/src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md b/src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md rename to src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md diff --git a/src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolDataConnection.md b/src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolDataConnection.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolDataConnection.md rename to src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolDataConnection.md diff --git a/src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolDatabase.md b/src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolDatabase.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolDatabase.md rename to src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolDatabase.md diff --git a/src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md b/src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md rename to src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md diff --git a/src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolLanguageExtension.md b/src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolLanguageExtension.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolLanguageExtension.md rename to src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolLanguageExtension.md diff --git a/src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolPrincipalAssignment.md b/src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolPrincipalAssignment.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPoolPrincipalAssignment.md rename to src/Synapse/Synapse.Autorest/docs/Remove-AzSynapseKustoPoolPrincipalAssignment.md diff --git a/src/Synapse/Synapse.Autorest/help/Start-AzSynapseKustoPool.md b/src/Synapse/Synapse.Autorest/docs/Start-AzSynapseKustoPool.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Start-AzSynapseKustoPool.md rename to src/Synapse/Synapse.Autorest/docs/Start-AzSynapseKustoPool.md diff --git a/src/Synapse/Synapse.Autorest/help/Stop-AzSynapseKustoPool.md b/src/Synapse/Synapse.Autorest/docs/Stop-AzSynapseKustoPool.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Stop-AzSynapseKustoPool.md rename to src/Synapse/Synapse.Autorest/docs/Stop-AzSynapseKustoPool.md diff --git a/src/Synapse/Synapse.Autorest/help/Update-AzSynapseKustoPoolDataConnection.md b/src/Synapse/Synapse.Autorest/docs/Update-AzSynapseKustoPoolDataConnection.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Update-AzSynapseKustoPoolDataConnection.md rename to src/Synapse/Synapse.Autorest/docs/Update-AzSynapseKustoPoolDataConnection.md diff --git a/src/Synapse/Synapse.Autorest/help/Update-AzSynapseKustoPoolDatabase.md b/src/Synapse/Synapse.Autorest/docs/Update-AzSynapseKustoPoolDatabase.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Update-AzSynapseKustoPoolDatabase.md rename to src/Synapse/Synapse.Autorest/docs/Update-AzSynapseKustoPoolDatabase.md diff --git a/src/Synapse/Synapse.Autorest/help/Az.Synapse.md b/src/Synapse/Synapse.Autorest/help/Az.Synapse.md deleted file mode 100644 index 6b25b62aad10..000000000000 --- a/src/Synapse/Synapse.Autorest/help/Az.Synapse.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -Module Name: Az.Synapse -Module Guid: aa8fbb4e-739a-4b60-b500-11592e31aa54 -Download Help Link: https://docs.microsoft.com/powershell/module/az.synapse -Help Version: 1.0.0.0 -Locale: en-US ---- - -# Az.Synapse Module -## Description -Microsoft Azure PowerShell: Synapse cmdlets - -## Az.Synapse Cmdlets -### [Add-AzSynapseKustoPoolLanguageExtension](Add-AzSynapseKustoPoolLanguageExtension.md) -Add a list of language extensions that can run within KQL queries. - -### [Get-AzSynapseKustoPool](Get-AzSynapseKustoPool.md) -Gets a Kusto pool. - -### [Get-AzSynapseKustoPoolAttachedDatabaseConfiguration](Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) -Returns an attached database configuration. - -### [Get-AzSynapseKustoPoolDatabase](Get-AzSynapseKustoPoolDatabase.md) -Returns a database. - -### [Get-AzSynapseKustoPoolDatabasePrincipalAssignment](Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md) -Gets a Kusto pool database principalAssignment. - -### [Get-AzSynapseKustoPoolDataConnection](Get-AzSynapseKustoPoolDataConnection.md) -Returns a data connection. - -### [Get-AzSynapseKustoPoolFollowerDatabase](Get-AzSynapseKustoPoolFollowerDatabase.md) -Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool. - -### [Get-AzSynapseKustoPoolLanguageExtension](Get-AzSynapseKustoPoolLanguageExtension.md) -Returns a list of language extensions that can run within KQL queries. - -### [Get-AzSynapseKustoPoolPrincipalAssignment](Get-AzSynapseKustoPoolPrincipalAssignment.md) -Gets a Kusto pool principalAssignment. - -### [Get-AzSynapseKustoPoolSku](Get-AzSynapseKustoPoolSku.md) -Lists eligible SKUs for Kusto Pool resource. - -### [Invoke-AzSynapseDetachKustoPoolFollowerDatabase](Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md) -Detaches all followers of a database owned by this Kusto Pool. - -### [New-AzSynapseKustoPool](New-AzSynapseKustoPool.md) -Create or update a Kusto pool. - -### [New-AzSynapseKustoPoolAttachedDatabaseConfiguration](New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) -Creates or updates an attached database configuration. - -### [New-AzSynapseKustoPoolDatabase](New-AzSynapseKustoPoolDatabase.md) -Creates or updates a database. - -### [New-AzSynapseKustoPoolDatabasePrincipalAssignment](New-AzSynapseKustoPoolDatabasePrincipalAssignment.md) -Creates a Kusto pool database principalAssignment. - -### [New-AzSynapseKustoPoolDataConnection](New-AzSynapseKustoPoolDataConnection.md) -Creates or updates a data connection. - -### [New-AzSynapseKustoPoolPrincipalAssignment](New-AzSynapseKustoPoolPrincipalAssignment.md) -Create a Kusto pool principalAssignment. - -### [Remove-AzSynapseKustoPool](Remove-AzSynapseKustoPool.md) -Deletes a Kusto pool. - -### [Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration](Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) -Deletes the attached database configuration with the given name. - -### [Remove-AzSynapseKustoPoolDatabase](Remove-AzSynapseKustoPoolDatabase.md) -Deletes the database with the given name. - -### [Remove-AzSynapseKustoPoolDatabasePrincipalAssignment](Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md) -Deletes a Kusto pool principalAssignment. - -### [Remove-AzSynapseKustoPoolDataConnection](Remove-AzSynapseKustoPoolDataConnection.md) -Deletes the data connection with the given name. - -### [Remove-AzSynapseKustoPoolLanguageExtension](Remove-AzSynapseKustoPoolLanguageExtension.md) -Remove a list of language extensions that can run within KQL queries. - -### [Remove-AzSynapseKustoPoolPrincipalAssignment](Remove-AzSynapseKustoPoolPrincipalAssignment.md) -Deletes a Kusto pool principalAssignment. - -### [Start-AzSynapseKustoPool](Start-AzSynapseKustoPool.md) -Starts a Kusto pool. - -### [Stop-AzSynapseKustoPool](Stop-AzSynapseKustoPool.md) -Stops a Kusto pool. - -### [Update-AzSynapseKustoPool](Update-AzSynapseKustoPool.md) -Update a Kusto Kusto Pool. - -### [Update-AzSynapseKustoPoolDatabase](Update-AzSynapseKustoPoolDatabase.md) -Updates a database. - -### [Update-AzSynapseKustoPoolDataConnection](Update-AzSynapseKustoPoolDataConnection.md) -Updates a data connection. - diff --git a/src/Synapse/Synapse/Az.Synapse.psd1 b/src/Synapse/Synapse/Az.Synapse.psd1 index 1c521d196130..f4941e44d10e 100644 --- a/src/Synapse/Synapse/Az.Synapse.psd1 +++ b/src/Synapse/Synapse/Az.Synapse.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 10/4/2021 +# Generated on: 10/27/2021 # @{ @@ -61,7 +61,8 @@ RequiredAssemblies = 'Microsoft.Azure.Management.Synapse.dll', 'Azure.Analytics.Synapse.AccessControl.dll', 'Azure.Analytics.Synapse.Artifacts.dll', 'Azure.Analytics.Synapse.ManagedPrivateEndpoints.dll', - 'Microsoft.DataTransfer.Gateway.Encryption.dll' + 'Microsoft.DataTransfer.Gateway.Encryption.dll', + 'Synapse.Autorest\bin\Az.Synapse.private.dll' # Script files (.ps1) that are run in the caller's environment prior to importing this module. # ScriptsToProcess = @() @@ -70,13 +71,38 @@ RequiredAssemblies = 'Microsoft.Azure.Management.Synapse.dll', # TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module -FormatsToProcess = 'Synapse.format.ps1xml' +FormatsToProcess = 'Synapse.format.ps1xml', 'Synapse.Autorest\Az.Synapse.format.ps1xml' # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess -NestedModules = @('Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll') +NestedModules = @('Az.Synapse.psm1','Synapse.Autorest\Az.Synapse.psm1') # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. -FunctionsToExport = @() +FunctionsToExport = 'Add-AzSynapseKustoPoolLanguageExtension', 'Get-AzSynapseKustoPool', + 'Get-AzSynapseKustoPoolAttachedDatabaseConfiguration', + 'Get-AzSynapseKustoPoolDatabase', + 'Get-AzSynapseKustoPoolDatabasePrincipalAssignment', + 'Get-AzSynapseKustoPoolDataConnection', + 'Get-AzSynapseKustoPoolFollowerDatabase', + 'Get-AzSynapseKustoPoolLanguageExtension', + 'Get-AzSynapseKustoPoolPrincipalAssignment', + 'Get-AzSynapseKustoPoolSku', + 'Invoke-AzSynapseDetachKustoPoolFollowerDatabase', + 'New-AzSynapseKustoPool', + 'New-AzSynapseKustoPoolAttachedDatabaseConfiguration', + 'New-AzSynapseKustoPoolDatabase', + 'New-AzSynapseKustoPoolDatabasePrincipalAssignment', + 'New-AzSynapseKustoPoolDataConnection', + 'New-AzSynapseKustoPoolPrincipalAssignment', + 'Remove-AzSynapseKustoPool', + 'Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration', + 'Remove-AzSynapseKustoPoolDatabase', + 'Remove-AzSynapseKustoPoolDatabasePrincipalAssignment', + 'Remove-AzSynapseKustoPoolDataConnection', + 'Remove-AzSynapseKustoPoolLanguageExtension', + 'Remove-AzSynapseKustoPoolPrincipalAssignment', + 'Start-AzSynapseKustoPool', 'Stop-AzSynapseKustoPool', + 'Update-AzSynapseKustoPool', 'Update-AzSynapseKustoPoolDatabase', + 'Update-AzSynapseKustoPoolDataConnection' # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = 'Get-AzSynapseSparkJob', 'Stop-AzSynapseSparkJob', @@ -185,18 +211,15 @@ CmdletsToExport = 'Get-AzSynapseSparkJob', 'Stop-AzSynapseSparkJob', 'Start-AzSynapseIntegrationRuntime', 'Stop-AzSynapseIntegrationRuntime', 'Invoke-AzSynapseTriggerRun', 'Stop-AzSynapseTriggerRun', - 'New-AzSynapseLinkedServiceEncryptedCredential', - 'Get-AzSynapseDataFlowDebugSession', - 'Add-AzSynapseDataFlowDebugSessionPackage', - 'Invoke-AzSynapseDataFlowDebugSessionCommand', - 'Stop-AzSynapseDataFlowDebugSession', - 'Start-AzSynapseDataFlowDebugSession', - 'Get-AzSynapseSqlScript', - 'Remove-AzSynapseSqlScript', - 'Export-AzSynapseSqlScript', + 'New-AzSynapseLinkedServiceEncryptedCredential', + 'Get-AzSynapseDataFlowDebugSession', + 'Add-AzSynapseDataFlowDebugSessionPackage', + 'Invoke-AzSynapseDataFlowDebugSessionCommand', + 'Stop-AzSynapseDataFlowDebugSession', + 'Start-AzSynapseDataFlowDebugSession', 'Get-AzSynapseSqlScript', + 'Remove-AzSynapseSqlScript', 'Export-AzSynapseSqlScript', 'Set-AzSynapseSqlScript' - # Variables to export from this module # VariablesToExport = @() @@ -214,9 +237,9 @@ AliasesToExport = 'New-AzSynapsePipeline', 'New-AzSynapseLinkedService', 'Clear-AzSynapseSqlPoolVulnerabilityAssessmentSetting', 'Enable-AzSynapseSqlAdvancedThreatProtection', 'Disable-AzSynapseSqlAdvancedThreatProtection', - 'New-AzSynapseSparkJobDefinition', - 'Set-AzSynapseManagedPrivateEndpoint', - 'New-AzSynapseSqlScript','Import-AzSynapseSqlScript' + 'New-AzSynapseSparkJobDefinition', + 'Set-AzSynapseManagedPrivateEndpoint', 'New-AzSynapseSqlScript', + 'Import-AzSynapseSqlScript' # DSC resources to export from this module # DscResourcesToExport = @() diff --git a/src/Synapse/Synapse/Synapse.csproj b/src/Synapse/Synapse/Synapse.csproj index b952684a2aac..1edcb5f766e5 100644 --- a/src/Synapse/Synapse/Synapse.csproj +++ b/src/Synapse/Synapse/Synapse.csproj @@ -5,6 +5,7 @@ + $(LegacyAssemblyPrefix)$(PsModuleName) diff --git a/src/Synapse/Synapse/help/Add-AzSynapseKustoPoolLanguageExtension.md b/src/Synapse/Synapse/help/Add-AzSynapseKustoPoolLanguageExtension.md new file mode 100644 index 000000000000..fc66f47ace0d --- /dev/null +++ b/src/Synapse/Synapse/help/Add-AzSynapseKustoPoolLanguageExtension.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/add-azsynapsekustopoollanguageextension +schema: 2.0.0 +--- + +# Add-AzSynapseKustoPoolLanguageExtension + +## SYNOPSIS +Add a list of language extensions that can run within KQL queries. + +## SYNTAX + +### AddExpanded (Default) +``` +Add-AzSynapseKustoPoolLanguageExtension -KustoPoolName -ResourceGroupName + -WorkspaceName [-SubscriptionId ] [-Value ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### AddViaIdentityExpanded +``` +Add-AzSynapseKustoPoolLanguageExtension -InputObject [-Value ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Add a list of language extensions that can run within KQL queries. + +## EXAMPLES + +### Example 1: Add a list of language extensions +```powershell +PS C:\> Add-AzSynapseKustoPoolLanguageExtension -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -Value (@{Name="R"}, @{Name="PYTHON"}) +``` + +The above command adds a list of language extensions that can run within KQL queries + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: AddViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The list of language extensions. +To construct, see NOTES section for VALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.ILanguageExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: AddExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +VALUE : The list of language extensions. + - `[Name ]`: The language extension name. + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Az.Synapse.md b/src/Synapse/Synapse/help/Az.Synapse.md index 54a9581ca527..4ab0a815b20c 100644 --- a/src/Synapse/Synapse/help/Az.Synapse.md +++ b/src/Synapse/Synapse/help/Az.Synapse.md @@ -488,3 +488,89 @@ Updates a Synapse Analytics workspace. ### [Wait-AzSynapseSparkJob](Wait-AzSynapseSparkJob.md) Waits for a Synapse Analytics Spark job to complete. +### [Add-AzSynapseKustoPoolLanguageExtension](Add-AzSynapseKustoPoolLanguageExtension.md) +Add a list of language extensions that can run within KQL queries. + +### [Get-AzSynapseKustoPool](Get-AzSynapseKustoPool.md) +Gets a Kusto pool. + +### [Get-AzSynapseKustoPoolAttachedDatabaseConfiguration](Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) +Returns an attached database configuration. + +### [Get-AzSynapseKustoPoolDatabase](Get-AzSynapseKustoPoolDatabase.md) +Returns a database. + +### [Get-AzSynapseKustoPoolDatabasePrincipalAssignment](Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md) +Gets a Kusto pool database principalAssignment. + +### [Get-AzSynapseKustoPoolDataConnection](Get-AzSynapseKustoPoolDataConnection.md) +Returns a data connection. + +### [Get-AzSynapseKustoPoolFollowerDatabase](Get-AzSynapseKustoPoolFollowerDatabase.md) +Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool. + +### [Get-AzSynapseKustoPoolLanguageExtension](Get-AzSynapseKustoPoolLanguageExtension.md) +Returns a list of language extensions that can run within KQL queries. + +### [Get-AzSynapseKustoPoolPrincipalAssignment](Get-AzSynapseKustoPoolPrincipalAssignment.md) +Gets a Kusto pool principalAssignment. + +### [Get-AzSynapseKustoPoolSku](Get-AzSynapseKustoPoolSku.md) +Lists eligible SKUs for Kusto Pool resource. + +### [Invoke-AzSynapseDetachKustoPoolFollowerDatabase](Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md) +Detaches all followers of a database owned by this Kusto Pool. + +### [New-AzSynapseKustoPool](New-AzSynapseKustoPool.md) +Create or update a Kusto pool. + +### [New-AzSynapseKustoPoolAttachedDatabaseConfiguration](New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) +Creates or updates an attached database configuration. + +### [New-AzSynapseKustoPoolDatabase](New-AzSynapseKustoPoolDatabase.md) +Creates or updates a database. + +### [New-AzSynapseKustoPoolDatabasePrincipalAssignment](New-AzSynapseKustoPoolDatabasePrincipalAssignment.md) +Creates a Kusto pool database principalAssignment. + +### [New-AzSynapseKustoPoolDataConnection](New-AzSynapseKustoPoolDataConnection.md) +Creates or updates a data connection. + +### [New-AzSynapseKustoPoolPrincipalAssignment](New-AzSynapseKustoPoolPrincipalAssignment.md) +Create a Kusto pool principalAssignment. + +### [Remove-AzSynapseKustoPool](Remove-AzSynapseKustoPool.md) +Deletes a Kusto pool. + +### [Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration](Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md) +Deletes the attached database configuration with the given name. + +### [Remove-AzSynapseKustoPoolDatabase](Remove-AzSynapseKustoPoolDatabase.md) +Deletes the database with the given name. + +### [Remove-AzSynapseKustoPoolDatabasePrincipalAssignment](Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md) +Deletes a Kusto pool principalAssignment. + +### [Remove-AzSynapseKustoPoolDataConnection](Remove-AzSynapseKustoPoolDataConnection.md) +Deletes the data connection with the given name. + +### [Remove-AzSynapseKustoPoolLanguageExtension](Remove-AzSynapseKustoPoolLanguageExtension.md) +Remove a list of language extensions that can run within KQL queries. + +### [Remove-AzSynapseKustoPoolPrincipalAssignment](Remove-AzSynapseKustoPoolPrincipalAssignment.md) +Deletes a Kusto pool principalAssignment. + +### [Start-AzSynapseKustoPool](Start-AzSynapseKustoPool.md) +Starts a Kusto pool. + +### [Stop-AzSynapseKustoPool](Stop-AzSynapseKustoPool.md) +Stops a Kusto pool. + +### [Update-AzSynapseKustoPool](Update-AzSynapseKustoPool.md) +Update a Kusto Kusto Pool. + +### [Update-AzSynapseKustoPoolDatabase](Update-AzSynapseKustoPoolDatabase.md) +Updates a database. + +### [Update-AzSynapseKustoPoolDataConnection](Update-AzSynapseKustoPoolDataConnection.md) +Updates a data connection. \ No newline at end of file diff --git a/src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPool.md b/src/Synapse/Synapse/help/Get-AzSynapseKustoPool.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Get-AzSynapseKustoPool.md rename to src/Synapse/Synapse/help/Get-AzSynapseKustoPool.md diff --git a/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md new file mode 100644 index 000000000000..c9bccfdc6928 --- /dev/null +++ b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolAttachedDatabaseConfiguration.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopoolattacheddatabaseconfiguration +schema: 2.0.0 +--- + +# Get-AzSynapseKustoPoolAttachedDatabaseConfiguration + +## SYNOPSIS +Returns an attached database configuration. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -KustoPoolName -ResourceGroupName + -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -AttachedDatabaseConfigurationName + -KustoPoolName -ResourceGroupName -WorkspaceName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Returns an attached database configuration. + +## EXAMPLES + +### Example 1: List all the AttachedDatabaseConfigurations in a kusto pool +```powershell +PS C:\> Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testfollowerkustopool + +Name Type Location +---- ---- -------- +testws/testfollowerkustopool/followerconfiguration Microsoft.Synapse/workspaces/kustoPools/AttachedDatabaseConfigurations East US 2 +``` + +The above command lists all the AttachedDatabaseConfigurations in the kusto pool "testfollowerkustopool". + +### Example 2: Get a specific AttachedDatabaseConfiguration in a kusto pool +```powershell +PS C:\> Get-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testfollowerkustopool -Name followerconfiguration + +Name Type Location +---- ---- -------- +testws/testfollowerkustopool/followerconfiguration Microsoft.Synapse/workspaces/kustoPools/AttachedDatabaseConfigurations East US 2 +``` + +The above command returns the AttachedDatabaseConfigurations named "followerconfiguration" in the cluster "testfollowerkustopool". + +## PARAMETERS + +### -AttachedDatabaseConfigurationName +The name of the attached database configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IAttachedDatabaseConfiguration + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDataConnection.md b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDataConnection.md new file mode 100644 index 000000000000..d2087c18de38 --- /dev/null +++ b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDataConnection.md @@ -0,0 +1,219 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopooldataconnection +schema: 2.0.0 +--- + +# Get-AzSynapseKustoPoolDataConnection + +## SYNOPSIS +Returns a data connection. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolDataConnection -DatabaseName -KustoPoolName + -ResourceGroupName -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzSynapseKustoPoolDataConnection -DatabaseName -DataConnectionName + -KustoPoolName -ResourceGroupName -WorkspaceName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPoolDataConnection -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Returns a data connection. + +## EXAMPLES + +### Example 1: List all data connections in a specific database +```powershell +PS C:\> Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase + +Kind Location Name +---- -------- ---- +EventHub East US 2 testws/testkustopool/mykustodatabase/eventhubdc +``` + +The above command returns all Kusto connections in the workspace "testws" found in the resource group "testrg". + +### Example 2: Get a specific data connection by name +```powershell +PS C:\> Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase -DataConnectionName mykustodataconnection + +Kind Location Name +---- -------- ---- +EventHub East US 2 testws/testkustopool/mykustodatabase/mykustodataconnection +``` + +The above command returns the data connection named "mykustodataconnection" in database "mykustodatabase" in workspace "testws" found in the resource group "testrg". + +## PARAMETERS + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataConnectionName +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDataConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDatabase.md b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDatabase.md new file mode 100644 index 000000000000..8066584d2526 --- /dev/null +++ b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDatabase.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopooldatabase +schema: 2.0.0 +--- + +# Get-AzSynapseKustoPoolDatabase + +## SYNOPSIS +Returns a database. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolDatabase -KustoPoolName -ResourceGroupName -WorkspaceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzSynapseKustoPoolDatabase -DatabaseName -KustoPoolName -ResourceGroupName + -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPoolDatabase -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Returns a database. + +## EXAMPLES + +### Example 1: List all Kusto databases in a workspace by name +```powershell +PS C:\> Get-AzSynapseKustoPoolDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool + +Kind Location Name +---- -------- ---- +ReadWrite East US 2 testws/testnewkustopool/mykustodatabase +``` + +The above command returns all Kusto databases in Kusto Pool "testkustopool" in the workspace "testws" found in the resource group "testrg". + +### Example 2: Get a specific Kusto database by name +```powershell +PS C:\> Get-AzSynapseKustoPoolDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase + +Kind Location Name +---- -------- ---- +ReadWrite East US 2 testws/testnewkustopool/mykustodatabase +``` + +The above command returns the Kusto database named "mykustodatabase" in Kusto Pool "testkustopool" in the WorkspaceName "testws" found in the resource group "testrg". + +## PARAMETERS + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDatabase + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md new file mode 100644 index 000000000000..08c178f3bacc --- /dev/null +++ b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolDatabasePrincipalAssignment.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopooldatabaseprincipalassignment +schema: 2.0.0 +--- + +# Get-AzSynapseKustoPoolDatabasePrincipalAssignment + +## SYNOPSIS +Gets a Kusto pool database principalAssignment. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolDatabasePrincipalAssignment -DatabaseName -KustoPoolName + -ResourceGroupName -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzSynapseKustoPoolDatabasePrincipalAssignment -DatabaseName -KustoPoolName + -PrincipalAssignmentName -ResourceGroupName -WorkspaceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPoolDatabasePrincipalAssignment -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets a Kusto pool database principalAssignment. + +## EXAMPLES + +### Example 1: List all PrincipalAssignments in a kusto database by name +```powershell +PS C:\> Get-AzSynapseKustoPoolDatabasePrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase + +Name Type +---- ---- +testws/testkustopool/mykustodatabase/kustoprincipal1 Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments +testws/testkustopool/mykustodatabase/kustoprincipal2 Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments +``` + +The above command returns all PrincipalAssignments in the kusto database "mykustodatabase" in the WorkspaceName "testws" found in resource group "testrg". + +### Example 2: Get a specific PrincipalAssignment in a kusto database by name +```powershell +PS C:\> Get-AzSynapseKustoPoolDatabasePrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase -PrincipalAssignmentName kustoprincipal1 + +Name Type +---- ---- +testws/testkustopool/mykustodatabase/kustoprincipal1 Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments +``` + +The above command returns a PrincipalAssignment named "kustoprincipal1" in the kusto database "mykustodatabase" in the WorkspaceName "testws" found in resource group "testrg". + +## PARAMETERS + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDatabasePrincipalAssignment + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolFollowerDatabase.md b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolFollowerDatabase.md new file mode 100644 index 000000000000..5ac61ef6c125 --- /dev/null +++ b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolFollowerDatabase.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopoolfollowerdatabase +schema: 2.0.0 +--- + +# Get-AzSynapseKustoPoolFollowerDatabase + +## SYNOPSIS +Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool. + +## SYNTAX + +``` +Get-AzSynapseKustoPoolFollowerDatabase -KustoPoolName -ResourceGroupName + -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool. + +## EXAMPLES + +### Example 1: List all followed databases +```powershell +PS C:\> Get-AzSynapseKustoPoolFollowerDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool + +AttachedDatabaseConfigurationName DatabaseName KustoPoolResourceId +--------------------------------- ------------ ------------------- +conf1 testdatabase /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Synapse/workspaces/testws/kustoPools/followerpool +``` + +The above command returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IFollowerDatabaseDefinition + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolLanguageExtension.md b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolLanguageExtension.md new file mode 100644 index 000000000000..383d9e0326ae --- /dev/null +++ b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolLanguageExtension.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopoollanguageextension +schema: 2.0.0 +--- + +# Get-AzSynapseKustoPoolLanguageExtension + +## SYNOPSIS +Returns a list of language extensions that can run within KQL queries. + +## SYNTAX + +``` +Get-AzSynapseKustoPoolLanguageExtension -KustoPoolName -ResourceGroupName + -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Returns a list of language extensions that can run within KQL queries. + +## EXAMPLES + +### Example 1: List all language extensions set for a workspace +```powershell +PS C:\> Get-AzSynapseKustoPoolLanguageExtension -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testpool + +Name +---- +PYTHON +``` + +The above command returns a list of language extensions that can run within KQL queries. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.ILanguageExtension + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolPrincipalAssignment.md b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolPrincipalAssignment.md new file mode 100644 index 000000000000..9e247db43651 --- /dev/null +++ b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolPrincipalAssignment.md @@ -0,0 +1,203 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopoolprincipalassignment +schema: 2.0.0 +--- + +# Get-AzSynapseKustoPoolPrincipalAssignment + +## SYNOPSIS +Gets a Kusto pool principalAssignment. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolPrincipalAssignment -KustoPoolName -ResourceGroupName + -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzSynapseKustoPoolPrincipalAssignment -KustoPoolName -PrincipalAssignmentName + -ResourceGroupName -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzSynapseKustoPoolPrincipalAssignment -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets a Kusto pool principalAssignment. + +## EXAMPLES + +### Example 1: List all Kusto principalAssignments +```powershell +PS C:\> Get-AzSynapseKustoPoolPrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool + +Name Type +---- ---- +testws/testkustopool/kustoprincipal1 Microsoft.Synapse/workspaces/kustoPools/PrincipalAssignments +``` + +The above command lists all principalAssignments in the workspace "testws". + +### Example 2: Gets a Kusto principalAssignment by name +```powershell +PS C:\> Get-AzSynapseKustoPoolPrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -PrincipalAssignmentName kustoprincipal1 + +Name Type +---- ---- +testws/testkustopool/kustoprincipal1 Microsoft.Synapse/workspaces/kustoPools/PrincipalAssignments +``` + +The above command returns the Kusto principalAssignment named "kustoprincipal1" in the workspace "testws". + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IClusterPrincipalAssignment + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolSku.md b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolSku.md new file mode 100644 index 000000000000..8e6267e40b15 --- /dev/null +++ b/src/Synapse/Synapse/help/Get-AzSynapseKustoPoolSku.md @@ -0,0 +1,157 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/get-azsynapsekustopoolsku +schema: 2.0.0 +--- + +# Get-AzSynapseKustoPoolSku + +## SYNOPSIS +Lists eligible SKUs for Kusto Pool resource. + +## SYNTAX + +### List (Default) +``` +Get-AzSynapseKustoPoolSku [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzSynapseKustoPoolSku -KustoPoolName -ResourceGroupName -WorkspaceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Lists eligible SKUs for Kusto Pool resource. + +## EXAMPLES + +### Example 1: Lists eligible SKUs +```powershell +PS C:\> Get-AzSynapseKustoPoolSku + +Location Name ResourceType Size +-------- ---- ------------ ---- +{australiacentral} Compute optimized workspaces/kustoPools Extra small +{australiacentral2} Compute optimized workspaces/kustoPools Extra small +{australiaeast} Compute optimized workspaces/kustoPools Extra small +{australiasoutheast} Compute optimized workspaces/kustoPools Extra small +{brazilsouth} Compute optimized workspaces/kustoPools Extra small +... +``` + +The above command lists eligible SKUs. + +### Example 2: Lists eligible SKUs for specific kusto pool +```powershell +PS C:\> Get-AzSynapseKustoPoolSku -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testnewkustopool + +ResourceType +------------ +Microsoft.Synapse/workspaces/kustoPools +Microsoft.Synapse/workspaces/kustoPools +Microsoft.Synapse/workspaces/kustoPools +Microsoft.Synapse/workspaces/kustoPools +Microsoft.Synapse/workspaces/kustoPools +Microsoft.Synapse/workspaces/kustoPools +``` + +The above command lists eligible SKUs for specific kusto pool. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IAzureResourceSku + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.ISkuDescription + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md b/src/Synapse/Synapse/help/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md new file mode 100644 index 000000000000..6af869cc676f --- /dev/null +++ b/src/Synapse/Synapse/help/Invoke-AzSynapseDetachKustoPoolFollowerDatabase.md @@ -0,0 +1,276 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/invoke-azsynapsedetachkustopoolfollowerdatabase +schema: 2.0.0 +--- + +# Invoke-AzSynapseDetachKustoPoolFollowerDatabase + +## SYNOPSIS +Detaches all followers of a database owned by this Kusto Pool. + +## SYNTAX + +### DetachExpanded (Default) +``` +Invoke-AzSynapseDetachKustoPoolFollowerDatabase -KustoPoolName -ResourceGroupName + -WorkspaceName -AttachedDatabaseConfigurationName -KustoPoolResourceId + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DetachViaIdentityExpanded +``` +Invoke-AzSynapseDetachKustoPoolFollowerDatabase -InputObject + -AttachedDatabaseConfigurationName -KustoPoolResourceId [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Detaches all followers of a database owned by this Kusto Pool. + +## EXAMPLES + +### Example 1: Detach a follower database +```powershell +PS C:\> Invoke-AzSynapseDetachKustoPoolFollowerDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -AttachedDatabaseConfigurationName "myfollowerconfiguration" -KustoPoolResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Synapse/workspaces/testws/kustoPools/testfollowerkustopool" + +``` + +The above command detaches the follower database defined in AttachedDatabaseConfiguration "myfollowerconfiguration" from Kusto Pool "testfollowerkustopool". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachedDatabaseConfigurationName +Resource name of the attached database configuration in the follower cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DetachViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolResourceId +Resource id of the cluster that follows a database owned by this cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: DetachExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPool.md b/src/Synapse/Synapse/help/New-AzSynapseKustoPool.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/New-AzSynapseKustoPool.md rename to src/Synapse/Synapse/help/New-AzSynapseKustoPool.md diff --git a/src/Synapse/Synapse/help/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md new file mode 100644 index 000000000000..6843b43576dd --- /dev/null +++ b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolAttachedDatabaseConfiguration.md @@ -0,0 +1,363 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopoolattacheddatabaseconfiguration +schema: 2.0.0 +--- + +# New-AzSynapseKustoPoolAttachedDatabaseConfiguration + +## SYNOPSIS +Creates or updates an attached database configuration. + +## SYNTAX + +``` +New-AzSynapseKustoPoolAttachedDatabaseConfiguration -AttachedDatabaseConfigurationName + -KustoPoolName -ResourceGroupName -WorkspaceName [-SubscriptionId ] + [-DatabaseName ] [-DefaultPrincipalsModificationKind ] + [-KustoPoolResourceId ] [-Location ] + [-TableLevelSharingPropertyExternalTablesToExclude ] + [-TableLevelSharingPropertyExternalTablesToInclude ] + [-TableLevelSharingPropertyMaterializedViewsToExclude ] + [-TableLevelSharingPropertyMaterializedViewsToInclude ] + [-TableLevelSharingPropertyTablesToExclude ] [-TableLevelSharingPropertyTablesToInclude ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates an attached database configuration. + +## EXAMPLES + +### Example 1: Create a new AttachedDatabaseConfiguration +```powershell +PS C:\> New-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testfollowerkustopool -Name followerconfiguration -KustoPoolResourceId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Synapse/workspaces/testws/kustoPools/testkustopool -DatabaseName testdatabase -DefaultPrincipalsModificationKind Union -Location eastus2 + +Name Type Location +---- ---- -------- +testws/testfollowerkustopool/followerconfiguration Microsoft.Synapse/workspaces/kustoPools/AttachedDatabaseConfigurations East US 2 +``` + +The above command creates a ReadOnly database "testdatabase" in cluster "testfollowerkustopool". +It follows the database "testdatabase" from cluster "testkustopool" + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachedDatabaseConfigurationName +The name of the attached database configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database which you would like to attach, use * if you want to follow all current and future databases. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultPrincipalsModificationKind +The default principals modification kind + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.DefaultPrincipalsModificationKind +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolResourceId +The resource id of the kusto pool where the databases you would like to attach reside. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyExternalTablesToExclude +List of external tables exclude from the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyExternalTablesToInclude +List of external tables to include in the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyMaterializedViewsToExclude +List of materialized views exclude from the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyMaterializedViewsToInclude +List of materialized views to include in the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyTablesToExclude +List of tables to exclude from the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableLevelSharingPropertyTablesToInclude +List of tables to include in the follower database + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IAttachedDatabaseConfiguration + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDataConnection.md b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDataConnection.md new file mode 100644 index 000000000000..6faf61770ec2 --- /dev/null +++ b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDataConnection.md @@ -0,0 +1,501 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopooldataconnection +schema: 2.0.0 +--- + +# New-AzSynapseKustoPoolDataConnection + +## SYNOPSIS +Creates or updates a data connection. + +## SYNTAX + +### CreateExpandedEventHub (Default) +``` +New-AzSynapseKustoPoolDataConnection -DatabaseName -DataConnectionName + -KustoPoolName -ResourceGroupName -WorkspaceName -ConsumerGroup + -EventHubResourceId -Kind -Location [-SubscriptionId ] + [-Compression ] [-DataFormat ] [-EventSystemProperty ] + [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateExpandedEventGrid +``` +New-AzSynapseKustoPoolDataConnection -DatabaseName -DataConnectionName + -KustoPoolName -ResourceGroupName -WorkspaceName -ConsumerGroup + -EventHubResourceId -Kind -Location -StorageAccountResourceId + [-SubscriptionId ] [-DataFormat ] [-MappingRuleName ] + [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateExpandedIotHub +``` +New-AzSynapseKustoPoolDataConnection -DatabaseName -DataConnectionName + -KustoPoolName -ResourceGroupName -WorkspaceName -ConsumerGroup + -IotHubResourceId -Kind -Location -SharedAccessPolicyName + [-SubscriptionId ] [-DataFormat ] [-EventSystemProperty ] + [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateExpandedEventGrid +``` +New-AzSynapseKustoPoolDataConnection -DatabaseName -DataConnectionName + -KustoPoolName -ResourceGroupName -WorkspaceName -ConsumerGroup + -Kind -Location [-SubscriptionId ] + [-BlobStorageEventType ] [-DataFormat ] [-IgnoreFirstRecord] + [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpandedEventGrid +``` +New-AzSynapseKustoPoolDataConnection -DatabaseName -DataConnectionName + -KustoPoolName -ResourceGroupName -WorkspaceName -ConsumerGroup + -Kind -Location [-SubscriptionId ] + [-BlobStorageEventType ] [-DataFormat ] [-IgnoreFirstRecord] + [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates a data connection. + +## EXAMPLES + +### Example 1: Create a new EventHub data connection +```powershell +PS C:\> New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventhubdc -Location eastus2 -Kind EventHub -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "EventsMapping" + +Kind Location Name +---- -------- ---- +EventHub East US 2 testws/testkustopool/testdatabase/eventhubdc +``` + +The above command creates a new EventHub data connection named "eventhubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 2: Create a new EventGrid data connection +```powershell +PS C:\> New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventgriddc -Location eastus2 -Kind EventGrid -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" -IgnoreFirstRecord -BlobStorageEventType "Microsoft.Storage.BlobRenamed" + +Kind Location Name +---- -------- ---- +EventGrid East US 2 testws/testkustopool/testdatabase/eventgriddc +``` + +The above command creates a new EventGrid data connection named "eventgriddc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 3: Create a new IotHub data connection +```powershell +PS C:\> New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name iothubdc -Location eastus2 -Kind IotHub -IotHubResourceId "/subscriptions/051ddeca-1ed6-4d8b-ba6f-1ff561e5f3b3/resourceGroups/ywtest/providers/Microsoft.Devices/IotHubs/ywtestiothub" -SharedAccessPolicyName registryRead -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" + +Kind Location Name +---- -------- ---- +IotHub East US 2 testws/testkustopool/testdatabase/iothubdc +``` + +The above command creates a new IotHub data connection named "iothubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageEventType +The name of blob storage event type to process. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.BlobStorageEventType +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compression +The event hub messages compression type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.Compression +Parameter Sets: CreateExpandedEventHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsumerGroup +The event/iot hub consumer group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataConnectionName +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFormat +The data format of the message. +Optionally the data format can be added to each message. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.EventGridDataFormat +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubResourceId +The resource ID of the event hub to be used to create a data connection / event grid is configured to send events. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedEventGrid, CreateExpandedEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSystemProperty +System properties of the event/iot hub. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpandedEventHub, CreateExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreFirstRecord +If set to true, indicates that ingestion should ignore the first record of every file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IotHubResourceId +The resource ID of the Iot hub to be used to create a data connection. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the endpoint for the data connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.DataConnectionKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingRuleName +The mapping rule to be used to ingest the data. +Optionally the mapping information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedAccessPolicyName +The name of the share access policy. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The resource ID of the storage account where the data resides. + +```yaml +Type: System.String +Parameter Sets: CreateExpandedEventGrid +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableName +The table where the data should be ingested. +Optionally the table information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDataConnection + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDataConnection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDatabase.md b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDatabase.md new file mode 100644 index 000000000000..1e5cb7262be7 --- /dev/null +++ b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDatabase.md @@ -0,0 +1,266 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopooldatabase +schema: 2.0.0 +--- + +# New-AzSynapseKustoPoolDatabase + +## SYNOPSIS +Creates or updates a database. + +## SYNTAX + +``` +New-AzSynapseKustoPoolDatabase -DatabaseName -KustoPoolName -ResourceGroupName + -WorkspaceName -Kind [-SubscriptionId ] [-HotCachePeriod ] + [-Location ] [-SoftDeletePeriod ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates a database. + +## EXAMPLES + +### Example 1: Creates or updates a new kusto database in a workspace +```powershell +PS C:\> New-AzSynapseKustoPoolDatabase -ResourceGroupName "testrg" -WorkspaceName "testws" -KustoPoolName "testkustopool" -DatabaseName "mykustodatabase" -Kind "ReadWrite" -Location "East US 2" + +Kind Location Name +---- -------- ---- +ReadWrite East US 2 testws/testkustopool/mykustodatabase +``` + +Creates or updates a kusto database "mykustodatabase" in Kusto Pool "testkustopool" in the workspace "testws" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotCachePeriod +The time the data should be kept in cache for fast queries in TimeSpan. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the database + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletePeriod +The time the data should be kept before it stops being accessible to queries in TimeSpan. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDatabase + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md new file mode 100644 index 000000000000..57e5b67ee884 --- /dev/null +++ b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDatabasePrincipalAssignment.md @@ -0,0 +1,283 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopooldatabaseprincipalassignment +schema: 2.0.0 +--- + +# New-AzSynapseKustoPoolDatabasePrincipalAssignment + +## SYNOPSIS +Creates a Kusto pool database principalAssignment. + +## SYNTAX + +``` +New-AzSynapseKustoPoolDatabasePrincipalAssignment -DatabaseName -KustoPoolName + -PrincipalAssignmentName -ResourceGroupName -WorkspaceName + [-SubscriptionId ] [-PrincipalId ] [-PrincipalType ] + [-Role ] [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a Kusto pool database principalAssignment. + +## EXAMPLES + +### Example 1: Create a Kusto pool database principalAssignment +```powershell +PS C:\> New-AzSynapseKustoPoolDatabasePrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -PrincipalAssignmentName kustoprincipal -PrincipalId 00000000-0000-0000-0000-000000000000 -PrincipalType App -Role Viewer + +Name Type +---- ---- +testws/testkustopool/testdatabase/kustoprincipal Microsoft.Synapse/workspaces/kustoPools/Databases/PrincipalAssignments +``` + +The above command creates a Kusto pool database principalAssignment + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +The principal ID assigned to the database principal. +It can be a user email, application ID, or security group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalType +Principal type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.PrincipalType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +Database principal role. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.DatabasePrincipalRole +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +The tenant id of the principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDatabasePrincipalAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/New-AzSynapseKustoPoolPrincipalAssignment.md b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolPrincipalAssignment.md new file mode 100644 index 000000000000..a1f429d14c0e --- /dev/null +++ b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolPrincipalAssignment.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/new-azsynapsekustopoolprincipalassignment +schema: 2.0.0 +--- + +# New-AzSynapseKustoPoolPrincipalAssignment + +## SYNOPSIS +Create a Kusto pool principalAssignment. + +## SYNTAX + +``` +New-AzSynapseKustoPoolPrincipalAssignment -KustoPoolName -PrincipalAssignmentName + -ResourceGroupName -WorkspaceName [-SubscriptionId ] [-PrincipalId ] + [-PrincipalType ] [-Role ] [-TenantId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a Kusto pool principalAssignment. + +## EXAMPLES + +### Example 1: Create a Kusto pool principalAssignment +```powershell +PS C:\> New-AzKustoPoolPrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testnewkustopool -PrincipalAssignmentName kustoprincipal -PrincipalId "00000000-0000-0000-0000-000000000000" -PrincipalType App -Role AllDatabasesAdmin + +Name Type +---- ---- +testws/testnewkustopool/kustoprincipal Microsoft.Synapse/workspaces/kustoPools/PrincipalAssignments +``` + +The above command creates a Kusto pool principalAssignment + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalId +The principal ID assigned to the cluster principal. +It can be a user email, application ID, or security group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalType +Principal type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.PrincipalType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +Cluster principal role. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.ClusterPrincipalRole +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +The tenant id of the principal + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IClusterPrincipalAssignment + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPool.md b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPool.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Remove-AzSynapseKustoPool.md rename to src/Synapse/Synapse/help/Remove-AzSynapseKustoPool.md diff --git a/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md new file mode 100644 index 000000000000..50cf11353114 --- /dev/null +++ b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration.md @@ -0,0 +1,258 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopoolattacheddatabaseconfiguration +schema: 2.0.0 +--- + +# Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration + +## SYNOPSIS +Deletes the attached database configuration with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration -AttachedDatabaseConfigurationName + -KustoPoolName -ResourceGroupName -WorkspaceName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes the attached database configuration with the given name. + +## EXAMPLES + +### Example 1: Delete an existing AttachedDatabaseConfiguration by name +```powershell +PS C:\> Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName "testrg" -WorkspaceName "testws" -KustoPoolName "testkustopool" -AttachedDatabaseConfigurationName "myfollowerconfiguration" +``` + +The above command deletes the attached database configuration with the given name "myfollowerconfiguration" from workspace "testws". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachedDatabaseConfigurationName +The name of the attached database configuration. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDataConnection.md b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDataConnection.md new file mode 100644 index 000000000000..ab346f24e343 --- /dev/null +++ b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDataConnection.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopooldataconnection +schema: 2.0.0 +--- + +# Remove-AzSynapseKustoPoolDataConnection + +## SYNOPSIS +Deletes the data connection with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPoolDataConnection -DatabaseName -DataConnectionName + -KustoPoolName -ResourceGroupName -WorkspaceName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPoolDataConnection -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes the data connection with the given name. + +## EXAMPLES + +### Example 1: Delete an existing data connection by name +```powershell +PS C:\> Remove-AzSynapseKustoPoolDataConnection -ResourceGroupName "testrg" -WrokspaceName "testws" -KustoPoolName "testkustopool" -DatabaseName "mykustodatabase" -DataConnectionName "mykustodataconnection" +``` + +The above command deletes the data connection named "mykustodataconnection" in kusto database "mykustodatabase" of the existing workspace "testws" found in the resource group "testrg" + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataConnectionName +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDatabase.md b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDatabase.md new file mode 100644 index 000000000000..9e23ecae79b8 --- /dev/null +++ b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDatabase.md @@ -0,0 +1,258 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopooldatabase +schema: 2.0.0 +--- + +# Remove-AzSynapseKustoPoolDatabase + +## SYNOPSIS +Deletes the database with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPoolDatabase -DatabaseName -KustoPoolName -ResourceGroupName + -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPoolDatabase -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes the database with the given name. + +## EXAMPLES + +### Example 1: Delete an existing Kusto database by name +```powershell +PS C:\> Remove-AzSynapseKustoPoolDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -Name mykustodatabase +``` + +The above command deletes the Kusto database named "mykustodatabase" in the workspace "testws" found in the resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md new file mode 100644 index 000000000000..d058bbed9ba7 --- /dev/null +++ b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolDatabasePrincipalAssignment.md @@ -0,0 +1,274 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopooldatabaseprincipalassignment +schema: 2.0.0 +--- + +# Remove-AzSynapseKustoPoolDatabasePrincipalAssignment + +## SYNOPSIS +Deletes a Kusto pool principalAssignment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPoolDatabasePrincipalAssignment -DatabaseName -KustoPoolName + -PrincipalAssignmentName -ResourceGroupName -WorkspaceName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPoolDatabasePrincipalAssignment -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a Kusto pool principalAssignment. + +## EXAMPLES + +### Example 1: Delete an existing Kusto database PrincipalAssignment by name +```powershell +PS C:\> Remove-AzSynapseKustoPoolDatabasePrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -DatabaseName mykustodatabase -PrincipalAssignmentName kustoprincipal1 +``` + +The above command deletes the PrincipalAssignment named "kustoprincipal1" in the Kusto database "mykustodatabase" in workspace "testws" found in resource group "testrg". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolLanguageExtension.md b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolLanguageExtension.md new file mode 100644 index 000000000000..8a85ea0adfbe --- /dev/null +++ b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolLanguageExtension.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopoollanguageextension +schema: 2.0.0 +--- + +# Remove-AzSynapseKustoPoolLanguageExtension + +## SYNOPSIS +Remove a list of language extensions that can run within KQL queries. + +## SYNTAX + +### RemoveExpanded (Default) +``` +Remove-AzSynapseKustoPoolLanguageExtension -KustoPoolName -ResourceGroupName + -WorkspaceName [-SubscriptionId ] [-Value ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RemoveViaIdentityExpanded +``` +Remove-AzSynapseKustoPoolLanguageExtension -InputObject [-Value ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Remove a list of language extensions that can run within KQL queries. + +## EXAMPLES + +### Example 1: Remove a list of language extensions from kusto pool +```powershell +PS C:\> Remove-AzSynapseKustoPoolLanguageExtension -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -Value (@{Name="R"}) +``` + +The above command removes a list of language extensions that can run within KQL queries. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: RemoveViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +The list of language extensions. +To construct, see NOTES section for VALUE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.ILanguageExtension[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: RemoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +VALUE : The list of language extensions. + - `[Name ]`: The language extension name. + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolPrincipalAssignment.md b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolPrincipalAssignment.md new file mode 100644 index 000000000000..4728fb502f4a --- /dev/null +++ b/src/Synapse/Synapse/help/Remove-AzSynapseKustoPoolPrincipalAssignment.md @@ -0,0 +1,258 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/remove-azsynapsekustopoolprincipalassignment +schema: 2.0.0 +--- + +# Remove-AzSynapseKustoPoolPrincipalAssignment + +## SYNOPSIS +Deletes a Kusto pool principalAssignment. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzSynapseKustoPoolPrincipalAssignment -KustoPoolName -PrincipalAssignmentName + -ResourceGroupName -WorkspaceName [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzSynapseKustoPoolPrincipalAssignment -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a Kusto pool principalAssignment. + +## EXAMPLES + +### Example 1: Delete an existing Kusto pool PrincipalAssignment by name +```powershell +PS C:\> Remove-AzSynapseKustoPoolPrincipalAssignment -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -PrincipalAssignmentName kustoprincipal1 +``` + +The above command deletes a Kusto pool principalAssignment "kustoprincipal1" in the workspace "testws". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalAssignmentName +The name of the Kusto principalAssignment. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Start-AzSynapseKustoPool.md b/src/Synapse/Synapse/help/Start-AzSynapseKustoPool.md new file mode 100644 index 000000000000..bd67a1597d73 --- /dev/null +++ b/src/Synapse/Synapse/help/Start-AzSynapseKustoPool.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/start-azsynapsekustopool +schema: 2.0.0 +--- + +# Start-AzSynapseKustoPool + +## SYNOPSIS +Starts a Kusto pool. + +## SYNTAX + +### Start (Default) +``` +Start-AzSynapseKustoPool -Name -ResourceGroupName -WorkspaceName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### StartViaIdentity +``` +Start-AzSynapseKustoPool -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Starts a Kusto pool. + +## EXAMPLES + +### Example 1: Start a Kusto pool +```powershell +PS C:\> Start-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws -Name testnewkustopool +``` + +The above command starts a Kusto pool. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: KustoPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Stop-AzSynapseKustoPool.md b/src/Synapse/Synapse/help/Stop-AzSynapseKustoPool.md new file mode 100644 index 000000000000..7d6122e57e60 --- /dev/null +++ b/src/Synapse/Synapse/help/Stop-AzSynapseKustoPool.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/stop-azsynapsekustopool +schema: 2.0.0 +--- + +# Stop-AzSynapseKustoPool + +## SYNOPSIS +Stops a Kusto pool. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzSynapseKustoPool -Name -ResourceGroupName -WorkspaceName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### StopViaIdentity +``` +Stop-AzSynapseKustoPool -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Stops a Kusto pool. + +## EXAMPLES + +### Example 1: Stop a Kusto pool +```powershell +PS C:\> Stop-AzSynapseKustoPool -ResourceGroupName testrg -WorkspaceName testws -Name testnewkustopool +``` + +The above command stops a Kusto pool. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: KustoPoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse.Autorest/help/Update-AzSynapseKustoPool.md b/src/Synapse/Synapse/help/Update-AzSynapseKustoPool.md similarity index 100% rename from src/Synapse/Synapse.Autorest/help/Update-AzSynapseKustoPool.md rename to src/Synapse/Synapse/help/Update-AzSynapseKustoPool.md diff --git a/src/Synapse/Synapse/help/Update-AzSynapseKustoPoolDataConnection.md b/src/Synapse/Synapse/help/Update-AzSynapseKustoPoolDataConnection.md new file mode 100644 index 000000000000..76f27eb5a2ab --- /dev/null +++ b/src/Synapse/Synapse/help/Update-AzSynapseKustoPoolDataConnection.md @@ -0,0 +1,577 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/update-azsynapsekustopooldataconnection +schema: 2.0.0 +--- + +# Update-AzSynapseKustoPoolDataConnection + +## SYNOPSIS +Updates a data connection. + +## SYNTAX + +### UpdateExpandedEventHub (Default) +``` +Update-AzSynapseKustoPoolDataConnection -DatabaseName -DataConnectionName + -KustoPoolName -ResourceGroupName -WorkspaceName -ConsumerGroup + -EventHubResourceId -Kind -Location [-SubscriptionId ] + [-Compression ] [-DataFormat ] [-EventSystemProperty ] + [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateExpandedEventGrid +``` +Update-AzSynapseKustoPoolDataConnection -DatabaseName -DataConnectionName + -KustoPoolName -ResourceGroupName -WorkspaceName -ConsumerGroup + -EventHubResourceId -Kind -Location -StorageAccountResourceId + [-SubscriptionId ] [-BlobStorageEventType ] [-DataFormat ] + [-IgnoreFirstRecord] [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateExpandedIotHub +``` +Update-AzSynapseKustoPoolDataConnection -DatabaseName -DataConnectionName + -KustoPoolName -ResourceGroupName -WorkspaceName -ConsumerGroup + -IotHubResourceId -Kind -Location -SharedAccessPolicyName + [-SubscriptionId ] [-DataFormat ] [-EventSystemProperty ] + [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpandedEventGrid +``` +Update-AzSynapseKustoPoolDataConnection -InputObject -ConsumerGroup + -EventHubResourceId -Kind -Location -StorageAccountResourceId + [-BlobStorageEventType ] [-DataFormat ] [-IgnoreFirstRecord] + [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpandedEventHub +``` +Update-AzSynapseKustoPoolDataConnection -InputObject -ConsumerGroup + -EventHubResourceId -Kind -Location [-Compression ] + [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] + [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpandedIotHub +``` +Update-AzSynapseKustoPoolDataConnection -InputObject -ConsumerGroup + -IotHubResourceId -Kind -Location -SharedAccessPolicyName + [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] + [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Updates a data connection. + +## EXAMPLES + +### Example 1: Update an existing EventHub data connection +```powershell +PS C:\> Update-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventhubdc -Location eastus2 -Kind EventHub -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "EventsMapping" + +Kind Location Name +---- -------- ---- +EventHub East US 2 testws/testkustopool/testdatabase/eventhubdc +``` + +The above command updates the existing EventHub data connection named "eventhubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 2: Update an existing EventGrid data connection +```powershell +PS C:\> Update-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventgriddc -Location eastus2 -Kind EventGrid -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" + +Kind Location Name +---- -------- ---- +EventGrid East US 2 testws/testkustopool/testdatabase/eventgriddc +``` + +The above command updates the existing EventGrid data connection named "eventgriddc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 3: Update an existing IotHub data connection +```powershell +PS C:\> Update-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name iothubdc -Location eastus2 -Kind IotHub -IotHubResourceId "/subscriptions/051ddeca-1ed6-4d8b-ba6f-1ff561e5f3b3/resourceGroups/ywtest/providers/Microsoft.Devices/IotHubs/ywtestiothub" -SharedAccessPolicyName registryRead -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" + +Kind Location Name +---- -------- ---- +IotHub East US 2 testws/testkustopool/testdatabase/iothubdc +``` + +The above command updates the existing IotHub data connection named "iothubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 4: Update an existing EventHub data connection via identity +```powershell +PS C:\> $dataConnection = Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventhubdc +PS C:\> Update-AzSynapseKustoPoolDataConnection -InputObject $dataConnection -Location eastus2 -Kind EventHub -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "EventsMapping" + +Kind Location Name +---- -------- ---- +EventHub East US 2 testws/testkustopool/testdatabase/eventhubdc +``` + +The above command updates the existing EventHub data connection named "eventhubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 5: Update an existing EventGrid data connection via identity +```powershell +PS C:\> $dataConnection = Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventgriddc +PS C:\> Update-AzSynapseKustoPoolDataConnection -InputObject $dataConnection -Location eastus2 -Kind EventGrid -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" + +Kind Location Name +---- -------- ---- +EventGrid East US 2 testws/testkustopool/testdatabase/eventgriddc +``` + +The above command updates the existing EventGrid data connection named "eventgriddc" for the database "testdatabase" in the kusto pool "testkustopool". + +### Example 6: Update an existing IotHub data connection via identity +```powershell +PS C:\> $dataConnection = Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name iothubdc +PS C:\> Update-AzSynapseKustoPoolDataConnection -InputObject $dataConnection -Location eastus2 -Kind IotHub -IotHubResourceId "/subscriptions/051ddeca-1ed6-4d8b-ba6f-1ff561e5f3b3/resourceGroups/ywtest/providers/Microsoft.Devices/IotHubs/ywtestiothub" -SharedAccessPolicyName registryRead -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" + +Kind Location Name +---- -------- ---- +IotHub East US 2 testws/testkustopool/testdatabase/iothubdc +``` + +The above command updates the existing IotHub data connection named "iothubdc" for the database "testdatabase" in the kusto pool "testkustopool". + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlobStorageEventType +The name of blob storage event type to process. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.BlobStorageEventType +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Compression +The event hub messages compression type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.Compression +Parameter Sets: UpdateExpandedEventHub, UpdateViaIdentityExpandedEventHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConsumerGroup +The event/iot hub consumer group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataConnectionName +The name of the data connection. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataFormat +The data format of the message. +Optionally the data format can be added to each message. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.EventGridDataFormat +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventHubResourceId +The resource ID of the event hub to be used to create a data connection / event grid is configured to send events. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventSystemProperty +System properties of the event/iot hub. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreFirstRecord +If set to true, indicates that ingestion should ignore the first record of every file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IotHubResourceId +The resource ID of the Iot hub to be used to create a data connection. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedIotHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Kind +Kind of the endpoint for the data connection + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.DataConnectionKind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingRuleName +The mapping rule to be used to ingest the data. +Optionally the mapping information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedAccessPolicyName +The name of the share access policy. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedIotHub, UpdateViaIdentityExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The resource ID of the storage account where the data resides. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TableName +The table where the data should be ingested. +Optionally the table information can be added to each message. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDataConnection + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/src/Synapse/Synapse/help/Update-AzSynapseKustoPoolDatabase.md b/src/Synapse/Synapse/help/Update-AzSynapseKustoPoolDatabase.md new file mode 100644 index 000000000000..688450f5195b --- /dev/null +++ b/src/Synapse/Synapse/help/Update-AzSynapseKustoPoolDatabase.md @@ -0,0 +1,325 @@ +--- +external help file: +Module Name: Az.Synapse +online version: https://docs.microsoft.com/powershell/module/az.synapse/update-azsynapsekustopooldatabase +schema: 2.0.0 +--- + +# Update-AzSynapseKustoPoolDatabase + +## SYNOPSIS +Updates a database. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzSynapseKustoPoolDatabase -DatabaseName -KustoPoolName -ResourceGroupName + -WorkspaceName -Kind [-SubscriptionId ] [-HotCachePeriod ] + [-Location ] [-SoftDeletePeriod ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzSynapseKustoPoolDatabase -InputObject -Kind [-HotCachePeriod ] + [-Location ] [-SoftDeletePeriod ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates a database. + +## EXAMPLES + +### Example 1: Update an existing database by name +```powershell +PS C:\> $2ds = New-TimeSpan -Days 2 +PS C:\> $4ds = New-TimeSpan -Days 4 +PS C:\> Update-AzSynapseKustoPoolDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase -Kind ReadWrite -SoftDeletePeriod $4ds -HotCachePeriod $2ds -Location 'East US' + +Kind Location Name +---- -------- ---- +ReadWrite East US testws/testkustopool/mykustodatabase +``` + +The above command updates the soft deletion period and hot cache period of the Kusto database "mykustodatabase" in the workspace "testws" found in the resource group "testrg". + +### Example 2: Update an existing database via identity +```powershell +PS C:\> $database = Get-AzSynapseKustoPoolDatabase -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName mykustodatabase +PS C:\> $2ds = New-TimeSpan -Days 2 +PS C:\> $4ds = New-TimeSpan -Days 4 +PS C:\> Update-AzSynapseKustoPoolDatabase -InputObject $database -Kind ReadWrite -SoftDeletePeriod $4ds -HotCachePeriod $2ds -Location 'East US' + +Kind Location Name +---- -------- ---- +ReadWrite East US testws/testkustopool/mykustodatabase +``` + +The above command updates the soft deletion period and hot cache period of the Kusto database "mykustodatabase" in the workspace "testws" found in the resource group "testrg" via database identity. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database in the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: Name + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotCachePeriod +The time the data should be kept in cache for fast queries in TimeSpan. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Kind +Kind of the database + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Synapse.Support.Kind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KustoPoolName +The name of the Kusto pool. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Resource location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletePeriod +The time the data should be kept before it stops being accessible to queries in TimeSpan. + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WorkspaceName +The name of the workspace + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.ISynapseIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IDatabase + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[AttachedDatabaseConfigurationName ]`: The name of the attached database configuration. + - `[DataConnectionName ]`: The name of the data connection. + - `[DatabaseName ]`: The name of the database in the Kusto pool. + - `[Id ]`: Resource identity path + - `[KustoPoolName ]`: The name of the Kusto pool. + - `[Location ]`: The name of Azure region. + - `[PrincipalAssignmentName ]`: The name of the Kusto principalAssignment. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[WorkspaceName ]`: The name of the workspace + +## RELATED LINKS + diff --git a/tools/GeneratedModuleList.txt b/tools/GeneratedModuleList.txt index 966c6490c7f9..bb73722de6b9 100644 --- a/tools/GeneratedModuleList.txt +++ b/tools/GeneratedModuleList.txt @@ -41,7 +41,6 @@ Az.RedisEnterpriseCache Az.ResourceMover Az.SpringCloud Az.StreamAnalytics -Az.Synapse Az.TimeSeriesInsights Az.VMware Az.WebPubSub