diff --git a/src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.psd1 b/src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.psd1 index fbd08887e8a9..b66a85f2842e 100644 --- a/src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.psd1 +++ b/src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.psd1 @@ -61,7 +61,7 @@ FormatsToProcess = @() # Modules to import as nested modules of the module specified in ModuleToProcess NestedModules = @( - '..\..\..\Package\Debug\ResourceManager\AzureResourceManager\Sql\Microsoft.Azure.Commands.Sql.dll' + '..\..\..\Package\Debug\ResourceManager\AzureResourceManager\AzureRM.Sql\Microsoft.Azure.Commands.Sql.dll' ) # Functions to export from this module diff --git a/src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.xml b/src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.xml index 394ba2937465..0a5fdff69258 100644 --- a/src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.xml +++ b/src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.xml @@ -1,12253 +1,12528 @@ - - - - - - Disable-AzureRMSqlDatabaseDirectAccess - - Disables the option to directly access an Azure SQL Database (without auditing). - - - - - Disable - AzureSqlDatabaseDirectAccess - - - - The Disable-AzureRMSqlDatabaseDirectAccess cmdlet disables the possibility of accessing an Azure SQL Database without auditing. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database. After the successful execution of the cmdlet, directly accessing an Azure Sql Database is disabled. If the command succeeds and the PassThru switch is on, it returns an object describing the current auditing policy used as well as the database identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Disable-AzureRMSqlDatabaseDirectAccess - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e., ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - ServerName - - Specifies the name of the database server holding the database. - - String - - - DatabaseName - - Specifies the name of the database. Wildcards are not permitted. - - String - - - ResourceGroupName - - Specifies the name of the resource group of the database. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e., ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - ServerName - - Specifies the name of the database server holding the database. - - String - - String - - - none - - - DatabaseName - - Specifies the name of the database. Wildcards are not permitted. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group of the database. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseSecureConnectionPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Disable-AzureRMSqlDatabaseDirectAccess –ResourceGroupName "resourcegroup1" –ServerName "server1" -DatabaseName "database1" - - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Enable-AzureRMSqlDatabaseDirectAccess - - - - - - - - Enable-AzureRMSqlDatabaseDirectAccess - - Enables the option to directly access an Azure SQL Database (with auditing). - - - - - Enable - AzureSqlDatabaseDirectAccess - - - - The Enable-AzureRMSqlDatabaseDirectAccess cmdlet enables the possibility of accessing an Azure SQL Database without auditing. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database.After the successful execution of the cmdlet, directly accessing to an Azure SQL Database is disabled. If the command succeeds and the PassThru switch is on, it returns an object describing the current auditing policy used as well as the database identifiers (i.e. ResourceGroupName, ServerName and DatabaseName). - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Enable-AzureRMSqlDatabaseDirectAccess - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e., ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - ServerName - - The name of the server containing the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - Specifies the name of the resource group of the database. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e., ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - ServerName - - The name of the server containing the database. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group of the database. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseSecureConnectionPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Enable-AzureRMSqlDatabaseDirectAccess –ResourceGroupName "resourcegroup1" –ServerName "server1" -DatabaseName "database1" - - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Disable-AzureRMSqlDatabaseDirectAccess - - - - - - - - Get-AzureRMSqlDatabase - - Returns one or more Azure SQL Database. - - - - - Get - AzureSqlDatabase - - - - Use this cmdlet to retrieve one or more Azure SQL Database from an Azure SQL Database Server. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlDatabase - - DatabaseName - - The name of the Azure SQL Database to retrieve. - - String - - - ServerName - - The name of the Azure SQL Database Server the database is in. - - String - - - ResourceGroupName - - The name of the resource group of the server containing the database to retrieve. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - DatabaseName - - The name of the Azure SQL Database to retrieve. - - String - - String - - - none - - - ServerName - - The name of the Azure SQL Database Server the database is in. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group of the server containing the database to retrieve. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example 1 -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlDatabase –ResourceGroupName "resourcegroup1" –ServerName "server1" - - This example returns all databases on server, "server1". - - - - - - - - - - - - - - -------------------------- Code Example 2 -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlDatabase –ResourceGroupName "resourcegroup1" –ServerName "server1" –DatabaseName "database1" - - This example returns database named "database1", from server "server1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - New-AzureRMSqlDatabase - - - - Remove-AzureRMSqlDatabase - - - - Set-AzureRMSqlDatabase - - - - - - - - Get-AzureRMSqlDatabaseActivity - - - - - - - Get - AzureSqlDatabaseActivity - - - - - - - - Get-AzureRMSqlDatabaseActivity - - ServerName - - - - String - - - ElasticPoolName - - - - String - - - DatabaseName - - - - String - - - OperationId - - - - Nullable`1[Guid] - - - ResourceGroupName - - - - String - - - Profile - - - - AzureProfile - - - - - - ServerName - - - - String - - String - - - - - - ElasticPoolName - - - - String - - String - - - - - - DatabaseName - - - - String - - String - - - - - - OperationId - - - - Nullable`1[Guid] - - Nullable`1[Guid] - - - - - - ResourceGroupName - - - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Get-AzureRMSqlDatabaseAuditingPolicy - - Gets an Azure SQL Database's auditing policy. - - - - - Get - AzureSqlDatabaseAuditingPolicy - - - - The Get-AzureRMSqlDatabaseAuditingPolicy cmdlet gets the auditing policy of an Azure Sql database. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlDatabaseAuditingPolicy - - ServerName - - The name of the server that contains the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group that contains the database. - - String - - - Profile - - In-Memory profile. - - AzureProfile - - - - - - ServerName - - The name of the server that contains the database. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group that contains the database. - - String - - String - - - none - - - Profile - - In-Memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlDatabaseAuditingPolicy –ResourceGroupName "resourcegroup1" –ServerName "server1" -DatabaseName "database1" - - Code Example Description - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Remove-AzureRMSqlDatabaseAuditing - - - - Set-AzureRMSqlDatabaseAuditingPolicy - - - - - - - - Get-AzureRMSqlDatabaseDataMaskingPolicy - - Gets an Azure SQL Database's data masking policy. - - - - - Get - AzureSqlDatabaseDataMaskingPolicy - - - - The Get-AzureRMSqlDatabaseDataMaskingPolicy cmdlet gets the data masking policy of an Azure SQL Database. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlDatabaseDataMaskingPolicy - - ServerName - - The name of the server containing the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - ServerName - - The name of the server containing the database. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlDatabaseDataMaskingPolicy –ResourceGroupName "resourcegroup1" –ServerName "server1" -DatabaseName "database1" - - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlDatabaseDataMaskingRule - - - - New-AzureRMSqlDatabaseDataMaskingRule - - - - Remove-AzureRMSqlDatabaseDataMaskingRule - - - - Set-AzureRMSqlDatabaseDataMaskingPolicy - - - - Set-AzureRMSqlDatabaseDataMaskingRule - - - - - - - - Get-AzureRMSqlDatabaseDataMaskingRule - - Gets an Azure SQL Database's data masking rule. - - - - - Get - AzureSqlDatabaseDataMaskingRule - - - - The Get-AzureRMSqlDatabaseDataMaskingRule cmdlet gets either a specific data masking rule, or all of the data masking rule of an Azure SQL Database. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database, and the RuleId to specify which rule this cmdlet returns. If no RuleId is provided, then all the data masking rules of that Azure SQL Database are returned. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlDatabaseDataMaskingRule - - RuleId - - The Id of the requested rule. If not specified, information about all the data masking rules in the specified SQL Database are listed. - - String - - - ServerName - - The name of the server containing the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - RuleId - - The Id of the requested rule. If not specified, information about all the data masking rules in the specified SQL Database are listed. - - String - - String - - - none - - - ServerName - - The name of the server containing the database. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlDatabaseDataMaskingRule –ResourceGroupName "resourcegroup1" –ServerName "server1" -DatabaseName "database1" - - This example returns all data masking rules for "database1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlDatabaseDataMaskingPolicy - - - - New-AzureRMSqlDatabaseDataMaskingRule - - - - Remove-AzureRMSqlDatabaseDataMaskingRule - - - - Set-AzureRMSqlDatabaseDataMaskingPolicy - - - - Set-AzureRMSqlDatabaseDataMaskingRule - - - - - - - - Get-AzureRMSqlDatabaseSecureConnectionPolicy - - Returns the secure connection policy of an Azure SQL Database. - - - - - Get - AzureSqlDatabaseSecureConnectionPolicy - - - - The Get-AzureRMSqlDatabaseSecureConnectionPolicy cmdlet returns the secure connection policy of an Azure SQL Database. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database. After the successful execution of the cmdlet it returns an object describing the current secure connection policy as well as the database identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlDatabaseSecureConnectionPolicy - - ServerName - - The name of server containing the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - ServerName - - The name of server containing the database. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseSecureConnectionPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlDatabaseSecureConnectionPolicy –ResourceGroupName "resourcegroup1" –ServerName "server1" -DatabaseName "database1" - - Code Example Description - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Get-AzureRMSqlServerAuditingPolicy - - Gets an Azure SQL Server's auditing policy. - - - - - Get - AzureSqlServerAuditingPolicy - - - - The Get-AzureRMSqlServerAuditingPolicy cmdlet gets the auditing policy of an Azure SQL Server. To use the cmdlet, use the ResourceGroupName and the ServerName parameters to identify the database server. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlServerAuditingPolicy - - ServerName - - The name of the server containing the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - ServerName - - The name of the server containing the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlServerAuditingPolicy –ResourceGroupName "resourcegroup1" –ServerName "server1" - - The following example returns the auditing policy for "server1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlDatabaseAuditingPolicy - - - - Remove-AzureRMSqlDatabaseAuditing - - - - Remove-AzureRMSqlServerAuditing - - - - Set-AzureRMSqlDatabaseAuditingPolicy - - - - Set-AzureRMSqlServerAuditingPolicy - - - - Use-AzureRMSqlServerAuditingPolicy - - - - - - - - Get-AzureRMSqlServerActiveDirectoryAdministrator - - Returns information about an Azure Active Directory administrator for Azure SQL Server in the current subscription. - - - - - Get - AzureSqlServerActiveDirectoryAdministrator - - - - The Get-AzureRMSqlServerActiveDirectoryAdministrator cmdlet returns information about an Azure Active Directory administrator for Azure SQL Server in the current subscription. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlServerActiveDirectoryAdministrator - - ServerName - - The name of the Azure SQL Server containing the Azure Active Directory administrator. - - String - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - ServerName - - The name of the Azure SQL Server containing the Azure Active Directory administrator. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - - System.String - - - - - - - - OutputType - - - - - - System.Object - - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example 1 -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlServerActiveDirectoryAdministrator –ResourceGroupName "Group-23" –ServerName "aad-managed-demo" - - Returns information about an Azure Active Directory administrator for Azure SQL Database Server "aad_managed_demo" associated with resource group "Group-23" - - - - ResourceGroupName ServerName DisplayName ObjectId - ----------------- ---------- ----------- -------- - Group-23 aad-managed-demo DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b - - - - - - - - - - - - - - Remove-AzureRMSqlServerActiveDirectoryAdministrator - - - - Set-AzureRMSqlServerActiveDirectoryAdministrator - - - - - - - - Get-AzureRMSqlDatabaseTransparentDataEncryption - - Gets the Transparent Data Encryption State for an Azure SQL Database. - - - - - Get - AzureSqlDatabaseTransparentDataEncryption - - - - Use this cmdlet to retrieve the Transparent Data Encryption state from an Azure SQL Database. Use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database. The return object indicates encryption state of the Azure SQL database, and reflects the state last set by the user. When the state is "Enabled" the Azure SQL Database can still be encrypting as encryption can be a long running asynchronous job. When the state is "Disabled" the Azure SQL Database can still be decrypting because this is a long running asynchronous job. To view the encryption scan progress please use Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlDatabaseTransparentDataEncryption - - ServerName - - The name of the Azure SQL Database Server the database is in. - - String - - - DatabaseName - - The name of the Azure SQL Database to retrieve. - - String - - - ResourceGroupName - - The name of the resource group of the server containing the database to retrieve. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - ServerName - - The name of the Azure SQL Database Server the database is in. - - String - - String - - - - - - DatabaseName - - The name of the Azure SQL Database to retrieve. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group of the server containing the database to retrieve. - - String - - String - - - - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - - - - - - - InputType - - - - - - - - - - - - - OutputType - - - - - - Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel - - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example 1 -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlDatabaseTransparentDataEncryption –ResourceGroupName "resourcegroup1" –ServerName "server1" –DatabaseName "database1" - - This example returns the transparent database encryption state for the database named "database1", from server "server1". - - - - PS C:\>Get-AzureRMSqlDatabaseTransparentDataEncryption –ResourceGroupName "resourcegroup1" –ServerName "server1" –DatabaseName "database1" - - ResourceGroupName ServerName DatabaseName State - ----------------- ---------- ------------ ----- - resourcegroup1 server1 database1 Disabled - - - - - - - - - - - - - - Transparent Data Encryption with Azure SQL Database - https://msdn.microsoft.com/library/dn948096 - - - - - - - Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity - - Gets the status of the Transparent Data Encryption Scan for an Azure SQL Database. - - - - - Get - AzureSqlDatabaseTransparentDataEncryptionActivity - - - - The Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity Cmdlet gets the Transparent Data Encryption scan progress of an Azure SQL Database. Use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the Azure SQL Database. The return object indicates if the Azure SQL Database is encrypting/decrypting, and what percentage is complete. If no encryption scan is occurring on the Azure SQL Database an empty list will be returned. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity - - ServerName - - The name of the Azure SQL Database Server the database is in. - - String - - - DatabaseName - - The name of the Azure SQL Database to retrieve. - - String - - - ResourceGroupName - - The name of the resource group of the server containing the database to retrieve. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - ServerName - - The name of the Azure SQL Database Server the database is in. - - String - - String - - - - - - DatabaseName - - The name of the Azure SQL Database to retrieve. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group of the server containing the database to retrieve. - - String - - String - - - - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - - - - - - - InputType - - - - - - - - - - - - - OutputType - - - - - - Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionActivityModel - - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example 1 -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity –ResourceGroupName "resourcegroup1" –ServerName "server1" –DatabaseName "database1" - - This example returns the transparent database encryption scan progress for the database named "database1", from server "server1". - - - - PS C:\>Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity –ResourceGroupName "resourcegroup1" –ServerName "server1" –DatabaseName "database1" - - - ResourceGroupName : resourcegroup1 - ServerName : server1 - DatabaseName : database1 - Status : Encrypting - PercentComplete : 3.662109 - - - - - - - - - - - - - - Transparent Data Encryption with Azure SQL Database - https://msdn.microsoft.com/library/dn948096 - - - - - - - Get-AzureRMSqlElasticPool - - Gets the details for an Azure SQL elastic database pool. - - - - - Get - AzureSqlElasticPool - - - - Gets all elastic pools and their property values, or pass the name of an existing elastic pool and return only the property values for that pool. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlElasticPool - - ElasticPoolName - - The name of the Azure SQL elastic pool to retrieve. - - String - - - ServerName - - The name of the Azure SQL Server containing the elastic pool. - - String - - - ResourceGroupName - - The name of the resource group of the server containing the elastic pool. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - ElasticPoolName - - The name of the Azure SQL elastic pool to retrieve. - - String - - String - - - none - - - ServerName - - The name of the Azure SQL Server containing the elastic pool. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group of the server containing the elastic pool. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example 1 -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlElasticPool –ResourceGroupName "resourcegroup1" –ServerName "server1" - - This example returns all elastic pools on "server1". - - - - - - - - - - - - - - -------------------------- Example 2 -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlElasticPool –ResourceGroupName "resourcegroup1" –ServerName "server1" –ElasticPoolName "elasticpool1" - - This example returns the elastic pool named "elasticpool1" on "server1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - New-AzureRMSqlElasticPool - - - - Remove-AzureRMSqlElasticPool - - - - Set-AzureRMSqlElasticPool - - - - - - - - Get-AzureRMSqlElasticPoolActivity - - Gets the status of elastic database pool operations. - - - - - Get - AzureSqlElasticPoolActivity - - - - Provides the status of elastic pool operations including pool creation and configuration updates. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlElasticPoolActivity - - ServerName - - The name of the Azure SQL Server that the elastic pool is in. - - String - - - ElasticPoolName - - The name of the Azure SQL elastic pool. - - String - - - ResourceGroupName - - The name of the resource group containing the elastic pool. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - ServerName - - The name of the Azure SQL Server that the elastic pool is in. - - String - - String - - - none - - - ElasticPoolName - - The name of the Azure SQL elastic pool. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the elastic pool. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlElasticPoolActivity –ResourceGroupName "resourcegroup1" –ServerName "server1" –ElasticPoolName "elasticpool1" - - The following example returns the operation status for the elastic pool named "elasticpool1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlElasticPool - - - - Get-AzureRMSqlElasticPoolDatabase - - - - Get-AzureRMSqlDatabaseActivity - - - - New-AzureRMSqlElasticPool - - - - Remove-AzureRMSqlElasticPool - - - - Set-AzureRMSqlElasticPool - - - - - - - - Get-AzureRMSqlElasticPoolDatabase - - Returns one or all elastic databases in an elastic database pool. - - - - - Get - AzureSqlElasticPoolDatabase - - - - Returns all elastic databases in an elastic pool and their property values, or provide the name of an elastic database and return only the property values for that database. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlElasticPoolDatabase - - ElasticPoolName - - The name of the Azure SQL elastic pool to retrieve. - - String - - - DatabaseName - - The name of the Azure SQL Database to retrieve. - - String - - - ServerName - - The name of the Azure SQL Server that the elastic pool is in. - - String - - - ResourceGroupName - - The name of the resource group of the server containing the elastic pool. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - ElasticPoolName - - The name of the Azure SQL elastic pool to retrieve. - - String - - String - - - none - - - DatabaseName - - The name of the Azure SQL Database to retrieve. - - String - - String - - - none - - - ServerName - - The name of the Azure SQL Server that the elastic pool is in. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group of the server containing the elastic pool. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlElasticPoolDatabase –ResourceGroupName "resourcegroup1" –ServerName "server1" –ElasticPoolName "elasticpool1" - - This example returns all databases in an elastic pool named "elasticpool1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlElasticPool - - - - Get-AzureRMSqlElasticPoolActivity - - - - Get-AzureRMSqlDatabaseActivity - - - - New-AzureRMSqlElasticPool - - - - Remove-AzureRMSqlElasticPool - - - - Set-AzureRMSqlElasticPool - - - - - - - - Get-AzureRMSqlElasticPoolRecommendation - - - - - - - Get - AzureSqlElasticPoolRecommendation - - - - - - - - Get-AzureRMSqlElasticPoolRecommendation - - ElasticPoolRecommendation - - - - String - - - ServerName - - - - String - - - ResourceGroupName - - - - String - - - Profile - - - - AzureProfile - - - - - - ElasticPoolRecommendation - - - - String - - String - - - - - - ServerName - - - - String - - String - - - - - - ResourceGroupName - - - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Get-AzureRMSqlElasticPoolRecommendationDatabase - - - - - - - Get - AzureSqlElasticPoolRecommendationDatabase - - - - - - - - Get-AzureRMSqlElasticPoolRecommendationDatabase - - ElasticPoolRecommendation - - - - String - - - DatabaseName - - - - String - - - ServerName - - - - String - - - ResourceGroupName - - - - String - - - Profile - - - - AzureProfile - - - - - - ElasticPoolRecommendation - - - - String - - String - - - - - - DatabaseName - - - - String - - String - - - - - - ServerName - - - - String - - String - - - - - - ResourceGroupName - - - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Get-AzureRMSqlElasticPoolRecommendationMetrics - - - - - - - Get - AzureSqlElasticPoolRecommendationMetrics - - - - - - - - Get-AzureRMSqlElasticPoolRecommendationMetrics - - ElasticPoolRecommendation - - - - String - - - ServerName - - - - String - - - ResourceGroupName - - - - String - - - Profile - - - - AzureProfile - - - - - - ElasticPoolRecommendation - - - - String - - String - - - - - - ServerName - - - - String - - String - - - - - - ResourceGroupName - - - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Get-AzureRMSqlServer - - Returns information about one or more Azure SQL Database Servers. - - - - - Get - AzureSqlServer - - - - If a SQL Database Server name is specified in the ServerName parameter, the cmdlet returns information about the specific SQL Database Server. Otherwise, it returns information about all the SQL Database Servers. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlServer - - ServerName - - The name of the Azure SQL Server to retrieve. - - String - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - ServerName - - The name of the Azure SQL Server to retrieve. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlServer –ResourceGroupName "resourcegroup1" –ServerName "server1" - - Use this cmdlet to retrieve an Azure SQL Database Server named "server1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Get-AzureRMSqlServerFirewallRule - - Returns firewall rules for an Azure SQL Server. - - - - - Get - AzureSqlServerFirewallRule - - - - If a firewall rule name is specified in the FirewallRuleName parameter, the cmdlet returns information about the specific firewall rule. Otherwise, information about all the firewall rules in the specified Azure SQL Server are listed. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlServerFirewallRule - - FirewallRuleName - - The name of the firewall rule to retrieve. If not specified, information about all the firewall rules in the specified Azure SQL Server is listed. - - String - - - ServerName - - The name of the Azure SQL Server for which you want to retrieve the firewall rules. Specify only the server name, and not the fully qualified DNS name. - - String - - - ResourceGroupName - - The name of the resource group of the Azure SQL Server containing the firewall rules to retrieve. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - FirewallRuleName - - The name of the firewall rule to retrieve. If not specified, information about all the firewall rules in the specified Azure SQL Server is listed. - - String - - String - - - none - - - ServerName - - The name of the Azure SQL Server for which you want to retrieve the firewall rules. Specify only the server name, and not the fully qualified DNS name. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group of the Azure SQL Server containing the firewall rules to retrieve. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlServerFirewallRule –ResourceGroupName "resourcegroup1" –ServerName "server1" - - Code Example Description - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Get-AzureRMSqlServerServiceObjective - - Returns a list of service objectives for an Azure SQL Server. - - - - - Get - AzureSqlServerServiceObjective - - - - Returns available service objectives for an Azure SQL Server. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlServerServiceObjective - - ServiceObjectiveName - - The Azure SQL Database service objective name. - - String - - - ServerName - - The name of the Azure SQL Server. - - String - - - DatabaseName - - The name of the Azure SQL Database. - - String - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - ServiceObjectiveName - - The Azure SQL Database service objective name. - - String - - String - - - none - - - ServerName - - The name of the Azure SQL Server. - - String - - String - - - none - - - DatabaseName - - The name of the Azure SQL Database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlServerServiceObjective –ResourceGroupName "resourcegroup1" –ServerName "server1" –DatabaseName "database1" - - The following example returns the service objective. - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Get-AzureRMSqlServerUpgrade - - - - - - - Get - AzureSqlServerUpgrade - - - - - - - - Get-AzureRMSqlServerUpgrade - - ServerName - - - - String - - - ResourceGroupName - - - - String - - - Profile - - - - AzureProfile - - - - - - ServerName - - - - String - - String - - - - - - ResourceGroupName - - - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - New-AzureRMSqlDatabase - - Creates a new Azure SQL Database, or new elastic database. - - - - - New - AzureSqlDatabase - - - - - The New-AzureRMSqlDatabase cmdlet creates a new Azure SQL Database. - Create an elastic database by setting the ElasticPoolName to an existing elastic pool. - - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - New-AzureRMSqlDatabase - - DatabaseName - - The name of the Azure SQL Database to create. - - String - - - CollationName - - The name of the Azure SQL Database collation to use. - - String - - - CatalogCollation - - The name of the Azure SQL Database catalog collation to use. - - String - - - MaxSizeBytes - - The maximum size of the Azure SQL Database in bytes. - - Int64 - - - Edition - - The edition to assign to the Azure SQL Database. - - DatabaseEdition - - - RequestedServiceObjectiveName - - The name of the service objective to assign to the Azure SQL Database. - - String - - - ElasticPoolName - - The name of the elastic pool to put the database in. - - String - - - Tags - - The tags to associate to the Azure SQL Database Server. - - Dictionary`2[String] - - - ServerName - - Name of the Azure SQL Server to create the database in. - - String - - - ResourceGroupName - - Name of resource group that the Azure SQL Server is in. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - DatabaseName - - The name of the Azure SQL Database to create. - - String - - String - - - none - - - CollationName - - The name of the Azure SQL Database collation to use. - - String - - String - - - none - - - CatalogCollation - - The name of the Azure SQL Database catalog collation to use. - - String - - String - - - none - - - MaxSizeBytes - - The maximum size of the Azure SQL Database in bytes. - - Int64 - - Int64 - - - none - - - Edition - - The edition to assign to the Azure SQL Database. - - DatabaseEdition - - DatabaseEdition - - - none - - - RequestedServiceObjectiveName - - The name of the service objective to assign to the Azure SQL Database. - - String - - String - - - none - - - ElasticPoolName - - The name of the elastic pool to put the database in. - - String - - String - - - none - - - Tags - - The tags to associate to the Azure SQL Database Server. - - Dictionary`2[String] - - Dictionary`2[String] - - - none - - - ServerName - - Name of the Azure SQL Server to create the database in. - - String - - String - - - none - - - ResourceGroupName - - Name of resource group that the Azure SQL Server is in. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example 1 -------------------------- - - PS C:\> - - PS C:\>New-AzureRMSqlDatabase –ResourceGroupName "resourceGroup1" –ServerName "server1" –DatabaseName "db1" - - The following command creates a database named "db1" in server "Server1". - - - - - - - - - - - - - - -------------------------- Example 2 -------------------------- - - PS C:\> - - PS C:\>New-AzureRMSqlDatabase -ResourceGroupName "resourcegroup1" -ServerName "server1" -DatabaseName "database1" -ElasticPoolName "elasticpool1" - - The following command creates a database named "database1" in the elastic pool named "elasticpool1" in server "server1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - New-AzureRMSqlServer - - - - New-AzureRMSqlElasticPool - - - - - - - - New-AzureRMSqlDatabaseDataMaskingRule - - Creates a new Azure SQL Database's data masking rule. - - - - - New - AzureSqlDatabaseDataMaskingRule - - - - The Set-SetAzureSqlDatabaseDataMaskingRule cmdlet is used to set the properties of an already exisiting data masking rule of an Azure SQL database. To use the cmdlet, use the ResourceGroupName, ServerName, DatabaseName and Rule parameters to identify the rule. Use either the TableName and ColumnName or the AliasName to specify thetarget of the rule and the MaskingFunction parameter to define how the data is masked. If the command succeeds and the PassThru switch is on, it returns an object describing the data masking rule as well as the database identifiers (ResourceGroupName, ServerName and DatabaseName) - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - New-AzureRMSqlDatabaseDataMaskingRule - - MaskingFunction - - Specifies the masking function to be used (defaults to 'Default'). Valid values are: Default, NoMasking, Text, Number, SocialSecurityNumber, CreditCardNumber, Email. - - String - - - TableName - - The name of the table in the database to apply the rule. - - String - - - ColumnName - - The name of the column that is the target of this masking rule. - - String - - - PrefixSize - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the beginning of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - - ReplacementString - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - String - - - SuffixSize - - When setting the MaskingFunction to be 'Text', the SuffixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - - NumberFrom - - When setting the MaskingFunction to be 'Text', the ReplacementString represents the text that acts as a mask. - - Nullable`1[Double] - - - NumberTo - - When setting the MaskingFunction to be 'Number', the NumberFrom represents the upper bound of the interval from which a random value is selected, defaults to 0. - - Nullable`1[Double] - - - PassThru - - Returns an object describing the data masking rule as well as the rule's identifiers (i.e. ResourceGroupName, ServerName, DatabaseName, RuleId and either TableName and ColumnName or the AliasName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - RuleId - - The identifier for this data masking rule. - - String - - - ServerName - - The name of the server containing the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - New-AzureRMSqlDatabaseDataMaskingRule - - MaskingFunction - - Specifies the masking function to be used (defaults to 'Default'). Valid values are: Default, NoMasking, Text, Number, SocialSecurityNumber, CreditCardNumber, Email. - - String - - - AliasName - - The name of the alias that is the target of this masking rule. - - String - - - PrefixSize - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the beginning of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - - ReplacementString - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - String - - - SuffixSize - - When setting the MaskingFunction to be 'Text', the SuffixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - - NumberFrom - - When setting the MaskingFunction to be 'Text', the ReplacementString represents the text that acts as a mask. - - Nullable`1[Double] - - - NumberTo - - When setting the MaskingFunction to be 'Number', the NumberFrom represents the upper bound of the interval from which a random value is selected, defaults to 0. - - Nullable`1[Double] - - - PassThru - - Returns an object describing the data masking rule as well as the rule's identifiers (i.e. ResourceGroupName, ServerName, DatabaseName, RuleId and either TableName and ColumnName or the AliasName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - RuleId - - The identifier for this data masking rule. - - String - - - ServerName - - The name of the server containing the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - MaskingFunction - - Specifies the masking function to be used (defaults to 'Default'). Valid values are: Default, NoMasking, Text, Number, SocialSecurityNumber, CreditCardNumber, Email. - - String - - String - - - none - - - TableName - - The name of the table in the database to apply the rule. - - String - - String - - - none - - - ColumnName - - The name of the column that is the target of this masking rule. - - String - - String - - - none - - - PrefixSize - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the beginning of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - Nullable`1[UInt32] - - - none - - - ReplacementString - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - String - - String - - - none - - - SuffixSize - - When setting the MaskingFunction to be 'Text', the SuffixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - Nullable`1[UInt32] - - - none - - - NumberFrom - - When setting the MaskingFunction to be 'Text', the ReplacementString represents the text that acts as a mask. - - Nullable`1[Double] - - Nullable`1[Double] - - - none - - - NumberTo - - When setting the MaskingFunction to be 'Number', the NumberFrom represents the upper bound of the interval from which a random value is selected, defaults to 0. - - Nullable`1[Double] - - Nullable`1[Double] - - - none - - - PassThru - - Returns an object describing the data masking rule as well as the rule's identifiers (i.e. ResourceGroupName, ServerName, DatabaseName, RuleId and either TableName and ColumnName or the AliasName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - RuleId - - The identifier for this data masking rule. - - String - - String - - - none - - - ServerName - - The name of the server containing the database. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - AliasName - - The name of the alias that is the target of this masking rule. - - String - - String - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-Help New-AzureRMSqlDatabaseDataMaskingRule - - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - New-AzureRMSqlElasticPool - - Creates a new Azure SQL Database elastic database pool. - - - - - New - AzureSqlElasticPool - - - - This cmdlet creates a new elastic database pool. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - New-AzureRMSqlElasticPool - - ElasticPoolName - - The name of the Azure SQL elastic pool to create. - - String - - - Edition - - - The edition to assign to the Azure SQL elastic pool. - For the current preview, the edition must be "Standard". - - - DatabaseEdition - - - Dtu - - The total shared DTU for the Azure SQL elastic pool. - - Int32 - - - StorageMB - - The storage limit for the Azure SQL elastic pool in MB. - - Int64 - - - DatabaseDtuMin - - The minimum DTU that all Azure SQL Databases in the pool are guaranteed to have available. - - Int32 - - - DatabaseDtuMax - - The maximum DTU that any one Azure SQL Database in the pool can consume. - - Int32 - - - Tags - - The tags to associate with the Azure SQL elastic pool. - - Dictionary`2[String] - - - ServerName - - Name of the Azure SQL Server to create the elastic pool in. - - String - - - ResourceGroupName - - Name of resource group containing the Azure SQL Server to create the elastic pool in. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - ElasticPoolName - - The name of the Azure SQL elastic pool to create. - - String - - String - - - none - - - Edition - - - The edition to assign to the Azure SQL elastic pool. - For the current preview, the edition must be "Standard". - - - DatabaseEdition - - DatabaseEdition - - - none - - - Dtu - - The total shared DTU for the Azure SQL elastic pool. - - Int32 - - Int32 - - - none - - - StorageMB - - The storage limit for the Azure SQL elastic pool in MB. - - Int64 - - Int64 - - - none - - - DatabaseDtuMin - - The minimum DTU that all Azure SQL Databases in the pool are guaranteed to have available. - - Int32 - - Int32 - - - none - - - DatabaseDtuMax - - The maximum DTU that any one Azure SQL Database in the pool can consume. - - Int32 - - Int32 - - - none - - - Tags - - The tags to associate with the Azure SQL elastic pool. - - Dictionary`2[String] - - Dictionary`2[String] - - - none - - - ServerName - - Name of the Azure SQL Server to create the elastic pool in. - - String - - String - - - none - - - ResourceGroupName - - Name of resource group containing the Azure SQL Server to create the elastic pool in. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example -------------------------- - - PS C:\> - - PS C:\>New-AzureRMSqlElasticPool -ResourceGroupName "resourcegroup1" -ServerName "server1" -ElasticPoolName "elasticpool1" -Edition "Standard" -Dtu 400 -DatabaseDtuMin 10 -DatabaseDtuMax 100 - - The following command creates an elastic pool in the Standard service tier named "elasticpool1" in the server named "server1" within an Azure resource group named "resourcegroup1", and specifies DTU property values for the pool and it’s databases. - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlElasticPool - - - - Get-AzureRMSqlElasticPoolActivity - - - - Get-AzureRMSqlElasticPoolDatabase - - - - Get-AzureRMSqlDatabaseActivity - - - - Remove-AzureRMSqlElasticPool - - - - Set-AzureRMSqlElasticPool - - - - - - - - New-AzureRMSqlServer - - Creates a new Azure SQL Database server. - - - - - New - AzureSqlServer - - - - The New-AzureRMSqlDatabaseServer cmdlet creates a new Azure SQL server. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - New-AzureRMSqlServer - - ServerName - - The name of the new Azure SQL Server to create. - - String - - - SqlAdminCredentials - - The SQL administrator credentials for the new server. - - PSCredential - - - Location - - The data center location where the Azure SQL Server will be created. - - String - - - Tags - - The tags to associate with the Azure SQL Server. - - Dictionary`2[String] - - - ServerVersion - - The version of the new Azure SQL Server. Valid values are 2.0, or 12.0. - Use 2.0 to create a V11 server, or 12.0 to create a V11 server. - - String - - - ResourceGroupName - - The name of the resource group to create the Azure SQL Server in. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - ServerName - - The name of the new Azure SQL Server to create. - - String - - String - - - none - - - SqlAdminCredentials - - The SQL administrator credentials for the new server. - - PSCredential - - PSCredential - - - none - - - Location - - The data center location where the Azure SQL Server will be created. - - String - - String - - - none - - - Tags - - The tags to associate with the Azure SQL Server. - - Dictionary`2[String] - - Dictionary`2[String] - - - none - - - ServerVersion - - The version of the new Azure SQL Server. Valid values are 2.0, or 12.0. - Use 2.0 to create a V11 server, or 12.0 to create a V11 server. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group to create the Azure SQL Server in. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>New-AzureRMSqlServer -ResourceGroupName "resourcegroup1" -ServerName "server1" -Location "West US" -ServerVersion "12.0" - - This command creates a new Azure SQL V12 Server. - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlServer - - - - Remove-AzureRMSqlServer - - - - Set-AzureRMSqlServer - - - - New-AzureRMSqlServerFirewallRule - - - - - - - - New-AzureRMSqlServerFirewallRule - - - - - - - New - AzureSqlServerFirewallRule - - - - - - - - New-AzureRMSqlServerFirewallRule - - FirewallRuleName - - - - String - - - StartIpAddress - - - - String - - - EndIpAddress - - - - String - - - ServerName - - - - String - - - ResourceGroupName - - - - String - - - Profile - - - - AzureProfile - - - - New-AzureRMSqlServerFirewallRule - - AllowAllAzureIPs - - - - SwitchParameter - - - ServerName - - - - String - - - ResourceGroupName - - - - String - - - Profile - - - - AzureProfile - - - - - - FirewallRuleName - - - - String - - String - - - - - - StartIpAddress - - - - String - - String - - - - - - EndIpAddress - - - - String - - String - - - - - - ServerName - - - - String - - String - - - - - - ResourceGroupName - - - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - AllowAllAzureIPs - - - - SwitchParameter - - SwitchParameter - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Remove-AzureRMSqlDatabase - - Deletes an Azure SQL Database. - - - - - Remove - AzureSqlDatabase - - - - The Remove-AzureRMSqlDatabase cmdlet deletes an Azure SQL Database. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Remove-AzureRMSqlDatabase - - DatabaseName - - The name of the Azure SQL Database to remove. - - String - - - Force - - Skip confirmation message for performing this action. - - SwitchParameter - - - ServerName - - The name of the Azure SQL Server the database is in. - - String - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server that contains the Azure SQL Database to remove. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - WhatIf - - - - SwitchParameter - - - Confirm - - - - SwitchParameter - - - - - - DatabaseName - - The name of the Azure SQL Database to remove. - - String - - String - - - none - - - Force - - Skip confirmation message for performing this action. - - SwitchParameter - - SwitchParameter - - - none - - - ServerName - - The name of the Azure SQL Server the database is in. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server that contains the Azure SQL Database to remove. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - WhatIf - - - - SwitchParameter - - SwitchParameter - - - - - - Confirm - - - - SwitchParameter - - SwitchParameter - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example 1 -------------------------- - - PS C:\> - - PS C:\>Remove-AzureRMSqlDatabase –ResourceGroupName "resourcegroup1" –ServerName "server1" –DatabaseName "database1" - - The following code example deletes an Azure SQL Database. - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Remove-AzureRMSqlDatabaseAuditing - - Disables an Azure Sql database's auditing. - - - - - Remove - AzureSqlDatabaseAuditing - - - - The Remove-AzureRMSqlDatabaseAuditing cmdlet disables the auditing of an Azure SQL Database. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database.After the successful execution of the cmdlet, auditing of the database is disabled. If the command succeeds and the PassThru switch is on, it returns an object describing the current auditing policy used as well as the database identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Remove-AzureRMSqlDatabaseAuditing - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - ServerName - - The name of the server containing the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - ServerName - - The name of the server containing the database. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-Help Remove-AzureRMSqlDatabaseAuditing - - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Remove-AzureRMSqlDatabaseDataMaskingRule - - Removes an Azure SQL Database's data masking rule. - - - - - Remove - AzureSqlDatabaseDataMaskingRule - - - - The Remove-AzureRMSqlDatabaseDataMaskingRule cmdlet removes a specific data masking rule. To use the cmdlet, use the ResourceGroupName, ServerName, DatabaseName and RuleId parameters to identify the rule to be removed. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Remove-AzureRMSqlDatabaseDataMaskingRule - - PassThru - - Returns an object describing the data masking rule as well as the rule's identifiers (i.e. ResourceGroupName, ServerName, DatabaseName, RuleId and either TableName and ColumnName or the AliasName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - Force - - Allows the action to complete without prompting you for confirmation. - - SwitchParameter - - - RuleId - - The identifier for the data masking rule. - - String - - - ServerName - - The name of the server containing the database. - - String - - - DatabaseName - - Thhhe name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - WhatIf - - - - SwitchParameter - - - Confirm - - - - SwitchParameter - - - - - - PassThru - - Returns an object describing the data masking rule as well as the rule's identifiers (i.e. ResourceGroupName, ServerName, DatabaseName, RuleId and either TableName and ColumnName or the AliasName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - Force - - Allows the action to complete without prompting you for confirmation. - - SwitchParameter - - SwitchParameter - - - none - - - RuleId - - The identifier for the data masking rule. - - String - - String - - - none - - - ServerName - - The name of the server containing the database. - - String - - String - - - none - - - DatabaseName - - Thhhe name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - WhatIf - - - - SwitchParameter - - SwitchParameter - - - - - - Confirm - - - - SwitchParameter - - SwitchParameter - - - - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.Cmdlet Remark - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-Help Remove-AzureRMSqlDatabaseDataMaskingRule - - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Remove-AzureRMSqlServerAuditing - - Disables auditing of all the databases that rely on the auditing policy of the given database server. - - - - - Remove - AzureSqlDatabaseServerAuditing - - - - The Remove-AzureRMSqlServerAuditing cmdlet disables auditing of all the databases that rely on the auditing policy of the given database server. To use the cmdlet, use the ResourceGroupName and ServerName parameters to identify the database server. After the successful execution of the cmdlet, auditing of the database is disabled. If the command succeeds and the PassThru switch is on, it returns an object describing the current auditing policy used as well as the database server identifiers (i.e. ResourceGroupName and ServerName) - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Remove-AzureRMSqlServerAuditing - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - ServerName - - The name of the server. - - String - - - ResourceGroupName - - The name of the resource group containing the server. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - ServerName - - The name of the server. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the server. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-Help Remove-AzureRMSqlServerAuditing -Full - - Code Example Description - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Remove-AzureRMSqlElasticPool - - Deletes an Azure SQL elastic database pool. - - - - - Remove - AzureSqlElasticPool - - - - The Remove-AzureRMSqlElasticPool cmdlet deletes an elastic pool. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Remove-AzureRMSqlElasticPool - - ElasticPoolName - - The name of the elastic pool to delete. - - String - - - Force - - Skip confirmation message for performing this action. - - SwitchParameter - - - ServerName - - Name of the Azure SQL Server containing the elastic pool to remove. - - String - - - ResourceGroupName - - Name of resource group of the Azure SQL Server containing the elastic pool to remove. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - WhatIf - - - - SwitchParameter - - - Confirm - - - - SwitchParameter - - - - - - ElasticPoolName - - The name of the elastic pool to delete. - - String - - String - - - none - - - Force - - Skip confirmation message for performing this action. - - SwitchParameter - - SwitchParameter - - - none - - - ServerName - - Name of the Azure SQL Server containing the elastic pool to remove. - - String - - String - - - none - - - ResourceGroupName - - Name of resource group of the Azure SQL Server containing the elastic pool to remove. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - WhatIf - - - - SwitchParameter - - SwitchParameter - - - - - - Confirm - - - - SwitchParameter - - SwitchParameter - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example -------------------------- - - PS C:\> - - PS C:\>Remove-AzureRMSqlElasticPool –ResourceGroupName "resourcegroup1" –ServerName "server1" –ElasticPoolName "elasticpool1" - - The following command deletes an elastic pool named "elasticpool1": - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlElasticPool - - - - Get-AzureRMSqlElasticPoolActivity - - - - Get-AzureRMSqlElasticPoolDatabase - - - - Get-AzureRMSqlDatabaseActivity - - - - New-AzureRMSqlElasticPool - - - - Set-AzureRMSqlElasticPool - - - - - - - - Remove-AzureRMSqlServer - - Removes an Azure SQL Server. - - - - - Remove - AzureSqlServer - - - - The Remove-AzureRMSqlServer cmdlet removes an Azure SQL Server. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Remove-AzureRMSqlServer - - ServerName - - The name of the Azure SQL Server to remove. - - String - - - Force - - Skip confirmation message and remove the Azure SQL Server. - - SwitchParameter - - - ResourceGroupName - - The name of the resource group that contains the Azure SQL Server to remove. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - WhatIf - - - - SwitchParameter - - - Confirm - - - - SwitchParameter - - - - - - ServerName - - The name of the Azure SQL Server to remove. - - String - - String - - - none - - - Force - - Skip confirmation message and remove the Azure SQL Server. - - SwitchParameter - - SwitchParameter - - - none - - - ResourceGroupName - - The name of the resource group that contains the Azure SQL Server to remove. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - WhatIf - - - - SwitchParameter - - SwitchParameter - - - - - - Confirm - - - - SwitchParameter - - SwitchParameter - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Remove-AzureRMSqlServer –ResourceGroupName "resourcegroup1" –ServerName "server1" - - The following example removes "server1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Remove-AzureRMSqlServerActiveDirectoryAdministrator - - Removes an Azure Active Directory administrator for Azure SQL Server in the current subscription. - - - - - Remove - AzureSqlServerActiveDirectoryAdministrator - - - - The Remove-AzureRMSqlServerActiveDirectoryAdministrator cmdlet removes an Azure Active Directory administrator for Azure SQL Server in the current subscription. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Remove-AzureRMSqlServerActiveDirectoryAdministrator - - Force - - Skip confirmation message and remove the Azure SQL Server. - - SwitchParameter - - - ServerName - - The name of the Azure SQL Server to remove. - - String - - - ResourceGroupName - - The name of the resource group that contains the Azure SQL Server to remove. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - WhatIf - - - - SwitchParameter - - - Confirm - - - - SwitchParameter - - - - - - Force - - Skip confirmation message and remove the Azure SQL Server. - - SwitchParameter - - SwitchParameter - - - none - - - ServerName - - The name of the Azure SQL Server to remove. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group that contains the Azure SQL Server to remove. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - WhatIf - - - - SwitchParameter - - SwitchParameter - - - - - - Confirm - - - - SwitchParameter - - SwitchParameter - - - - - - - - - InputType - - - - - - System.String - - - - - - - - OutputType - - - - - - System.Object - - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example 1 -------------------------- - - PS C:\> - - PS c:\> Remove-AzureRMSqlServerActiveDirectoryAdministrator -ResourceGroupName "Group-23" –ServerName "aad-managed-demo" - - This command removes an Azure Active Directory administrator for Azure SQL Database Server "aad_managed_demo" associated with resource group "Group-23" - - - - Confirm - Are you sure you want to remove the Azure Sql Server Active Directory Administrator on server 'aadtest'? - [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y - - ResourceGroupName ServerName DisplayName ObjectId - ----------------- ---------- ----------- -------- - Group-233 aad-managed-demo DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b - - - - - - - - - - - - - - Get-AzureRMSqlServerActiveDirectoryAdministrator - - - - Set-AzureRMSqlServerActiveDirectoryAdministrator - - - - - - - - Remove-AzureRMSqlServerFirewallRule - - Deletes a firewall rule from an Azure SQL Database Server. - - - - - Remove - AzureSqlServerFirewallRule - - - - The Remove-AzureRMSqlDatabaseServerFirewallRule cmdlet deletes a firewall rule from the specified SQL Database Server. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Remove-AzureRMSqlServerFirewallRule - - FirewallRuleName - - The SQL Database firewall rule name to be deleted. - - String - - - Force - - Allows the action to complete without prompting you for confirmation. - - SwitchParameter - - - ServerName - - The name of the server containing the firewall rule you want to delete. - - String - - - ResourceGroupName - - The name of the ARM resource group of the server containing the firewall rule you want to delete. - - String - - - Profile - - - - AzureProfile - - - WhatIf - - - - SwitchParameter - - - Confirm - - - - SwitchParameter - - - - - - FirewallRuleName - - The SQL Database firewall rule name to be deleted. - - String - - String - - - none - - - Force - - Allows the action to complete without prompting you for confirmation. - - SwitchParameter - - SwitchParameter - - - none - - - ServerName - - The name of the server containing the firewall rule you want to delete. - - String - - String - - - none - - - ResourceGroupName - - The name of the ARM resource group of the server containing the firewall rule you want to delete. - - String - - String - - - none - - - Profile - - - - AzureProfile - - AzureProfile - - - none - - - WhatIf - - - - SwitchParameter - - SwitchParameter - - - - - - Confirm - - - - SwitchParameter - - SwitchParameter - - - - - - - - - InputType - - - - - New InputType - - - - - - - OutputType - - - - - New OutputType - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Remove-AzureRMSqlServerFirewallRule –FirewallRuleName "rule1" –ResourceGroupName "resourcegroup1" –ServerName "server1" - - Code Example Description - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlServerFirewallRule - - - - New-AzureRMSqlServerFirewallRule - - - - Set-AzureRMSqlServerFirewallRule - - - - - - - - Set-AzureRMSqlDatabase - - Updates properties for an Azure SQL Database, or moves an existing database into an elastic pool. - - - - - Set - AzureSqlDatabase - - - - - The Set-AzureRMSqlDatabase cmdlet sets properties for an Azure SQL Database. - Set the ElasticPoolName parameter to move a database into an elastic pool. - - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Set-AzureRMSqlDatabase - - DatabaseName - - The name of the Azure SQL Database to modify. - - String - - - MaxSizeBytes - - If specified, the new maximum size for the database in bytes. You can specify either this parameter or MaxSizeGB. See the MaxSizeGB parameter for acceptable values based on edition. - - Int64 - - - Edition - - If specified, the new edition for the Azure SQL Database. - - DatabaseEdition - - - RequestedServiceObjectiveName - - The name of the service objective to assign to the Azure SQL Database. - - String - - - ElasticPoolName - - The name of the Azure SQL elastic pool to put the database in. - - String - - - Tags - - The tags to associate with the Azure SQL Database. - - Dictionary`2[String] - - - ServerName - - Name of the Azure SQL Server that contains the Azure SQL Database. - - String - - - ResourceGroupName - - Name of resource group of the Azure SQL Server that contains the Azure SQL Database. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - DatabaseName - - The name of the Azure SQL Database to modify. - - String - - String - - - none - - - MaxSizeBytes - - If specified, the new maximum size for the database in bytes. You can specify either this parameter or MaxSizeGB. See the MaxSizeGB parameter for acceptable values based on edition. - - Int64 - - Int64 - - - none - - - Edition - - If specified, the new edition for the Azure SQL Database. - - DatabaseEdition - - DatabaseEdition - - - none - - - RequestedServiceObjectiveName - - The name of the service objective to assign to the Azure SQL Database. - - String - - String - - - none - - - ElasticPoolName - - The name of the Azure SQL elastic pool to put the database in. - - String - - String - - - none - - - Tags - - The tags to associate with the Azure SQL Database. - - Dictionary`2[String] - - Dictionary`2[String] - - - none - - - ServerName - - Name of the Azure SQL Server that contains the Azure SQL Database. - - String - - String - - - none - - - ResourceGroupName - - Name of resource group of the Azure SQL Server that contains the Azure SQL Database. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example1 -------------------------- - - PS C:\> - - PS C:\>Set-AzureRMSqlDatabase –ResourceGroupName "resourcegroup1" –DatabaseName "database1" –ServerName "server1" –Edition "Standard" –RequestedServiceObjectiveName "S2" - - The following command updates a database named "database1" to a Standard S2 database. - - - - - - - - - - - - - - -------------------------- Example2 -------------------------- - - PS C:\> - - PS C:\>Set-AzureRMSqlDatabase –ResourceGroupName "resourcegroup1" –DatabaseName "database1" –ServerName "server1" –ElasticPoolName "elasticpool1" - - The following command adds a database named "database1" to the elastic pool named "elasticpool1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Set-AzureRMSqlDatabaseAuditingPolicy - - Sets an Azure SQL Database's auditing policy. - - - - - Set - AzureSqlDatabaseAuditingPolicy - - - - The Set-AzureRMSqlDatabaseAuditingPolicy cmdlet changes the auditing policy of an Azure SQL Database. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database, the StorageAccountName parameter to specify the storage account to be used for the audit logs and the EventType parameter to define which event types to audit. After the successful execution of the cmdlet, auditing of the database is enabled. These settings override the server default auditing policy. If the command succeeds and the PassThru switch is on, it returns an object describing the current auditing policy used as well as the database identifiers (ResourceGroupName, ServerName and DatabaseName) - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Set-AzureRMSqlDatabaseAuditingPolicy - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - EventType - - Specifies the event types to audit. Valid values are: DataAccess, DataChanges, SchemaChanges, SecurityExcceptions, RevokePermissions, All, None. - It is possible to specify several event types. You can specify 'All' to audit all of the event types or 'None' to specify that none of the events will be audited. Specifying 'All' or 'None' alongside other event types would result in failure to execute the cmdlet. - - String[] - - - StorageAccountName - - Specifies the name of the storage account to be used when auditing the database. Wildcards are not permitted.Note that this parameter is not required. When this parameter is not provided, the cmdlet would use the storage account that was defined previously as part of the auditing policy of the database. If this is the first time an auditing policy is defined for the database and this parameter is not provided, the cmdlet will fail. - - String - - - StorageKeyType - - Specifies which of the storage access keys to use (defaults to 'Primary'). Valid values are: Primary, Secondary. - - String - - - RetentionInDays - - - - Nullable`1[UInt32] - - - TableIdentifier - - - - String - - - ServerName - - The name of the server that contains the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group that contains the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - EventType - - Specifies the event types to audit. Valid values are: DataAccess, DataChanges, SchemaChanges, SecurityExcceptions, RevokePermissions, All, None. - It is possible to specify several event types. You can specify 'All' to audit all of the event types or 'None' to specify that none of the events will be audited. Specifying 'All' or 'None' alongside other event types would result in failure to execute the cmdlet. - - String[] - - String[] - - - none - - - StorageAccountName - - Specifies the name of the storage account to be used when auditing the database. Wildcards are not permitted.Note that this parameter is not required. When this parameter is not provided, the cmdlet would use the storage account that was defined previously as part of the auditing policy of the database. If this is the first time an auditing policy is defined for the database and this parameter is not provided, the cmdlet will fail. - - String - - String - - - none - - - StorageKeyType - - Specifies which of the storage access keys to use (defaults to 'Primary'). Valid values are: Primary, Secondary. - - String - - String - - - none - - - RetentionInDays - - - - Nullable`1[UInt32] - - Nullable`1[UInt32] - - - - - - TableIdentifier - - - - String - - String - - - - - - ServerName - - The name of the server that contains the database. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group that contains the database. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-Help Set-AzureRMSqlDatabaseAuditingPolicy -Full - - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Set-AzureRMSqlDatabaseDataMaskingPolicy - - Sets an Azure SQL Database's data masking policy. - - - - - Set - AzureSqlDatabaseDataMaskingPolicy - - - - The Set-AzureRMSqlDatabaseDataMaskingPolicy cmdlet changes the auditing policy of an Azure SQL Database. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database, the DataMaskingState parameter to specify whether data masking operations are enabled or disabled, the MaskingLevel parameter to define whether masking is done in standard or extended mode and the PrivilegedLogins parameter to specify which users are allowed to see the unmasked data. If the command succeeds and the PassThru switch is on, it returns an object describing the current data masking policy used as well as the database identifiers (ResourceGroupName, ServerName and DatabaseName) - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Set-AzureRMSqlDatabaseDataMaskingPolicy - - PassThru - - Returns an object describing the data masking policy as well as the database's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - PrivilegedLogins - - - - String - - - DataMaskingState - - Specifies whether data masking operation is enabled or disabled (defaults to 'Disabled'). Valid values are: Enabled, Disabled. - - String - - - MaskingLevel - - Specifies whether data masking operation is done in a standard or extended manner (defaults to 'Standard'). Valid values are: Standard, Extended. - - String - - - ServerName - - The name of the server containing the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - PassThru - - Returns an object describing the data masking policy as well as the database's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - PrivilegedLogins - - - - String - - String - - - none - - - DataMaskingState - - Specifies whether data masking operation is enabled or disabled (defaults to 'Disabled'). Valid values are: Enabled, Disabled. - - String - - String - - - none - - - MaskingLevel - - Specifies whether data masking operation is done in a standard or extended manner (defaults to 'Standard'). Valid values are: Standard, Extended. - - String - - String - - - none - - - ServerName - - The name of the server containing the database. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-Help Set-AzureRMSqlDatabaseDataMaskingPolicy -Full - - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Set-AzureRMSqlDatabaseDataMaskingRule - - Sets an Azure SQL Database's data masking rule. - - - - - Set - AzureSqlDatabaseDataMaskingRule - - - - The Set-SetAzureSqlDatabaseDataMaskingRule cmdlet is used to set the properties of an already exisiting data masking rule of an Azure SQL Database. To use the cmdlet, use the ResourceGroupName, ServerName, DatabaseName and Rule parameters to identify the rule. Use either the TableName and ColumnName or the AliasName to specify the target of the rule and the MaskingFunction parameter to define how the data is masked. If the command succeeds and the PassThru switch is on, it returns an object describing the data masking rule as well as the database identifiers (ResourceGroupName, ServerName and DatabaseName) - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Set-AzureRMSqlDatabaseDataMaskingRule - - MaskingFunction - - Specifies the masking function to be used (defaults to 'Default'). Valid values are: Default, NoMasking, Text, Number, SocialSecurityNumber, CreditCardNumber, Email. - - String - - - TableName - - The name of the table in the database that the masked column is part of. - - String - - - ColumnName - - The name of the column that is the target of this masking rule. - - String - - - PrefixSize - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the beginning of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - - ReplacementString - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - String - - - SuffixSize - - When setting the MaskingFunction to be 'Text', the SuffixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - - NumberFrom - - When setting the MaskingFunction to be 'Text', the ReplacementString represents the text that acts as a mask. - - Nullable`1[Double] - - - NumberTo - - When setting the MaskingFunction to be 'Number', the NumberFrom represents the upper bound of the interval from which a random value is selected, defaults to 0. - - Nullable`1[Double] - - - PassThru - - Returns an object describing the data masking rule as well as the rule's identifiers (i.e. ResourceGroupName, ServerName, DatabaseName, RuleId and either TableName and ColumnName or the AliasName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - RuleId - - The identifier for the data masking rule. - - String - - - ServerName - - The name of the server containing the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - Set-AzureRMSqlDatabaseDataMaskingRule - - MaskingFunction - - Specifies the masking function to be used (defaults to 'Default'). Valid values are: Default, NoMasking, Text, Number, SocialSecurityNumber, CreditCardNumber, Email. - - String - - - AliasName - - The name of the alias that is the target of this masking rule. - - String - - - PrefixSize - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the beginning of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - - ReplacementString - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - String - - - SuffixSize - - When setting the MaskingFunction to be 'Text', the SuffixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - - NumberFrom - - When setting the MaskingFunction to be 'Text', the ReplacementString represents the text that acts as a mask. - - Nullable`1[Double] - - - NumberTo - - When setting the MaskingFunction to be 'Number', the NumberFrom represents the upper bound of the interval from which a random value is selected, defaults to 0. - - Nullable`1[Double] - - - PassThru - - Returns an object describing the data masking rule as well as the rule's identifiers (i.e. ResourceGroupName, ServerName, DatabaseName, RuleId and either TableName and ColumnName or the AliasName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - RuleId - - The identifier for the data masking rule. - - String - - - ServerName - - The name of the server containing the database. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - MaskingFunction - - Specifies the masking function to be used (defaults to 'Default'). Valid values are: Default, NoMasking, Text, Number, SocialSecurityNumber, CreditCardNumber, Email. - - String - - String - - - none - - - TableName - - The name of the table in the database that the masked column is part of. - - String - - String - - - none - - - ColumnName - - The name of the column that is the target of this masking rule. - - String - - String - - - none - - - PrefixSize - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the beginning of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - Nullable`1[UInt32] - - - none - - - ReplacementString - - When setting the MaskingFunction to be 'Text', the PrefixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - String - - String - - - none - - - SuffixSize - - When setting the MaskingFunction to be 'Text', the SuffixSize represents the number of characters in the end of the text that are not masked, defaults to 0. - - Nullable`1[UInt32] - - Nullable`1[UInt32] - - - none - - - NumberFrom - - When setting the MaskingFunction to be 'Text', the ReplacementString represents the text that acts as a mask. - - Nullable`1[Double] - - Nullable`1[Double] - - - none - - - NumberTo - - When setting the MaskingFunction to be 'Number', the NumberFrom represents the upper bound of the interval from which a random value is selected, defaults to 0. - - Nullable`1[Double] - - Nullable`1[Double] - - - none - - - PassThru - - Returns an object describing the data masking rule as well as the rule's identifiers (i.e. ResourceGroupName, ServerName, DatabaseName, RuleId and either TableName and ColumnName or the AliasName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - RuleId - - The identifier for the data masking rule. - - String - - String - - - none - - - ServerName - - The name of the server containing the database. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the database. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - AliasName - - The name of the alias that is the target of this masking rule. - - String - - String - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-Help Set-AzureRMSqlDatabaseDataMaskingRule -Full - - Code Example Description - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Set-AzureRMSqlServerAuditingPolicy - - Sets an Azure SQL Database server's auditing policy. - - - - - Set - AzureSqlServerAuditingPolicy - - - - The Set-AzureRMSqlServerAuditingPolicy cmdlet changes the auditing policy of an Azure SQL Database server. To use the cmdlet, use the ResourceGroupName and ServerName parameters to identify the database server, the StorageAccountName parameter to specify the storage account to be used for the audit logs and the EventType parameter to define which event types to audit. The auditing policy of a database server apply to all the databases in this server that are marked as using the server's auditing policy, as well as all newly created databases.If the command succeeds and the PassThru switch is on, it returns an object describing the current auditing policy used as well as the server's identifiers (i.e. ResourceGroupName and ServerName). - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Set-AzureRMSqlServerAuditingPolicy - - PassThru - - Returns an object describing the auditing policy as well as the database server's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdletsucceeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - EventType - - Specifies the event types to audit. Valid values are: Default, DataAccess, DataChanges, SchemaChanges, SecurityExceptions, RevokePermissions, All, None. - It is possible to specify several event types. You can specify 'All' to audit all of the event types or 'None' to specify that none of the events will be audited. Specifying 'All' or 'None' alongside other event types would result in failure to execute the cmdlet. - - String[] - - - StorageAccountName - - Specifies the name of the storage account to be used when auditing the databases that rely on this server's auditing policy. Wildcards are not permitted.Note that this parameter is not required. When this parameter is not provided, the cmdlet would use the storage account that was defined previously as part of the auditing policy of the database. If this is the first time an auditing policy is defined for the database and this parameter is not provided, the cmdlet will fail. - - String - - - StorageKeyType - - The type of storage key. Valid values are: Primary, Secondary. - - String - - - RetentionInDays - - - - Nullable`1[UInt32] - - - TableIdentifier - - - - String - - - ServerName - - The name of the server. - - String - - - ResourceGroupName - - The name of the resource group that contains the server. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - PassThru - - Returns an object describing the auditing policy as well as the database server's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdletsucceeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - EventType - - Specifies the event types to audit. Valid values are: Default, DataAccess, DataChanges, SchemaChanges, SecurityExceptions, RevokePermissions, All, None. - It is possible to specify several event types. You can specify 'All' to audit all of the event types or 'None' to specify that none of the events will be audited. Specifying 'All' or 'None' alongside other event types would result in failure to execute the cmdlet. - - String[] - - String[] - - - none - - - StorageAccountName - - Specifies the name of the storage account to be used when auditing the databases that rely on this server's auditing policy. Wildcards are not permitted.Note that this parameter is not required. When this parameter is not provided, the cmdlet would use the storage account that was defined previously as part of the auditing policy of the database. If this is the first time an auditing policy is defined for the database and this parameter is not provided, the cmdlet will fail. - - String - - String - - - none - - - StorageKeyType - - The type of storage key. Valid values are: Primary, Secondary. - - String - - String - - - none - - - RetentionInDays - - - - Nullable`1[UInt32] - - Nullable`1[UInt32] - - - - - - TableIdentifier - - - - String - - String - - - - - - ServerName - - The name of the server. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group that contains the server. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-Help Set-AzureRMSqlServerAuditingPolicy - - Code Example Description - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Set-AzureRMSqlDatabaseTransparentDataEncryption - - Updates properties for Transparent Data Encryption for an Azure SQL Database. - - - - - Set - AzureSqlDatabaseTransparentDataEncryption - - - - The Set-SetAzureSqlDatabaseTransparentDataEncryption cmdlet is used to set the Transparent Data Encryption (TDE) property of an already existing Azure SQL database. Use the ResourceGroupName, ServerName, and DatabaseName. Use "Enabled" or "Disabled" to specify the target state of TDE for an Azure SQL Database. If the command succeeds and the PassThru switch is on, it returns an object describing the TDE state as well as the database identifiers (ResourceGroupName, ServerName and DatabaseName). - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Set-AzureRMSqlDatabaseTransparentDataEncryption - - State - - The state to set Transparent Data Encryption to for the Azure SQL Database. - - TransparentDataEncryptionStateType - - - ServerName - - The name of the Azure SQL Database Server the database is in. - - String - - - DatabaseName - - The name of the Azure SQL Database to retrieve. - - String - - - ResourceGroupName - - The name of the resource group of the server containing the database to retrieve. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - State - - The state to set Transparent Data Encryption to for the Azure SQL Database. - - TransparentDataEncryptionStateType - - TransparentDataEncryptionStateType - - - - - - ServerName - - The name of the Azure SQL Database Server the database is in. - - String - - String - - - - - - DatabaseName - - The name of the Azure SQL Database to retrieve. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group of the server containing the database to retrieve. - - String - - String - - - - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - - - - - - - InputType - - - - - - System.String - - - - - - - - OutputType - - - - - - Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel - - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example 1 -------------------------- - - PS C:\> - - PS C:\>Set-AzureRMSqlDatabaseTransparentDataEncryption –ResourceGroupName "resourcegroup1" –ServerName "server1" –DatabaseName "database1" -State Enabled - - The following command updates the transparent data encryption state for the Azure SQL database named "database1". - - - - PS C:\>Set-AzureRMSqlDatabaseTransparentDataEncryption –ResourceGroupName "resourcegroup1" –ServerName "server1" –DatabaseName "database1" -State Enabled - - ResourceGroupName ServerName DatabaseName State - ----------------- ---------- ------------ ----- - resourcegroup1 server1 database1 Disabled - - - - - - - - - - - - - - Transparent Data Encryption with Azure SQL Database - https://msdn.microsoft.com/library/dn948096 - - - - - - - Set-AzureRMSqlElasticPool - - Updates properties for an Azure SQL elastic database pool. - - - - - Set - AzureSqlElasticPool - - - - The only properties of an existing pool that can be changed are its Pool DTUs, DTU min per database, and DTU max per database. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Set-AzureRMSqlElasticPool - - ElasticPoolName - - The name of the Azure SQL elastic pool. - - String - - - Edition - - The edition cannot be changed. - - DatabaseEdition - - - Dtu - - The total shared DTU for the Azure SQL elastic pool. - - Int32 - - - StorageMB - - The storage limit for the Azure SQL elastic pool in MB. - - Int64 - - - DatabaseDtuMin - - The minimum DTU all Azure SQL Databases in the pool are guaranteed. - - Int32 - - - DatabaseDtuMax - - The maximum DTU any one Azure SQL Database in the pool can consume. - - Int32 - - - Tags - - The tags to associate with the Azure SQL elastic pool. - - Dictionary`2[String] - - - ServerName - - The name of the Azure SQL Server containing the elastic pool. - - String - - - ResourceGroupName - - Name of resource group of the Azure SQL Server containing the elastic pool to update. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - ElasticPoolName - - The name of the Azure SQL elastic pool. - - String - - String - - - none - - - Edition - - The edition cannot be changed. - - DatabaseEdition - - DatabaseEdition - - - none - - - Dtu - - The total shared DTU for the Azure SQL elastic pool. - - Int32 - - Int32 - - - none - - - StorageMB - - The storage limit for the Azure SQL elastic pool in MB. - - Int64 - - Int64 - - - none - - - DatabaseDtuMin - - The minimum DTU all Azure SQL Databases in the pool are guaranteed. - - Int32 - - Int32 - - - none - - - DatabaseDtuMax - - The maximum DTU any one Azure SQL Database in the pool can consume. - - Int32 - - Int32 - - - none - - - Tags - - The tags to associate with the Azure SQL elastic pool. - - Dictionary`2[String] - - Dictionary`2[String] - - - none - - - ServerName - - The name of the Azure SQL Server containing the elastic pool. - - String - - String - - - none - - - ResourceGroupName - - Name of resource group of the Azure SQL Server containing the elastic pool to update. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example -------------------------- - - PS C:\> - - PS C:\>Set-AzureRMSqlDatabaseElasticPool –ResourceGroupName "resourcegroup1" –ServerName "server1" –ElasticPoolName "elasticpool1" –Dtu 1000 –DatabaseDtuMax 100 –DatabaseDtuMin 20 - - The following command sets an elastic pool’s DTUs to 1000, DTU max per database to 100, and the DTU min per database to 20. - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlElasticPool - - - - Get-AzureRMSqlElasticPoolActivity - - - - Get-AzureRMSqlElasticPoolDatabase - - - - Get-AzureRMSqlDatabaseActivity - - - - New-AzureRMSqlElasticPool - - - - Set-AzureRMSqlElasticPool - - - - - - - - Set-AzureRMSqlServer - - Update the properties for an Azure SQL Server. - - - - - Set - AzureSqlServer - - - - The Set-AzureRMSqlServer cmdlet updates the properties of an Azure SQL Server. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Set-AzureRMSqlServer - - ServerName - - The name of the Azure SQL Server. - - String - - - SqlAdminPassword - - The new SQL administrator password for the server. - - SecureString - - - Tags - - The tags to associate with the Azure SQL Server. - - Dictionary`2[String] - - - ServerVersion - - The Azure SQL Server version to change to. - - String - - - Force - - Skip the confirmation message and update the Azure SQL Server. - - SwitchParameter - - - ResourceGroupName - - The name of the resource group that contains the Azure SQL Server. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - WhatIf - - - - SwitchParameter - - - Confirm - - - - SwitchParameter - - - - - - ServerName - - The name of the Azure SQL Server. - - String - - String - - - none - - - SqlAdminPassword - - The new SQL administrator password for the server. - - SecureString - - SecureString - - - none - - - Tags - - The tags to associate with the Azure SQL Server. - - Dictionary`2[String] - - Dictionary`2[String] - - - none - - - ServerVersion - - The Azure SQL Server version to change to. - - String - - String - - - none - - - Force - - Skip the confirmation message and update the Azure SQL Server. - - SwitchParameter - - SwitchParameter - - - none - - - ResourceGroupName - - The name of the resource group that contains the Azure SQL Server. - - String - - String - - - none - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - none - - - WhatIf - - - - SwitchParameter - - SwitchParameter - - - - - - Confirm - - - - SwitchParameter - - SwitchParameter - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-Help Set-AzureRMSqlServer - - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Set-AzureRMSqlServerActiveDirectoryAdministrator - - Provisions an Azure Active Directory administrator for Azure SQL Server in the current subscription. - - - - - Set - AzureSqlServerActiveDirectoryAdministrator - - - - The Set-AzureRMSqlServerActiveDirectoryAdministrator cmdlet provisions an Azure Active Directory administrator for Azure SQL Server in the current subscription. - At any given time only one administrator can be provisioned - The following members of Azure Active Directory can be provisioned as an administrator for Azure SQL Server - Native members of Azure Active Directory - Federated members of Azure Active Directory - Imported members from other Azure Active Directories who are native or federated members - Active directory groups created as security groups - - Microsoft accounts (i.e. outllok.com, hotmail.com, live.com) or other guest accounts (i.e. gmail.com, yahoo.com) are not supported as administrators - For manageability purpose it is recommended to provision a dedicated Azure Active Directory group as an administrator - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Set-AzureRMSqlServerActiveDirectoryAdministrator - - DisplayName - - Diplay name of the Azure AD administrator (user or group) to be provisioned for SQL Server. - - String - - - ObjectId - - - The unique object ID of the Azure AD administrator to be provisioned for SQL Server. Required if Azure AD <DisplayName> parameter is not unique. - - - Guid - - - ServerName - - The name of the Azure SQL Server that contains the Azure Active Directory administrator you want to change. - - String - - - ResourceGroupName - - The name of the resource group that contains the Azure SQL Server with the Azure Active Directory administrator to change. - - String - - - Profile - - In-memory profile. - - AzureProfile - - - - - - DisplayName - - Diplay name of the Azure AD administrator (user or group) to be provisioned for SQL Server. - - String - - String - - - - - - ObjectId - - - The unique object ID of the Azure AD administrator to be provisioned for SQL Server. Required if Azure AD <DisplayName> parameter is not unique. - - - Guid - - Guid - - - - - - ServerName - - The name of the Azure SQL Server that contains the Azure Active Directory administrator you want to change. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group that contains the Azure SQL Server with the Azure Active Directory administrator to change. - - String - - String - - - - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - - - - - - - InputType - - - - - - System.String - - - - - - - - OutputType - - - - - - System.Object - - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example 1 -------------------------- - - PS C:\> - - PS C:\>Set-AzureRMSqlServerActiveDirectoryAdministrator –ResourceGroupName "Group-23" –ServerName "aad-managed-demo" –DisplayName "DBAs" - - This command provisions an Azure Active Directory administrator group “DBAs” for Azure SQL Database Server “aad-managed-demo” associated with resource group "Group-23" - - - - ResourceGroupName ServerName DisplayName ObjectId - ----------------- ---------- ----------- -------- - Group-23 aad-managed-demo DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b - - - - - - - - - - - - -------------------------- Code Example 2 -------------------------- - - PS C:\> - - PS C:\>Set-AzureRMSqlServerActiveDirectoryAdministrator –ResourceGroupName "Group-23" –ServerName "aad-managed-demo" –DisplayName "Bob Johns" - - This command provisions an Azure Active Directory user "Bob Johns" as an administrator for Azure SQL Database Server “aad-managed-demo” associated with resource group "Group-23" - - - - ResourceGroupName ServerName DisplayName ObjectId - ----------------- ---------- ----------- -------- - Group-23 aad-managed-demo Bob Johns 11E95548-B179-4FE1-9AF4-ACA49D13ABB9 - - - - - - - - - - - - -------------------------- Code Example 3 -------------------------- - - PS C:\> - - PS c:\>Set-AzureRMSqlServerActiveDirectoryAdministrator –ResourceGroupName "Group-23" –ServerName "aad-managed-demo" –DisplayName "DBAs" –ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b" - - This command provisions an Azure Active Directory administrator group “DBAs” for Azure SQL Database Server “aad-managed-demo” associated with resource group "Group-23". To enforce <DisplayName> uniqueness, an optional parameter <–ObjectId > "40b79501-b343-44ed-9ce7-da4c8cc7353b" representing Azure AD ObjectID for the DBAs group is included - - - - PS c:\>Set-AzureRMSqlServerActiveDirectoryAdministrator –ResourceGroupName "Group-23" –ServerName "aad-managed-demo" –DisplayName "DBAs" –ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b" - - ResourceGroupName ServerName DisplayName ObjectId - ----------------- ---------- ----------- -------- - Group-23 aad-managed-demo DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b - - - - - - - - - - - - - - Get-AzureRMSqlServerActiveDirectoryAdministrator - - - - Remove-AzureRMSqlServerActiveDirectoryAdministrator - - - - - - - - Start-AzureRMSqlServerUpgrade - - - - - - - Start - AzureSqlServerUpgrade - - - - - - - - Start-AzureRMSqlServerUpgrade - - ServerVersion - - - - String - - - ScheduleUpgradeAfterUtcDateTime - - - - Nullable`1[DateTime] - - - DatabaseCollection - - - - RecommendedDatabaseProperties[] - - - ElasticPoolCollection - - - - UpgradeRecommendedElasticPoolProperties[] - - - ServerName - - - - String - - - ResourceGroupName - - - - String - - - Profile - - - - AzureProfile - - - - - - ServerVersion - - - - String - - String - - - - - - ScheduleUpgradeAfterUtcDateTime - - - - Nullable`1[DateTime] - - Nullable`1[DateTime] - - - - - - DatabaseCollection - - - - RecommendedDatabaseProperties[] - - RecommendedDatabaseProperties[] - - - - - - ElasticPoolCollection - - - - UpgradeRecommendedElasticPoolProperties[] - - UpgradeRecommendedElasticPoolProperties[] - - - - - - ServerName - - - - String - - String - - - - - - ResourceGroupName - - - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Stop-AzureRMSqlServerUpgrade - - - - - - - Stop - AzureSqlServerUpgrade - - - - - - - - Stop-AzureRMSqlServerUpgrade - - Force - - - - SwitchParameter - - - ServerName - - - - String - - - ResourceGroupName - - - - String - - - Profile - - - - AzureProfile - - - WhatIf - - - - SwitchParameter - - - Confirm - - - - SwitchParameter - - - - - - Force - - - - SwitchParameter - - SwitchParameter - - - - - - ServerName - - - - String - - String - - - - - - ResourceGroupName - - - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - WhatIf - - - - SwitchParameter - - SwitchParameter - - - - - - Confirm - - - - SwitchParameter - - SwitchParameter - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Use-AzureRMSqlServerAuditingPolicy - - Marks an Azure SQL Database as using its server's auditing policy. - - - - - Use - AzureSqlServerAuditingPolicy - - - - The Use-AzureRMSqlServerAuditingPolicy cmdlet marks an Azure SQL Database as using its server's auditing policy. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database. If no auditing policy was defined already for the database server, this cmdlet would fail. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Use-AzureRMSqlServerAuditingPolicy - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - - ServerName - - The name of the server. - - String - - - DatabaseName - - The name of the database. - - String - - - ResourceGroupName - - The name of the resource group containing the server. - - String - - - Profile - - In-memory profile - - AzureProfile - - - - - - PassThru - - Returns an object describing the auditing policy as well as the database's identifiers (i.e. ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output. - - SwitchParameter - - SwitchParameter - - - none - - - ServerName - - The name of the server. - - String - - String - - - none - - - DatabaseName - - The name of the database. - - String - - String - - - none - - - ResourceGroupName - - The name of the resource group containing the server. - - String - - String - - - none - - - Profile - - In-memory profile - - AzureProfile - - AzureProfile - - - none - - - - - - InputType - - - - - None - - - - - - - OutputType - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Code Example -------------------------- - - PS C:\> - - PS C:\>Get-Help Use-AzureRMSqlDatabaseServerAuditPolicy - - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - Get-AzureRMSqlDatabaseActivity - - Gets the status of database operations in an elastic database pool. - - - - - - - - - - Gets the status of moving elastic databases in and out of an elastic pool. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - - - ElasticPoolName - - The name of the Azure SQL elastic pool. - - system.string - - system.string - - - none - - - Profile - - In-memory profile. - - microsoft.azure.common.authentication.models.azureprofile - - microsoft.azure.common.authentication.models.azureprofile - - - none - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server that the elastic pool is in. - - system.string - - system.string - - - none - - - ServerName - - The name of the Azure SQL Server that the elastic pool is in. - - system.string - - system.string - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example -------------------------- - - PS C:\> - - PS C:\>Get-AzureRMSqlDatabaseActivity –ResourceGroupName "resourcegroup1" –ServerName "server1" –ElasticPoolName "elasticpool1" - - The following example returns the operation status of all databases in an elastic pool named "elasticpool1". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - - - - - New-AzureRMSqlServerFirewallRule - - Creates a new firewall rule for an Azure SQL Database server. - - - - - - - - - - The New-AzureRMSqlServerFirewallRule cmdlet creates a new firewall rule for the specified SQL Database server. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - - - AllowAllAzureIPs - - Allows other Azure services to connect to the server. This is a special firewall rule that allows all Azure IPs to access the server. - - switchparameter - - switchparameter - - - none - - - EndIpAddress - - End value of the IP address range. - - system.string - - system.string - - - none - - - FirewallRuleName - - The name of the new firewall rule. - - system.string - - system.string - - - none - - - Profile - - In-memory profile. - - microsoft.azure.common.authentication.models.azureprofile - - microsoft.azure.common.authentication.models.azureprofile - - - none - - - ResourceGroupName - - The name of the resource group that contains the Azure SQL Server this firewall rule will be created for. - - system.string - - system.string - - - none - - - ServerName - - The name of the Azure SQL Server where the new firewall rule is created. Specify only the server name, and not the fully qualified DNS name. - - system.string - - system.string - - - none - - - StartIpAddress - - Start value of the IP address range. - - system.string - - system.string - - - none - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example -------------------------- - - PS C:\> - - PS C:\>New-AzureRMSqlServerFirewallRule -ResourceGroupName "resourcegroup1" -ServerName "server1" -FirewallRuleName "rule1" -StartIpAddress "192.168.0.198" -EndIpAddress "192.168.0.199" - - The following example creates a new firewall rule. - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Get-AzureRMSqlServerFirewallRule - - - - Remove-AzureRMSqlServerFirewallRule - - - - Set-AzureRMSqlServerFirewallRule - - - - - - - - Start-AzureRMSqlServerUpgrade - - Starts upgrading an Azure SQL V11 server to a V12 server. - - - - - Start - AzureSqlServerUpgrade - - - - - The Start-AzureRMSqlServerUpgrade cmdlet starts the upgrade of a SQL V11 server to V12. - Monitor the progress of an upgrade with the Get-AzureRMSqlServerUpgrade cmdlet. - You can stop the upgrade process with the Stop-AzureRMSqlServerUpgrade cmdlet. - - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode -Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - - - ServerVersion - - The target version to upgrade the Azure SQL Server. Currently the version must be "12.0". - - String - - String - - - - - - ScheduleUpgradeAfterUtcDateTime - - The earliest time to upgrade the Azure SQL Server as a DateTime object. The time must be specified in the ISO8601 format and in UTC time zone. - - Nullable`1[DateTime] - - Nullable`1[DateTime] - - - - - - DatabaseCollection - - Collection of RecommendedDatabaseProperties objects to be used for the server upgrade. Check the examples on how to construct a sample object. - - RecommendedDatabaseProperties[] - - RecommendedDatabaseProperties[] - - - - - - ElasticPoolCollection - - Collection of UpgradeRecommendedElasticPoolProperties objects to be used for the server upgrade. Check the examples on how to construct a sample object. - - UpgradeRecommendedElasticPoolProperties[] - - UpgradeRecommendedElasticPoolProperties[] - - - - - - ServerName - - The name of the Azure SQL Server to upgrade. - - String - - String - - - - - - ResourceGroupName - - The name of resource group containing the Azure SQL Server. - - String - - String - - - - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - - - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example 1: Simple server upgrade -------------------------- - - PS C:\> - - Start-AzureRMSqlServerUpgrade -ResourceGroupName MyResourceGroup -ServerName MySqlServer -ServerVersion 12.0 - - - Upgrade the existing server "MySqlServer" in resource group "MyResourceGroup" to version 12.0 - The server "MySqlServer" must have version 2.0, otherwise the command will fail. - - - - - - - - - - - - - - - -------------------------- Example 2: Upgrade server with schedule time and target database properties -------------------------- - - PS C:\> - - - $scheduleTime = (Get-Date).AddMinutes(5).ToUniversalTime() - $databaseMap = New-Object -TypeName Microsoft.Azure.Management.Sql.Models.RecommendedDatabaseProperties - $databaseMap.Name = "testdb" - $databaseMap.TargetEdition = "Standard" - $databaseMap.TargetServiceLevelObjective = "S0" - Start-AzureRMSqlServerUpgrade -ResourceGroupName MyResourceGroup -ServerName MySqlServer -ServerVersion 12.0 -ScheduleUpgradeAfterUtcDateTime $scheduleTime -DatabaseCollection @($databaseMap) - - - - Upgrade the existing server "MySqlServer" in resource group "MyResourceGroup" to version 12.0. - The server "MySqlServer" must have version 2.0 and a database named "testdb", otherwise the command will fail. - - - The earliest time to upgrade is 5 minutes after the cmdlet invocation. - After upgrade, the database "testdb" will have edition "Standard" and Service Level Objective "S0". - - - - - - - - - - - - - - - -------------------------- Example 3: Upgrade server with schedule time and target elastic pool properties -------------------------- - - PS C:\> - - - $scheduleTime = (Get-Date).AddMinutes(5).ToUniversalTime() - $elasticPool = New-Object -TypeName Microsoft.Azure.Management.Sql.Models.UpgradeRecommendedElasticPoolProperties - $elasticPool.DatabaseDtuMax = 100 - $elasticPool.DatabaseDtuMin = 50 - $elasticPool.Dtu = 800 - $elasticPool.Edition = "Standard" - $elasticPool.IncludeAllDatabases = $true - $elasticPool.Name = "my_ep" - $elasticPool.StorageMb = 800 * 1024 - Start-AzureRMSqlServerUpgrade -ResourceGroupName MyResourceGroup -ServerName MySqlServer -ServerVersion 12.0 -ScheduleUpgradeAfterUtcDateTime $scheduleTime -ElasticPoolCollection @($elasticPool) - - - - Upgrade the existing server "MySqlServer" in resource group "MyResourceGroup" to version 12.0. - The server "MySqlServer" must have version 2.0, otherwise the command will fail. - - - The earliest time to upgrade is 5 minutes after the cmdlet invocation. - After upgrade, all databases will be in the elastic pool "my_ep". - - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Stop-AzureRMSqlServerUpgrade - - - - Get-AzureRMSqlServerUpgrade - - - - - - - - Stop-AzureRMSqlServerUpgrade - - Stops an Azure SQL Server Upgrade. - - - - - Stop - AzureSqlServerUpgrade - - - - The Stop-AzureRMSqlServerUpgrade cmdlet stops the upgrade process. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - - - Force - - Skip confirmation message for performing this action. - - SwitchParameter - - SwitchParameter - - - - - - ServerName - - The name of the Azure SQL Server to stop upgrading. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server. - - String - - String - - - - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - - - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example 1: Stop a server upgrade -------------------------- - - PS C:\> - - Stop-AzureRMSqlServerUpgrade -ResourceGroupName MyResourceGroup -ServerName MySqlServer - - Stop the request to upgrade server "MySqlServer" in resource group "MyResourceGroup". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Start-AzureRMSqlServerUpgrade - - - - Get-AzureRMSqlServerUpgrade - - - - - - - - Get-AzureRMSqlServerUpgrade - - Gets the status of an Azure SQL Server Upgrade. - - - - - Get - AzureSqlServerUpgrade - - - - The Get-AzureRMSqlServerUpgrade cmdlet returns the status of an Azure SQL Server Upgrade. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - - - ServerName - - The name of the Azure SQL Server to get upgrade status. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group containing the Azure SQL Server. - - String - - String - - - - - - Profile - - In-memory profile. - - AzureProfile - - AzureProfile - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - - - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - -------------------------- Example 1: Get status of a server upgrade -------------------------- - - PS C:\> - - Get-AzureRMSqlServerUpgrade -ResourceGroupName MyResourceGroup -ServerName MySqlServer | Format-List - - Get the status of an upgrade request from server "MySqlServer" in resource group "MyResourceGroup". - - - - - - - - - - - - - - - - Azure_SqlDatabase - - - - Start-AzureRMSqlServerUpgrade - - - - Stop-AzureRMSqlServerUpgrade - - - - - - - - New-AzureRMSqlDatabaseCopy - - Creates a copy of an existing Azure SQL Database using the snapshot of the data at the time of the call. - - - - - New - AzureSqlDatabaseCopy - - - - This cmdlet replaces the Start-AzureRMSqlDatabaseCopy cmdlet when used to create a one-time database copy. It returns the database object of the copy. - Note: Use New-AzureRMSqlDatabaseSecondary for setting up geo-replication for a database. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - New-AzureRMSqlDatabaseCopy - - DatabaseName - - The name of the Azure SQL Database to be copied. - - String - - - ServiceObjectiveName - - The name of the service objective to assign to the copy. - - String - - - ElasticPoolName - - The name of the Elastic Pool to put the copy in. - - String - - - Tags - - The tags to associate with the Azure SQL Database copy. - - Dictionary`2[String] - - - CopyResourceGroupName - - The name of the Azure Resource Group to create copy in. - - String - - - CopyServerName - - The name of the Azure SQL Server to create copy in. - - String - - - CopyDatabaseName - - The name of the Azure SQL Database copy. - - String - - - ServerName - - The name of the Azure SQL Server the database to be copied is in. - - String - - - ResourceGroupName - - The name of the Azure Resource Group the database to be copied is in. - - String - - - Profile - - - - AzureProfile - - - - - - DatabaseName - - The name of the Azure SQL Database to be copied. - - String - - String - - - - - - ServiceObjectiveName - - The name of the service objective to assign to the copy. - - String - - String - - - - - - ElasticPoolName - - The name of the Elastic Pool to put the copy in. - - String - - String - - - - - - Tags - - The tags to associate with the Azure SQL Database copy. - - Dictionary`2[String] - - Dictionary`2[String] - - - - - - CopyResourceGroupName - - The name of the Azure Resource Group to create copy in. - - String - - String - - - - - - CopyServerName - - The name of the Azure SQL Server to create copy in. - - String - - String - - - - - - CopyDatabaseName - - The name of the Azure SQL Database copy. - - String - - String - - - - - - ServerName - - The name of the Azure SQL Server the database to be copied is in. - - String - - String - - - - - - ResourceGroupName - - The name of the Azure Resource Group the database to be copied is in. - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - - - - - - - New-AzureRMSqlDatabaseSecondary - - Creates a new secondary database for an existing Azure SQL Database and starts data replication. - - - - - New - AzureSqlDatabaseSecondary - - - - This cmdlet replaces the Start-AzureRMSqlDatabaseCopy cmdlet when used for setting up geo-replication for a database. It returns the geo-replication link object from the primary to the secondary database. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - New-AzureRMSqlDatabaseSecondary - - DatabaseName - - The name of the Azure SQL Database to act as primary. - - String - - - SecondaryServiceObjectiveName - - The name of the service objective to assign to the secondary. - - String - - - SecondaryElasticPoolName - - The name of the Elastic Pool to put the secondary in. - - String - - - Tags - - The tags to associate with the Azure SQL Database replication link. - - Dictionary`2[String] - - - PartnerResourceGroupName - - The name of the Azure Resource Group to create secondary in. - - String - - - PartnerServerName - - The name of the Azure SQL Server to create secondary in. - - String - - - AllowConnections - - The read intent of the secondary Azure SQL Database. - - AllowConnections - - - ServerName - - The name of the Azure SQL Server of the primary Azure SQL Database. - - String - - - ResourceGroupName - - The name of the Azure Resource Group of the primary Azure SQL Database. - - String - - - Profile - - - - AzureProfile - - - - - - DatabaseName - - The name of the Azure SQL Database to act as primary. - - String - - String - - - - - - SecondaryServiceObjectiveName - - The name of the service objective to assign to the secondary. - - String - - String - - - - - - SecondaryElasticPoolName - - The name of the Elastic Pool to put the secondary in. - - String - - String - - - - - - Tags - - The tags to associate with the Azure SQL Database replication link. - - Dictionary`2[String] - - Dictionary`2[String] - - - - - - PartnerResourceGroupName - - The name of the Azure Resource Group to create secondary in. - - String - - String - - - - - - PartnerServerName - - The name of the Azure SQL Server to create secondary in. - - String - - String - - - - - - AllowConnections - - The read intent of the secondary Azure SQL Database. - - AllowConnections - - AllowConnections - - - - - - ServerName - - The name of the Azure SQL Server of the primary Azure SQL Database. - - String - - String - - - - - - ResourceGroupName - - The name of the Azure Resource Group of the primary Azure SQL Database. - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - - - - - - - Remove-AzureRMSqlDatabaseSecondary - - Terminates data replication between an Azure SQL Database and the specified secondary database. - - - - - Remove - AzureSqlDatabaseSecondary - - - - This cmdlet replaces the Stop-AzureRMSqlDatabaseCopy cmdlet. It will force terminates the geo-replication link. There is no replication synchronization prior to termination. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Remove-AzureRMSqlDatabaseSecondary - - DatabaseName - - The name of the primary Azure SQL Database with the replication link to remove. - - String - - - PartnerResourceGroupName - - The name of the partner Azure Resource Group. - - String - - - PartnerServerName - - The name of the partner Azure SQL Server. - - String - - - ServerName - - The name of the Azure SQL Server with the replication link to remove. - - String - - - ResourceGroupName - - The name of the Azure Resource Group with the replication link to remove. - - String - - - Profile - - - - AzureProfile - - - WhatIf - - - - SwitchParameter - - - Confirm - - - - SwitchParameter - - - - - - DatabaseName - - The name of the primary Azure SQL Database with the replication link to remove. - - String - - String - - - - - - PartnerResourceGroupName - - The name of the partner Azure Resource Group. - - String - - String - - - - - - PartnerServerName - - The name of the partner Azure SQL Server. - - String - - String - - - - - - ServerName - - The name of the Azure SQL Server with the replication link to remove. - - String - - String - - - - - - ResourceGroupName - - The name of the Azure Resource Group with the replication link to remove. - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - WhatIf - - - - SwitchParameter - - SwitchParameter - - - - - - Confirm - - - - SwitchParameter - - SwitchParameter - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - - - - - - - Get-AzureRMSqlDatabaseReplicationLink - - Gets the geo-replication links between an Azure SQL Database and the specified Azure Resource Group or Azure SQL Server. - - - - - Get - AzureSqlDatabaseReplicationLink - - - - This cmdlet replaces the Get-AzureRMSqlDatabaseCopy cmdlet. It will return all geo-replication links between the specified Azure Resource Group or Azure SQL Server. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Get-AzureRMSqlDatabaseReplicationLink - - DatabaseName - - The name of the Azure SQL Database to retrieve links for. - - String - - - PartnerResourceGroupName - - The name of the Azure Resource Group for the partner. - - String - - - ServerName - - The name of the Azure SQL Server for the database to retrieve links for. - - String - - - ResourceGroupName - - The name of the Azure Resource Group for the database to retrieve links for. - - String - - - Profile - - - - AzureProfile - - - - Get-AzureRMSqlDatabaseReplicationLink - - DatabaseName - - The name of the Azure SQL Database to retrieve links for. - - String - - - PartnerResourceGroupName - - The name of the Azure Resource Group for the partner. - - String - - - PartnerServerName - - The name of the Azure SQL Server for the partner. - - String - - - ServerName - - The name of the Azure SQL Server for the database to retrieve links for. - - String - - - ResourceGroupName - - The name of the Azure Resource Group for the database to retrieve links for. - - String - - - Profile - - - - AzureProfile - - - - - - DatabaseName - - The name of the Azure SQL Database to retrieve links for. - - String - - String - - - - - - PartnerResourceGroupName - - The name of the Azure Resource Group for the partner. - - String - - String - - - - - - ServerName - - The name of the Azure SQL Server for the database to retrieve links for. - - String - - String - - - - - - ResourceGroupName - - The name of the Azure Resource Group for the database to retrieve links for. - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - PartnerServerName - - The name of the Azure SQL Server for the partner. - - String - - String - - - - - - - - - InputType - - - - - System.String - - - - - - - OutputType - - - - - System.Object - - - - - - - - - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters. - - - - - - - - - - - Set-AzureRMSqlDatabaseSecondary - - Switches a secondary Azure SQL Database to the primary in order to failover. - - - - - Set - AzureSqlDatabaseSecondary - - - - This cmdlet is designed as a general configuration command, but at the moment it is limited to initiating failover. Use it with the –AllowDataLoss parameter to initiate a force failover during an outage. You don’t have to specify it when performing a planned operation , such as DR drill. In the latter case the secondary databases will be synchronized with the primary before switching. - - Note: This cmdlet can only be executed in Azure Resource Manager mode. To enable Azure Resource Manager mode run the following command: - Switch-AzureMode –Name AzureResourceManager - - For more information, see Using Windows PowerShell with Resource Manager. - - - - Set-AzureRMSqlDatabaseSecondary - - DatabaseName - - - The name of the Azure SQL Database Secondary. - - - String - - - PartnerResourceGroupName - - - The name of the Azure Resource Group of the partner Azure SQL Database. - - - String - - - Failover - - Determines if this operation is a failover. - - SwitchParameter - - - AllowDataLoss - - Determines if this failover operation will allow data loss. - - SwitchParameter - - - ServerName - - - The name of the Azure SQL Server of the Azure SQL Database Secondary. - - - String - - - ResourceGroupName - - - The name of the Azure Resource Group of the Azure SQL Database Secondary. - - - String - - - Profile - - - - AzureProfile - - - - - - DatabaseName - - - The name of the Azure SQL Database Secondary. - - - String - - String - - - - - - PartnerResourceGroupName - - - The name of the Azure Resource Group of the partner Azure SQL Database. - - - String - - String - - - - - - Failover - - Determines if this operation is a failover. - - SwitchParameter - - SwitchParameter - - - - - - AllowDataLoss - - Determines if this failover operation will allow data loss. - - SwitchParameter - - SwitchParameter - - - - - - ServerName - - - The name of the Azure SQL Server of the Azure SQL Database Secondary. - - - String - - String - - - - - - ResourceGroupName - - - The name of the Azure Resource Group of the Azure SQL Database Secondary. - - - String - - String - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + Get-AzureRMSqlCapability + + Gets SQL Database capabilities for the current subscription. + + + + + Get + AzureRMSqlCapability + + + + The Get-AzureRMSqlCapability cmdlet gets the Azure SQL Database capabilities available on the current subscription for a region. If you specify the ServerVersionName, EditionName, or ServiceObjectiveName parameters, this cmdlet returns the specified values and their predecessors. + + + + Get-AzureRMSqlCapability + + LocationName + + Specifies the name of the Location for which this cmdlet gets capabilities. For more information, see Azure Regions (http://azure.microsoft.com/en-us/regions/). + + String + + + Defaults + + Indicates that this cmdlet gets only defaults. + + SwitchParameter + + + + Get-AzureRMSqlCapability + + LocationName + + Specifies the name of the Location for which this cmdlet gets capabilities. For more information, see Azure Regions (http://azure.microsoft.com/en-us/regions/). + + String + + + ServerVersionName + + Specifies the name of the server version for which this cmdlet gets capabilities. + + String + + + EditionName + + Specifies the name of the database edition for which this cmdlet gets capabilities. + + String + + + ServiceObjectiveName + + Specifies the name of the service objective for which this cmdlet gets capabilities. + + String + + + + + + LocationName + + Specifies the name of the Location for which this cmdlet gets capabilities. For more information, see Azure Regions (http://azure.microsoft.com/en-us/regions/). + + String + + String + + + none + + + ServerVersionName + + Specifies the name of the server version for which this cmdlet gets capabilities. + + String + + String + + + none + + + EditionName + + Specifies the name of the database edition for which this cmdlet gets capabilities. + + String + + String + + + none + + + ServiceObjectiveName + + Specifies the name of the service objective for which this cmdlet gets capabilities. + + String + + String + + + none + + + Defaults + + Indicates that this cmdlet gets only defaults. + + SwitchParameter + + SwitchParameter + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Location_Capabilities.Model.LocationCapabilityModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get capabilities for the current subscription for a region -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlCapability -LocationName "Central US" + + This command returns the capabilities for SQL Database on the current subscription for the Central US region. + + + Location : Central US Status : Available SupportedServerVersions : {12.0, 2.0} + + + + + + + + + + + -------------------------- Example 2: Get default capabilities for the current subscription for a region -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlCapability -LocationName "Central US" -Defaults + + This command returns the default capabilities for SQL Database on the current subscription in the Central US region. + + + Location : Central US Status : Available ExpandedDetails : Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S0 (Default) + + + + + + + + + + + -------------------------- Example 3: Get details for a service objective -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlCapability -LocationName "Central US" -ServiceObjectiveName "S1" + + This command gets default capabilities for SQL Database for the specified service objective on the current subscription. + + + Location : Central US Status : Available ExpandedDetails : Version: 12.0 (Available) -> Edition: Standard (Default) -> Service Objective: S1 (Available) Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S1 (Available) + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + + + + + Get-AzureRMSqlDatabase + + Gets one or more Azure SQL databases. + + + + + Get + AzureRMSqlDatabase + + + + The Get-AzureRMSqlDatabase cmdlet gets one or more Azure SQL databases from an Azure SQL Database Server. + + + + Get-AzureRMSqlDatabase + + DatabaseName + + Specifies the name of the database to retrieve. + + String + + + ServerName + + Specifies the name of the server the database is in. + + String + + + ResourceGroupName + + Specifies the name of the resource group of the server that contains the database. + + String + + + + + + DatabaseName + + Specifies the name of the database to retrieve. + + String + + String + + + none + + + ServerName + + Specifies the name of the server the database is in. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group of the server that contains the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get all databases on a server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command gets all databases on the server named server01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : master Location : Central US DatabaseId : a2a7f2db-7526-4d86-a7b2-36276ee10dc6 Edition : None CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 5368709120 Status : Online CreationDate : 7/3/2015 7:32:44 AM CurrentServiceObjectiveId : c99ac918-dbea-463f-a475-16ec020fdc12 CurrentServiceObjectiveName : System1 RequestedServiceObjectiveId : c99ac918-dbea-463f-a475-16ec020fdc12 RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : Tags : + +ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 Edition : Standard CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 268435456000 Status : Online CreationDate : 7/3/2015 7:33:37 AM CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b CurrentServiceObjectiveName : S0 RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : Tags : + + + + + + + + + + + -------------------------- Example 2: Get a database by name on a server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command gets a database named Database02 from a server named Server01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 Edition : Standard CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 268435456000 Status : Online CreationDate : 7/3/2015 7:33:37 AM CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b CurrentServiceObjectiveName : S0 RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : Tags : + + + + + + + + + + + + + New-AzureRMSqlDatabase + + + + Remove-AzureRMSqlDatabase + + + + Resume-AzureRMSqlDatabase + + + + Set-AzureRMSqlDatabase + + + + Suspend-AzureRMSqlDatabase + + + + Azure SQL Database + + + + + + + + Get-AzureRMSqlDatabaseActivity + + Gets the status of moving elastic databases. + + + + + Get + AzureRMSqlDatabaseActivity + + + + The Get-AzureRMSqlDatabaseActivity cmdlet gets the status of moving elastic databases into or out of an elastic database pool in Azure SQL Database. + + + + Get-AzureRMSqlDatabaseActivity + + ServerName + + Specifies the name of the SQL Server that hosts the elastic database pool. + + String + + + ElasticPoolName + + Specifies the name of the elastic database pool for which this cmdlet gets status. + + String + + + DatabaseName + + Specifies the name of the database for which this cmdlet gets status. + + String + + + OperationId + + Specifies the ID of the operation that this cmdlet gets. + + Nullable`1[Guid] + + + ResourceGroupName + + Specifies the name of the resource group that contains the database for which this cmdlet gets status. + + String + + + + + + ServerName + + Specifies the name of the SQL Server that hosts the elastic database pool. + + String + + String + + + none + + + ElasticPoolName + + Specifies the name of the elastic database pool for which this cmdlet gets status. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database for which this cmdlet gets status. + + String + + String + + + none + + + OperationId + + Specifies the ID of the operation that this cmdlet gets. + + Nullable`1[Guid] + + Nullable`1[Guid] + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database for which this cmdlet gets status. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseActivityModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get status for all SQL Database instances -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseActivity -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticPool01" + + This command returns the operation status of all SQL Database instances in an elastic pool named elasticPool01. + + + + + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseAuditingPolicy + + Gets the auditing policy of an Azure SQL database. + + + + + Get + AzureRMSqlDatabaseAuditingPolicy + + + + The Get-AzureRMSqlDatabaseAuditingPolicy cmdlet gets the auditing policy of an Azure SQL database. To use the cmdlet, use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database. + + + + Get-AzureRMSqlDatabaseAuditingPolicy + + ServerName + + Specifies the name of the server that contains the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + + + + + ServerName + + Specifies the name of the server that contains the database. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get the auditing policy of an Azure SQL database -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command gets the auditing policy of database database01 located in server01 in resource group resourcegroup01. + + + DatabaseName : database01 UseServerDefault : Disabled ResourceGroupName : resourcegroup01 ServerName : server01 StorageAccountName : StorageKeyType : Primary EventType : {PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure...} AuditState : New RetentionInDays : 0 TableIdentifier : Server01Database01 + + + + + + + + + + + + + Remove-AzureRMSqlDatabaseAuditing + + + + Set-AzureRMSqlDatabaseAuditingPolicy + + + + Azure SQL Database + + + + + + + + Get-AzureRMSqlDatabaseDataMaskingPolicy + + Gets the data masking policy for an Azure SQL database. + + + + + Get + AzureRMSqlDatabaseDataMaskingPolicy + + + + The Get-AzureRMSqlDatabaseDataMaskingPolicy cmdlet gets the data masking policy of an Azure SQL database. To use this cmdlet, use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database. + + + + Get-AzureRMSqlDatabaseDataMaskingPolicy + + ServerName + + Specifies the name of the server containing the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group containing the database. + + String + + + + + + ServerName + + Specifies the name of the server containing the database. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group containing the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingPolicyModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get the data masking policy for an Azure SQL database -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseDataMaskingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command gets the data masking policy from database database01 in resource group resourcegroup01 contained in server server01. + + + DatabaseName : database01 ResourceGroupName : resourcegroup01 ServerName : server01 DataMaskingState : Uninitialized PrivilegedLogins : + + + + + + + + + + + + + Get-AzureRMSqlDatabaseDataMaskingRule + + + + New-AzureRMSqlDatabaseDataMaskingRule + + + + Remove-AzureRMSqlDatabaseDataMaskingRule + + + + Set-AzureRMSqlDatabaseDataMaskingPolicy + + + + Set-AzureRMSqlDatabaseDataMaskingRule + + + + Azure SQL Database + + + + + + + + Get-AzureRMSqlDatabaseDataMaskingRule + + Gets the data masking rules from an Azure SQL database. + + + + + Get + AzureRMSqlDatabaseDataMaskingRule + + + + The Get-AzureRMSqlDatabaseDataMaskingRule cmdlet gets either a specific data masking rule, or all of the data masking rules of an Azure SQL database. To use the cmdlet, use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database, and the RuleId parameter to specify which rule this cmdlet returns. If you do not provide RuleId, then all the data masking rules of that Azure SQL database are returned. + + + + Get-AzureRMSqlDatabaseDataMaskingRule + + RuleId + + Specifies the ID of the requested rule. If you do not specify this parameter, this cmdlet gets all the information about all the data masking rules in the specified SQL database. + + String + + + ServerName + + Specifies the name of the server. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group containing the database. + + String + + + + + + RuleId + + Specifies the ID of the requested rule. If you do not specify this parameter, this cmdlet gets all the information about all the data masking rules in the specified SQL database. + + String + + String + + + none + + + ServerName + + Specifies the name of the server. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group containing the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get all data masking rules from a database -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command gets all data masking rules from database01 in resource group resourcegroup01 contained in server server01. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseDataMaskingPolicy + + + + New-AzureRMSqlDatabaseDataMaskingRule + + + + Remove-AzureRMSqlDatabaseDataMaskingRule + + + + Set-AzureRMSqlDatabaseDataMaskingPolicy + + + + Set-AzureRMSqlDatabaseDataMaskingRule + + + + Azure SQL Database + + + + + + + + Get-AzureRMSqlDatabaseExpanded + + + + + + + Get + AzureRMSqlDatabaseExpanded + + + + + + + + Get-AzureRMSqlDatabaseExpanded + + ServerName + + + + String + + + DatabaseName + + + + String + + + ResourceGroupName + + + + String + + + + + + ServerName + + + + String + + String + + + none + + + DatabaseName + + + + String + + String + + + none + + + ResourceGroupName + + + + String + + String + + + none + + + Profile + + + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseIndexRecommendations + + Gets the recommended index operations for a server or database. + + + + + Get + AzureRMSqlDatabaseIndexRecommendations + + + + The Get-AzureRMSqlDatabaseIndexRecommendations cmdlet gets the recommended index operations for a server or database in Azure SQL Database. + + + + Get-AzureRMSqlDatabaseIndexRecommendations + + ServerName + + Specifies the server that hosts the database for which this cmdlet gets index recommendations. + + String + + + DatabaseName + + Specifies the name of the database for which this cmdlet gets the index recommendations. + + String + + + TableName + + Specifies the name of an Azure SQL Table. + + String + + + IndexRecommendationName + + Specifies the name of the index recommendation that this cmdlet gets. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the server. This cmdlet gets index recommendations for a database that this server hosts. + + String + + + + + + ServerName + + Specifies the server that hosts the database for which this cmdlet gets index recommendations. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database for which this cmdlet gets the index recommendations. + + String + + String + + + none + + + TableName + + Specifies the name of an Azure SQL Table. + + String + + String + + + none + + + IndexRecommendationName + + Specifies the name of the index recommendation that this cmdlet gets. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the server. This cmdlet gets index recommendations for a database that this server hosts. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get index recommendations for all databases on server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseIndexRecommendations -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command returns index recommendations for all databases on server. + + + + + + + + + + + + + + -------------------------- Example 2: Get index recommendations for a specific database -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseIndexRecommendations -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command returns index recommendations for specific database. + + + + + + + + + + + + + + -------------------------- Example 3: Get a single index recommendation by name -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseIndexRecommendations -ResourceGroupName "resourcegroup01" -ServerName "server01" -DtabaseName "database01" -IndexRecommendationName "INDEX_NAME" + + This command returns single index recommendation by name. + + + + + + + + + + + + + + + + Start-AzureRMSqlDatabaseExecuteIndexRecommendation + + + + Stop-AzureRMSqlDatabaseExecuteIndexRecommendation + + + + + + + + Get-AzureRMSqlDatabaseReplicationLink + + Gets the geo-replication links between an Azure SQL Database and the specified Azure Resource Group or Azure SQL Server. + + + + + Get + AzureRMSqlDatabaseReplicationLink + + + + This cmdlet replaces the Get-AzureSqlDatabaseCopy cmdlet. It will return all geo-replication links between the specified Azure Resource Group or Azure SQL Server. + + + + Get-AzureRMSqlDatabaseReplicationLink + + DatabaseName + + The name of the Azure SQL Database to retrieve links for. + + String + + + PartnerResourceGroupName + + The name of the Azure Resource Group for the partner. + + String + + + ServerName + + The name of the Azure SQL Server for the database to retrieve links for. + + String + + + ResourceGroupName + + The name of the Azure Resource Group for the database to retrieve links for. + + String + + + + Get-AzureRMSqlDatabaseReplicationLink + + DatabaseName + + The name of the Azure SQL Database to retrieve links for. + + String + + + PartnerResourceGroupName + + The name of the Azure Resource Group for the partner. + + String + + + PartnerServerName + + The name of the Azure SQL Server for the partner. + + String + + + ServerName + + The name of the Azure SQL Server for the database to retrieve links for. + + String + + + ResourceGroupName + + The name of the Azure Resource Group for the database to retrieve links for. + + String + + + + + + DatabaseName + + The name of the Azure SQL Database to retrieve links for. + + String + + String + + + + + + PartnerResourceGroupName + + The name of the Azure Resource Group for the partner. + + String + + String + + + + + + ServerName + + The name of the Azure SQL Server for the database to retrieve links for. + + String + + String + + + + + + ResourceGroupName + + The name of the Azure Resource Group for the database to retrieve links for. + + String + + String + + + + + + PartnerServerName + + The name of the Azure SQL Server for the partner. + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseRestorePoints + + + + + + + Get + AzureRMSqlDatabaseRestorePoints + + + + + + + + Get-AzureRMSqlDatabaseRestorePoints + + ServerName + + Specifies the name of the Azure SQL Server holding the database. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database. + + String + + + ResourceGroupName + + Specifies the name of the resource group of the Azure SQL Database. + + String + + + + + + ServerName + + Specifies the name of the Azure SQL Server holding the database. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the Azure SQL Database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group of the Azure SQL Database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseRestorePoints -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + Returns all available restore points for Azure SQL Database "database01". + + + ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US RestorePointType : CONTINUOUS RestorePointCreationDate : EarliestRestoreDate : 8/12/2015 12:00:00 AM + + + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseSecureConnectionPolicy + + Gets the secure connection policy of an Azure SQL database. + + + + + Get + AzureRMSqlDatabaseSecureConnectionPolicy + + + + The Get-AzureRMSqlDatabaseSecureConnectionPolicy cmdlet gets the secure connection policy of an Azure SQL database. To use the cmdlet, use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database. After this cmdlet runs successfully, it returns an object describing the current secure connection policy as well as the database identifiers. Database identifiers include, but are not limited to, ResourceGroupName, ServerName, and DatabaseName. + + + + Get-AzureRMSqlDatabaseSecureConnectionPolicy + + ServerName + + Specifies the name of server that contains the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + + + + + ServerName + + Specifies the name of server that contains the database. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseSecureConnectionPolicyModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get the secure connection policy of an azure_2 SQL database -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseSecureConnectionPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command gets the secure connection policy of an Azure SQL database named database01 located in server server01. + + + DatabaseName : database01 ConnectionStrings : Microsoft.Azure.Commands.Sql.SecureConnection.Model.ConnectionStrings ResourceGroupName : resourcegroup01 ServerName : server01 ProxyDnsName : server01.database.secure.windows.net ProxyPort : 1433 SecureConnectionState : Optional + + + + + + + + + + + + + Azure SQL Database + + + + + + + + Get-AzureRMSqlDatabaseTransparentDataEncryption + + Gets the TPE state for an Azure SQL database. + + + + + Get + AzureRMSqlDatabaseTransparentDataEncryption + + + + The Get-AzureRMSqlDatabaseTransparentDataEncryption cmdlet gets the state of Transparent Data Encryption (TPE) from an Azure SQL database. For more information, see Transparent Data Encryption with Azure SQL Database (https://msdn.microsoft.com/library/dn948096) in the Microsoft Developer Network Library. This cmdlet gets the current state of TPE, but both encryption and decryption can be long running operations. To see the encryption scan progress, run the Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity cmdlet. + + + + Get-AzureRMSqlDatabaseTransparentDataEncryption + + ServerName + + Specifies the name of the server that hosts the database for which this cmdlet gets TDE status. + + String + + + DatabaseName + + Specifies the name of the database for which this cmdlet gets TDE status. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database for which this cmdlet gets TDE status. + + String + + + + + + ServerName + + Specifies the name of the server that hosts the database for which this cmdlet gets TDE status. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database for which this cmdlet gets TDE status. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database for which this cmdlet gets TDE status. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get TPE status for a database -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseTransparentDataEncryption -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01" + + This command gets the status of TPE for the database named Database01 on the server named server01. + + + ResourceGroupName ServerName DatabaseName State ----------------- ---------- ------------ ----- resourcegroup01 server01 database01 Disabled + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity + + + + Set-AzureRMSqlDatabaseTransparentDataEncryption + + + + + + + + Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity + + Gets the progress of a TDE scan of an Azure SQL database. + + + + + Get + AzureRMSqlDatabaseTransparentDataEncryptionActivity + + + + The Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity cmdlet gets the progress of a Transparent Data Encryption (TDE) scan of an Azure SQL database. If no encryption span is running, this cmdlet returns an empty list. For more information, see Transparent Data Encryption with Azure SQL Database (https://msdn.microsoft.com/library/dn948096) in the Microsoft Developer Network Library. + + + + Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity + + ServerName + + Specifies the name of the server that hosts the database for which this cmdlet gets TDE encryption activity. + + String + + + DatabaseName + + Specifies the name of the database for which this cmdlet gets TDE encryption activity. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database for which this cmdlet gets TDE encryption activity. + + String + + + + + + ServerName + + Specifies the name of the server that hosts the database for which this cmdlet gets TDE encryption activity. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database for which this cmdlet gets TDE encryption activity. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database for which this cmdlet gets TDE encryption activity. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionActivityModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get TPE activity for a database -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01" + + This command gets the TPE activity for the database named database01 on the server named server01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Status : Encrypting PercentComplete : 3.662109 + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseTransparentDataEncryption + + + + Set-AzureRMSqlDatabaseTransparentDataEncryption + + + + + + + + Get-AzureRMSqlDatabaseUpgradeHint + + Gets pricing tier hints for a database for upgrading SQL Database. + + + + + Get + AzureRMSqlDatabaseUpgradeHint + + + + The Get-AzureRMSqlDatabaseUpgradeHint cmdlet gets pricing tier hints for a database for upgrading Azure SQL Database. Databases that are still in Web and Business pricing tiers get the hint to upgrade to the new Basic, Standard, or Premium pricing tiers. + + + + Get-AzureRMSqlDatabaseUpgradeHint + + ServerName + + Specifies the name of the server that hosts the database for which this cmdlet gets an upgrade hint. + + String + + + DatabaseName + + Specifies the name of the SQL database for which this cmdlet gets an upgrade hint. If you do not specify a database, this cmdlet gets hints for all databases on the logical server. + + String + + + ExcludeElasticPoolCandidates + + Indicates whether to exclude databases that are included in elastic database pool recommendations. + + Boolean + + + ResourceGroupName + + Specifies the name of the resource group that contains the database for which this cmdlet gets an upgrade hint. + + String + + + + + + ServerName + + Specifies the name of the server that hosts the database for which this cmdlet gets an upgrade hint. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the SQL database for which this cmdlet gets an upgrade hint. If you do not specify a database, this cmdlet gets hints for all databases on the logical server. + + String + + String + + + none + + + ExcludeElasticPoolCandidates + + Indicates whether to exclude databases that are included in elastic database pool recommendations. + + Boolean + + Boolean + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database for which this cmdlet gets an upgrade hint. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get recommendations for all databases on a server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command returns upgrade hints for all databases on server. + + + + + + + + + + + + + + -------------------------- Example 2: Get recommendations for specific database -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command returns upgrade hint for specific database. + + + + + + + + + + + + + + -------------------------- Example 3: Get recommendation for all databases that are not recommended for an elastic database pool -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" -ExcludeElasticPoolCandidates $True + + This command returns upgrade hints for database that are not included in elastic database pool recommendations. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseExpanded + + + + Get-AzureRMSqlElasticPoolRecommendation + + + + + + + + Get-AzureRMSqlElasticPool + + Gets elastic pools and their property values in an Azure SQL Database. + + + + + Get + AzureRMSqlElasticPool + + + + The Get-AzureRMSqlElasticPool cmdlet gets elastic pools and their property values in an Azure SQL Database. Specify the name of an existing elastic pool to see the property values for only that pool. + + + + Get-AzureRMSqlElasticPool + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet gets. + + String + + + ServerName + + Specifies the name of the server that contains the elastic pool that this cmdlet gets. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the elastic pool that this cmdlet gets. + + String + + + + + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet gets. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that contains the elastic pool that this cmdlet gets. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the elastic pool that this cmdlet gets. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get all elastic pools -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command gets all elastic pools on the server named server01. + + + ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 Location : Central US CreationDate : 8/26/2015 10:00:17 PM State : Ready Edition : Standard Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 Tags : + +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool02 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool02 Location : Central US CreationDate : 8/26/2015 11:00:17 PM State : Ready Edition : Standard Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 Tags : + + + + + + + + + + + + -------------------------- Example 2: Get a specific elastic pool -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticPool27" + + This command gets the elastic pool named elasticPool01 on the server named server01. + + + ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 Location : Central US CreationDate : 8/26/2015 10:00:17 PM State : Ready Edition : Standard Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 Tags : + + + + + + + + + + + + -------------------------- Example 3: Get metrics for a Azure SQL Elastic Database Pool -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" | Get-Metrics -TimeGrain 0:5:0 + + Returns metrics for an Azure SQL Elastic Database Pool named "elasticpool01". + + + DimensionName : DimensionValue : Name : cpu_percent EndTime : 8/27/2015 5:22:25 PM MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} Properties : {} ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 StartTime : 8/27/2015 4:20:00 PM TimeGrain : 00:05:00 Unit : Percent + +DimensionName : DimensionValue : Name : physical_data_read_percent EndTime : 8/27/2015 5:22:25 PM MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} Properties : {} ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 StartTime : 8/27/2015 4:20:00 PM TimeGrain : 00:05:00 Unit : Percent + +DimensionName : DimensionValue : Name : log_write_percent EndTime : 8/27/2015 5:22:25 PM MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} Properties : {} ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 StartTime : 8/27/2015 4:20:00 PM TimeGrain : 00:05:00 Unit : Percent + +DimensionName : DimensionValue : Name : dtu_consumption_percent EndTime : 8/27/2015 5:22:25 PM MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} Properties : {} ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 StartTime : 8/27/2015 4:20:00 PM TimeGrain : 00:05:00 Unit : Percent + +DimensionName : DimensionValue : Name : storage_percent EndTime : 8/27/2015 5:22:25 PM MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} Properties : {} ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 StartTime : 8/27/2015 4:20:00 PM TimeGrain : 00:05:00 Unit : Percent + + + + + + + + + + + + + Azure SQL Database + + + + New-AzureRMSqlElasticPool + + + + Remove-AzureRMSqlElasticPool + + + + Set-AzureRMSqlElasticPool + + + + + + + + Get-AzureRMSqlElasticPoolActivity + + Gets the status of operations on an elastic pool. + + + + + Get + AzureRMSqlElasticPoolActivity + + + + The Get-AzureRMSqlElasticPoolActivity cmdlet gets the status of operations on an elastic pool in Azure SQL Database. You can see status of pool creation and configuration updates. + + + + Get-AzureRMSqlElasticPoolActivity + + ServerName + + Specifies the name of a server that contains an elastic pool. This cmdlet gets status for a pool on the server that this parameter specifies. + + String + + + ElasticPoolName + + Specifies the name of an elastic pool. This cmdlet gets status for the pool that this parameter specifies. + + String + + + ResourceGroupName + + Specifies the name of a resource group that contains an elastic pool. This cmdlet gets status for a pool in the resource group that this parameter specifies. + + String + + + + + + ServerName + + Specifies the name of a server that contains an elastic pool. This cmdlet gets status for a pool on the server that this parameter specifies. + + String + + String + + + none + + + ElasticPoolName + + Specifies the name of an elastic pool. This cmdlet gets status for the pool that this parameter specifies. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of a resource group that contains an elastic pool. This cmdlet gets status for a pool in the resource group that this parameter specifies. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolActivityModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get the status of operations for an elastic pool -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlElasticPoolActivity -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" + + This command gets the status of the operations for the elastic pool named elasticPool01. + + + + + + + + + + + + + + + + Azure SQL Database + + + + Get-AzureRMSqlElasticPool + + + + Get-AzureRMSqlElasticPoolDatabase + + + + New-AzureRMSqlElasticPool + + + + Remove-AzureRMSqlElasticPool + + + + Set-AzureRMSqlElasticPool + + + + + + + + Get-AzureRMSqlElasticPoolDatabase + + Gets elastic databases in an elastic pool and their property values. + + + + + Get + AzureRMSqlElasticPoolDatabase + + + + The Get-AzureRMSqlElasticPoolDatabase cmdlet gets elastic databases in an elastic pool and their property values. Specify the name of an elastic database in Azure SQL Database to see the property values for only that database. + + + + Get-AzureRMSqlElasticPoolDatabase + + ElasticPoolName + + Specifies the name of an elastic pool. This cmdlet gets databases in the pool that this parameter specifies. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database that this cmdlet gets. + + String + + + ServerName + + Specifies the name of a server that contains an elastic pool. This cmdlet gets a database in a pool on the server that this parameter specifies. + + String + + + ResourceGroupName + + Specifies the name of a resource group that contains an elastic pool. This cmdlet gets a database in a pool in the resource group that this parameter specifies. + + String + + + + + + ElasticPoolName + + Specifies the name of an elastic pool. This cmdlet gets databases in the pool that this parameter specifies. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the Azure SQL Database that this cmdlet gets. + + String + + String + + + none + + + ServerName + + Specifies the name of a server that contains an elastic pool. This cmdlet gets a database in a pool on the server that this parameter specifies. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of a resource group that contains an elastic pool. This cmdlet gets a database in a pool in the resource group that this parameter specifies. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get all databases in an elastic pool -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlElasticPoolDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticPool01" + + This command gets all databases in an elastic pool named elasticPool01. + + + + + + + + + + + + + + + + Azure SQL Database + + + + Get-AzureRMSqlElasticPool + + + + Get-AzureRMSqlElasticPoolActivity + + + + New-AzureRMSqlElasticPool + + + + Remove-AzureRMSqlElasticPool + + + + Set-AzureRMSqlElasticPool + + + + + + + + Get-AzureRMSqlElasticPoolRecommendation + + Gets elastic pool recommendations. + + + + + Get + AzureRMSqlElasticPoolRecommendation + + + + The Get-AzureRMSqlElasticPoolRecommendation cmdlet gets elastic pool recommendations for a server. These recommendations include the following values: + -- DatabaseCollection. Collection of database names that belong to the pool. +-- DatabaseDtuMin. Data Transmission Unit (DTU) guarantee for database in elastic pool. +-- DatabaseDtuMax. DTU cap for database in elastic pool. +-- Dtu. DTU guarantee for elastic pool. +-- StorageMb. Storage in megabytes for elastic pool. +-- Edition. Edition for elastic pool. Valid values are: Basic, Standard, and Premium. +-- IncludeAllDatabases. Whether to include all databases in the server in the elastic pool. +-- Name. Name of the elastic pool. + + + + Get-AzureRMSqlElasticPoolRecommendation + + ServerName + + Specifies the name of the server for which this cmdlet gets recommendations. + + String + + + ResourceGroupName + + Specifies name of the resource group that contains the server. + + String + + + + + + ServerName + + Specifies the name of the server for which this cmdlet gets recommendations. + + String + + String + + + none + + + ResourceGroupName + + Specifies name of the resource group that contains the server. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get recommendations for a server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlElasticPoolRecommendation -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command gets the elastic pool recommendations for the server named server01. + + + + + + + + + + + + + + + + + + + + Get-AzureRMSqlServer + + Returns information about Azure SQL Database servers. + + + + + Get + AzureRMSqlServer + + + + The Get-AzureRMSqlServer cmdlet returns information about one or more Azure SQL Database servers. Specify the name of a server to see information about only that server. + + + + Get-AzureRMSqlServer + + ServerName + + Specifies the name of the server that this cmdlet gets. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the servers that this cmdlet gets. + + String + + + + + + ServerName + + Specifies the name of the server that this cmdlet gets. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the servers that this cmdlet gets. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get all Azure SQL Servers in a resource group -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlServer –ResourceGroupName "resourcegroup01" + + This command gets information about all the Azure SQL Database servers in the resource group resourcegroup01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 Location : Central US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : + +ResourceGroupName : resourcegroup01 ServerName : server02 Location : West US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : + + + + + + + + + + + -------------------------- Example 2: Get information about an Azure SQL Database server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command gets information about the Azure SQL Database server named server01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 Location : Central US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : + + + + + + + + + + + + -------------------------- Example 3: Get all Azure SQL Servers in the subscription -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMResourceGroup | Get-AzureRMSqlServer + + This command gets information about all the Azure SQL Database servers in the current subscription. + + + ResourceGroupName : resourcegroup01 ServerName : server01 Location : Central US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : + +ResourceGroupName : resourcegroup01 ServerName : server02 Location : West US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : + +ResourceGroupName : resourcegroup02 ServerName : server03 Location : East US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : + + + + + + + + + + + + + Azure SQL Database + + + + New-AzureRMSqlServer + + + + Remove-AzureRMSqlServer + + + + Set-AzureRMSqlServer + + + + + + + + Get-AzureRMSqlServerActiveDirectoryAdministrator + + Gets information about an Azure AD administrator for SQL Server. + + + + + Get + AzureRMSqlServerActiveDirectoryAdministrator + + + + The Get-AzureRMSqlServerActiveDirectoryAdministrator cmdlet gets information about an Azure Active Directory (Azure AD) administrator for an Azure SQL Server in the current subscription. + + + + Get-AzureRMSqlServerActiveDirectoryAdministrator + + ServerName + + Specifies the name of the SQL Server for which this cmdlet gets information. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the SQL Server for which this cmdlet gets information. + + String + + + + + + ServerName + + Specifies the name of the SQL Server for which this cmdlet gets information. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the SQL Server for which this cmdlet gets information. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Gets information about an administrator for a server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" + + + This command gets information about an Azure AD administrator for a server named Server06 that is associated with resource group named Resourcegroup01. + + + ResourceGroupName ServerName DisplayName ObjectId +----------------- ---------- ----------- -------- +resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b + + + + + + + + + + + + + Remove-AzureRMSqlServerActiveDirectoryAdministrator + + + + Set-AzureRMSqlServerActiveDirectoryAdministrator + + + + + + + + Get-AzureRMSqlServerAuditingPolicy + + Gets the auditing policy of an Azure SQL server. + + + + + Get + AzureRMSqlServerAuditingPolicy + + + + The Get-AzureRMSqlServerAuditingPolicy cmdlet gets the auditing policy of an Azure SQL server. Specify the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database. This cmdlet returns a policy that is used by the Azure SQL databases that are both defined in the specified Azure SQL server and use its auditing policy. + + + + Get-AzureRMSqlServerAuditingPolicy + + ServerName + + Specifies the name of the Azure SQL server for which this cmdlet gets an auditing policy. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the Azure SQL server. + + String + + + + + + ServerName + + Specifies the name of the Azure SQL server for which this cmdlet gets an auditing policy. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the Azure SQL server. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get the auditing policy of an Azure SQL server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command gets the auditing policy of the server server02 in resource group resourcegroup01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 StorageAccountName : StorageKeyType : Primary EventType : {PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure...} AuditState : New RetentionInDays : 0 TableIdentifier : Server01 + + + + + + + + + + + + + + Set-AzureRMSqlServerAuditingPolicy + + + + Use-AzureRMSqlServerAuditingPolicy + + + + + + + + Get-AzureRMSqlServerFirewallRule + + Gets firewall rules for an Azure SQL Database server. + + + + + Get + AzureRMSqlServerFirewallRule + + + + The Get-AzureRMSqlServerFirewallRule cmdlet gets firewall rules for an Azure SQL Database server. If you specify the name of a firewall rule, this cmdlet gets information about that specific firewall rule. + + + + Get-AzureRMSqlServerFirewallRule + + FirewallRuleName + + Specifies the name of the firewall rule that this cmdlet gets. + + String + + + ServerName + + Specifies the name of a server. This cmdlet gets firewall rules from the server that this parameter specifies. + + String + + + ResourceGroupName + + Specifies the name of a resource group. This cmdlet gets firewall rules on a server in the resource group that this parameter specifies. + + String + + + + + + FirewallRuleName + + Specifies the name of the firewall rule that this cmdlet gets. + + String + + String + + + none + + + ServerName + + Specifies the name of a server. This cmdlet gets firewall rules from the server that this parameter specifies. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of a resource group. This cmdlet gets firewall rules on a server in the resource group that this parameter specifies. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get all rules for a server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command gets all the firewall rules for the server named server01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 StartIpAddress : 0.0.0.0 EndIpAddress : 0.0.0.0 FirewallRuleName : AllowAllWindowsAzureIps + +ResourceGroupName : resourcegroup01 ServerName : server01 StartIpAddress : 1.2.3.4 EndIpAddress : 4.3.2.1 FirewallRuleName : rule01 + + + + + + + + + + + + + + Azure SQL Database + + + + New-AzureRMSqlServerFirewallRule + + + + Remove-AzureRMSqlServerFirewallRule + + + + Set-AzureRMSqlServerFirewallRule + + + + + + + + Get-AzureRMSqlServerServiceObjective + + Gets service objectives for an Azure SQL Database server. + + + + + Get + AzureRMSqlServerServiceObjective + + + + The Get-AzureRMSqlServerServiceObjective cmdlet gets the available service objectives for an Azure SQL Database server. + + + + Get-AzureRMSqlServerServiceObjective + + ServiceObjectiveName + + Specifies the name of a service objective for an Azure SQL Database server. Valid values are: Basic, S0, S1, S2, P1, P2, and P3. + + String + + + ServerName + + Specifies the name of an Azure SQL Database server. This cmdlet gets service objectives for the server that this parameter specifies. + + String + + + DatabaseName + + Specifies the name of an Azure SQL Database. + + String + + + ResourceGroupName + + Specifies the name of a resource group. This cmdlet gets service objectives for an Azure SQL Database server in the resource group that this parameter specifies. + + String + + + + + + ServiceObjectiveName + + Specifies the name of a service objective for an Azure SQL Database server. Valid values are: Basic, S0, S1, S2, P1, P2, and P3. + + String + + String + + + none + + + ServerName + + Specifies the name of an Azure SQL Database server. This cmdlet gets service objectives for the server that this parameter specifies. + + String + + String + + + none + + + DatabaseName + + Specifies the name of an Azure SQL Database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of a resource group. This cmdlet gets service objectives for an Azure SQL Database server in the resource group that this parameter specifies. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServiceObjective.Model.AzureSqlServerServiceObjectiveModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get a service objective -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlServerServiceObjective -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command gets the service objective for the server named server01. The command specifies the database named database01. + + + ResourceGroupName ServerName ServiceObjectiveName Description Enabled IsDefault IsSystem ----------------- ---------- -------------------- ----------- ------- --------- -------- resourcegroup01 server01 ElasticPool True False False resourcegroup01 server01 System True False True resourcegroup01 server01 System0 True False True resourcegroup01 server01 System1 True False True resourcegroup01 server01 System2 True True True resourcegroup01 server01 Basic True True False resourcegroup01 server01 S0 True True False resourcegroup01 server01 S1 True False False resourcegroup01 server01 S2 True False False resourcegroup01 server01 S3 True False False resourcegroup01 server01 P1 True True False resourcegroup01 server01 P2 True False False resourcegroup01 server01 P3 True False False resourcegroup01 server01 P4 True False False + + + + + + + + + + + + + Azure SQL Database + + + + + + + + Get-AzureRMSqlServerUpgrade + + Gets the status of an Azure SQL Database server upgrade. + + + + + Get + AzureRMSqlServerUpgrade + + + + The Get-AzureRMSqlServerUpgrade cmdlet gets the status of an Azure SQL Database server upgrade. + + + + Get-AzureRMSqlServerUpgrade + + ServerName + + Specifies the name of the server about which this cmdlet gets upgrade status. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the server about which this cmdlet gets upgrade status. + + String + + + + + + ServerName + + Specifies the name of the server about which this cmdlet gets upgrade status. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the server about which this cmdlet gets upgrade status. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get the status of an upgrade -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server01" | Format-List + + + This command gets the status of an upgrade request from the server named server01 in resource group named resourcegroup01. + + + ResourceGroupName : resourcegroup01 +ServerName : server01 +Status : Queued + + + + + + + + + + + + + Start-AzureRMSqlServerUpgrade + + + + Stop-AzureRMSqlServerUpgrade + + + + + + + + Get-AzureRMSqlServerUpgradeHint + + Gets pricing tier hints for upgrading a SQL Database server. + + + + + Get + AzureRMSqlServerUpgradeHint + + + + The Get-AzureRMSqlServerUpgradeHint cmdlet gets pricing tier hints for upgrading an Azure SQL Database server. Hints may contain the elastic database pool and stand-alone database hints. Databases that are still in Web and Business pricing tiers get a hint to upgrade to the new Basic, Standard, or Premium pricing tiers, or to go into the elastic database pool. This cmdlet returns hints for all databases that the specified server hosts. + + + + Get-AzureRMSqlServerUpgradeHint + + ServerName + + Specifies the name of the server for which this cmdlet gets an upgrade hint. + + String + + + ExcludeElasticPools + + Indicates whether to exclude databases that are included in elastic database pool recommendations. + + Boolean + + + ResourceGroupName + + Specifies the name of the resource group that contains the server for which this cmdlet gets an upgrade hint. + + String + + + + + + ServerName + + Specifies the name of the server for which this cmdlet gets an upgrade hint. + + String + + String + + + none + + + ExcludeElasticPools + + Indicates whether to exclude databases that are included in elastic database pool recommendations. + + Boolean + + Boolean + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the server for which this cmdlet gets an upgrade hint. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Get combined recommendations -------------------------- + + PS C:\> + + PS C:\> Get-AzureRMSqlServerUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command gets combined recommendations for all the databases on server named server01. + + + ElasticPools Databases +------------ --------- +{} {database01, database02} + + + + + + + + + + + + + Get-AzureRMSqlDatabaseExpanded + + + + Get-AzureRMSqlElasticPoolRecommendation + + + + + + + + New-AzureRMSqlDatabase + + Creates an Azure SQL database or an elastic database. + + + + + New + AzureRMSqlDatabase + + + + The New-AzureRMSqlDatabase cmdlet creates a new Azure SQL database. +You can also create an elastic database by setting the ElasticPoolName parameter to an existing elastic pool. + + + + New-AzureRMSqlDatabase + + DatabaseName + + Specifies the name of the database. + + String + + + CollationName + + Specifies the name of the Azure SQL database collation. + + String + + + CatalogCollation + + Specifies the name of the Azure SQL database catalog collation. + + String + + + MaxSizeBytes + + Specifies the maximum size of the database in bytes. + + Int64 + + + Edition + + Specifies the edition to assign to the database. Valid values are: +-- Default +-- None +-- Premium +-- Basis +-- Standard + + DatabaseEdition + + + RequestedServiceObjectiveName + + Specifies the name of the service objective to assign to the database. + + String + + + ElasticPoolName + + Specifies the name of the elastic pool in which to put the database. + + String + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new server. + + Dictionary`2[String] + + + ServerName + + Specifies the name of the server to create the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group that the server is in. + + String + + + + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + CollationName + + Specifies the name of the Azure SQL database collation. + + String + + String + + + none + + + CatalogCollation + + Specifies the name of the Azure SQL database catalog collation. + + String + + String + + + none + + + MaxSizeBytes + + Specifies the maximum size of the database in bytes. + + Int64 + + Int64 + + + none + + + Edition + + Specifies the edition to assign to the database. Valid values are: +-- Default +-- None +-- Premium +-- Basis +-- Standard + + DatabaseEdition + + DatabaseEdition + + + none + + + RequestedServiceObjectiveName + + Specifies the name of the service objective to assign to the database. + + String + + String + + + none + + + ElasticPoolName + + Specifies the name of the elastic pool in which to put the database. + + String + + String + + + none + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new server. + + Dictionary`2[String] + + Dictionary`2[String] + + + none + + + ServerName + + Specifies the name of the server to create the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is in. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Create an database in a specified server -------------------------- + + PS C:\> + + PS C:\> New-AzureRMSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command creates a database named database01 in server server01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 Edition : Standard CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 268435456000 Status : Online CreationDate : 7/3/2015 7:33:37 AM CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b CurrentServiceObjectiveName : S0 RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : Tags : + + + + + + + + + + + -------------------------- Example 2: Create an elastic database in a specified server -------------------------- + + PS C:\> + + PS C:\> New-AzureRMSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -ElasticPoolName "elasticpool01" + + This command creates a database named database01 in the elastic pool named elasticpool01 in server server01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database02 Location : Central US DatabaseId : 7bd9d561-42a7-484e-bf05-62ddef8015ab Edition : Standard CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 268435456000 Status : Online CreationDate : 8/26/2015 10:04:29 PM CurrentServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 CurrentServiceObjectiveName : ElasticPool RequestedServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 RequestedServiceObjectiveName : ElasticPoolName : elasticpool01 EarliestRestoreDate : Tags : + + + + + + + + + + + + + Get-AzureRMSqlDatabase + + + + Remove-AzureRMSqlDatabase + + + + Resume-AzureRMSqlDatabase + + + + Set-AzureRMSqlDatabase + + + + Suspend-AzureRMSqlDatabase + + + + Azure SQL Database + + + + New-AzureRMSqlServer + + + + New-AzureRMSqlElasticPool + + + + + + + + New-AzureRMSqlDatabaseCopy + + Creates a copy of an existing Azure SQL Database using the snapshot of the data at the time of the call. + + + + + New + AzureRMSqlDatabaseCopy + + + + This cmdlet replaces the Start-AzureRqlDatabaseCopy cmdlet when used to create a one-time database copy. It returns the database object of the copy. + Note: Use New-AzureRMSqlDatabaseSecondary for setting up geo-replication for a database. + + + + New-AzureRMSqlDatabaseCopy + + DatabaseName + + The name of the Azure SQL Database to be copied. + + String + + + ServiceObjectiveName + + The name of the service objective to assign to the copy. + + String + + + ElasticPoolName + + The name of the Elastic Pool to put the copy in. + + String + + + Tags + + The tags to associate with the Azure SQL Database copy. + + Dictionary`2[String] + + + CopyResourceGroupName + + The name of the Azure Resource Group to create copy in. + + String + + + CopyServerName + + The name of the Azure SQL Server to create copy in. + + String + + + CopyDatabaseName + + The name of the Azure SQL Database copy. + + String + + + ServerName + + The name of the Azure SQL Server the database to be copied is in. + + String + + + ResourceGroupName + + The name of the Azure Resource Group the database to be copied is in. + + String + + + + + + DatabaseName + + The name of the Azure SQL Database to be copied. + + String + + String + + + + + + ServiceObjectiveName + + The name of the service objective to assign to the copy. + + String + + String + + + + + + ElasticPoolName + + The name of the Elastic Pool to put the copy in. + + String + + String + + + + + + Tags + + The tags to associate with the Azure SQL Database copy. + + Dictionary`2[String] + + Dictionary`2[String] + + + + + + CopyResourceGroupName + + The name of the Azure Resource Group to create copy in. + + String + + String + + + + + + CopyServerName + + The name of the Azure SQL Server to create copy in. + + String + + String + + + + + + CopyDatabaseName + + The name of the Azure SQL Database copy. + + String + + String + + + + + + ServerName + + The name of the Azure SQL Server the database to be copied is in. + + String + + String + + + + + + ResourceGroupName + + The name of the Azure Resource Group the database to be copied is in. + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + New-AzureRMSqlDatabaseDataMaskingRule + + Creates a data masking rule for an Azure SQL database. + + + + + New + AzureRMSqlDatabaseDataMaskingRule + + + + The New-AzureRMSqlDatabaseDataMaskingRule cmdlet is used to create a data masking rule in an Azure SQL database. To use the cmdlet, use the ResourceGroupName, ServerName, DatabaseName, and RuleId parameters to identify the rule. Provide the TableName and ColumnName to specify the target of the rule and the MaskingFunction parameter to define how the data is masked. + If MaskingFunction has a value of Number or Text, you can specify the NumberFrom and NumberTo parameters, for number masking, or the PrefixSize, ReplacementString, and SuffixSize for text masking. + If the command succeeds and the PassThru parameter is used, the cmdlet returns an object describing the data masking rule properties as well as the rule identifiers. Rule identifiers include, but are not limited to, ResourceGroupName, ServerName, DatabaseName, and RuleID. + + + + New-AzureRMSqlDatabaseDataMaskingRule + + ColumnName + + Specifies the name of the column that is the target of this masking rule. + + String + + + SchemaName + + + + String + + + TableName + + Specifies the name of the table in the database of which the masked column is part. + + String + + + MaskingFunction + + Specifies the masking function that the rule uses. Valid values are: + -- Default +-- NoMasking +-- Text +-- Number +-- SocialSecurityNumber +-- CreditCardNumber +-- Email + The default value is Default. + + String + + + PrefixSize + + Specifies the number of characters in the beginning of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + Nullable`1[UInt32] + + + ReplacementString + + Specifies the number of characters in the end of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is an empty string. + + String + + + SuffixSize + + Specifies the number of characters in the end of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + Nullable`1[UInt32] + + + NumberFrom + + Specifies the lower bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of Number for the MaskingFunction parameter. The default value is 0. + + Nullable`1[Double] + + + NumberTo + + Specifies the upper bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of Number for the MaskingFunction parameter. The default value is 0. + + Nullable`1[Double] + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + + RuleId + + Specifies the identifier for the data masking rule. + + String + + + ServerName + + Specifies the name of the server that contains the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + + + + + ColumnName + + Specifies the name of the column that is the target of this masking rule. + + String + + String + + + none + + + SchemaName + + + + String + + String + + + none + + + TableName + + Specifies the name of the table in the database of which the masked column is part. + + String + + String + + + none + + + MaskingFunction + + Specifies the masking function that the rule uses. Valid values are: + -- Default +-- NoMasking +-- Text +-- Number +-- SocialSecurityNumber +-- CreditCardNumber +-- Email + The default value is Default. + + String + + String + + + none + + + PrefixSize + + Specifies the number of characters in the beginning of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + Nullable`1[UInt32] + + Nullable`1[UInt32] + + + none + + + ReplacementString + + Specifies the number of characters in the end of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is an empty string. + + String + + String + + + none + + + SuffixSize + + Specifies the number of characters in the end of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + Nullable`1[UInt32] + + Nullable`1[UInt32] + + + none + + + NumberFrom + + Specifies the lower bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of Number for the MaskingFunction parameter. The default value is 0. + + Nullable`1[Double] + + Nullable`1[Double] + + + none + + + NumberTo + + Specifies the upper bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of Number for the MaskingFunction parameter. The default value is 0. + + Nullable`1[Double] + + Nullable`1[Double] + + + none + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + RuleId + + Specifies the identifier for the data masking rule. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that contains the database. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Create a data masking rule for a number column in a database -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -RuleId "rule01" -SchemaName "schema01" -TableName "table01" -ColumnName "column01" -MaskingFunction Number -NumberFrom 5 -NumberTo 14 + + This command creates a data masking rule for the column named column01 in the table named table01 in the schema named schema01. database01 contains all these elements. The rule is a number masking rule that uses a random number between 5 and 14 as the masked value. The rule is named rule01. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseDataMaskingRule + + + + Remove-AzureRMSqlDatabaseDataMaskingRule + + + + Set-AzureRMSqlDatabaseDataMaskingRule + + + + Azure SQL Database + + + + + + + + New-AzureRMSqlDatabaseSecondary + + Creates a new secondary database for an existing Azure SQL Database and starts data replication. + + + + + New + AzureRMSqlDatabaseSecondary + + + + This cmdlet replaces the Start-AzureSqlDatabaseCopy cmdlet when used for setting up geo-replication for a database. It returns the geo-replication link object from the primary to the secondary database. + + + + New-AzureRMSqlDatabaseSecondary + + DatabaseName + + The name of the Azure SQL Database to act as primary. + + String + + + SecondaryServiceObjectiveName + + The name of the service objective to assign to the secondary. + + String + + + SecondaryElasticPoolName + + The name of the Elastic Pool to put the secondary in. + + String + + + Tags + + The tags to associate with the Azure SQL Database replication link. + + Dictionary`2[String] + + + PartnerResourceGroupName + + The name of the Azure Resource Group to create secondary in. + + String + + + PartnerServerName + + The name of the Azure SQL Server to create secondary in. + + String + + + AllowConnections + + The read intent of the secondary Azure SQL Database. + + AllowConnections + + + ServerName + + The name of the Azure SQL Server of the primary Azure SQL Database. + + String + + + ResourceGroupName + + The name of the Azure Resource Group of the primary Azure SQL Database. + + String + + + + + + DatabaseName + + The name of the Azure SQL Database to act as primary. + + String + + String + + + + + + SecondaryServiceObjectiveName + + The name of the service objective to assign to the secondary. + + String + + String + + + + + + SecondaryElasticPoolName + + The name of the Elastic Pool to put the secondary in. + + String + + String + + + + + + Tags + + The tags to associate with the Azure SQL Database replication link. + + Dictionary`2[String] + + Dictionary`2[String] + + + + + + PartnerResourceGroupName + + The name of the Azure Resource Group to create secondary in. + + String + + String + + + + + + PartnerServerName + + The name of the Azure SQL Server to create secondary in. + + String + + String + + + + + + AllowConnections + + The read intent of the secondary Azure SQL Database. + + AllowConnections + + AllowConnections + + + + + + ServerName + + The name of the Azure SQL Server of the primary Azure SQL Database. + + String + + String + + + + + + ResourceGroupName + + The name of the Azure Resource Group of the primary Azure SQL Database. + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + New-AzureRMSqlElasticPool + + Creates an elastic database pool in Azure SQL Database. + + + + + New + AzureRMSqlElasticPool + + + + The New-AzureRMSqlElasticPool cmdlet creates an elastic database pool in Azure SQL Database. + + + + New-AzureRMSqlElasticPool + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet creates. + + String + + + Edition + + Specifies the edition of Azure SQL Database for the elastic pool. Valid values are: + -- Premium +-- Basic +-- Standard + For the current preview, the edition must be Standard. + + DatabaseEdition + + + Dtu + + Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are as follows: + -- Basic. 100 DTUs +-- Standard. 100 DTUs +-- Premium. 125 DTUs + + Int32 + + + StorageMB + + Specifies the storage limit, in megabytes, for the elastic pool. You cannot specify a value for this parameter for the Premium edition. + If you do not specify this parameter, this cmdlet calculates a value based on the value of the Dtu parameter. We recommend that you do not specify the StorageMB parameter. + If you specify StorageMB, but do not specify Dtu, the cmdlet calculates a value for Dtu. If you specify values for both, the values must be consistent. For more information about the relationship between storage and DTUs, see eDTU and storage limits for elastic pools and elastic databases. + + Int32 + + + DatabaseDtuMin + + Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. The default value is zero (0). + + Int32 + + + DatabaseDtuMax + + Specifies the maximum number of Database Throughput Units (DTUs) that any single database in the pool can consume. The default values for different editions are as follows: + -- Basic. 5 DTUs +-- Standard. 100 DTUs +-- Premium. 125 DTUs + + Int32 + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the elastic pool. + + Dictionary`2[String] + + + ServerName + + Specifies the name of the server in which this cmdlet creates the elastic pool. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the elastic pool that this cmdlet creates. + + String + + + + + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet creates. + + String + + String + + + none + + + Edition + + Specifies the edition of Azure SQL Database for the elastic pool. Valid values are: + -- Premium +-- Basic +-- Standard + For the current preview, the edition must be Standard. + + DatabaseEdition + + DatabaseEdition + + + none + + + Dtu + + Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are as follows: + -- Basic. 100 DTUs +-- Standard. 100 DTUs +-- Premium. 125 DTUs + + Int32 + + Int32 + + + none + + + StorageMB + + Specifies the storage limit, in megabytes, for the elastic pool. You cannot specify a value for this parameter for the Premium edition. + If you do not specify this parameter, this cmdlet calculates a value based on the value of the Dtu parameter. We recommend that you do not specify the StorageMB parameter. + If you specify StorageMB, but do not specify Dtu, the cmdlet calculates a value for Dtu. If you specify values for both, the values must be consistent. For more information about the relationship between storage and DTUs, see eDTU and storage limits for elastic pools and elastic databases. + + Int32 + + Int32 + + + none + + + DatabaseDtuMin + + Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. The default value is zero (0). + + Int32 + + Int32 + + + none + + + DatabaseDtuMax + + Specifies the maximum number of Database Throughput Units (DTUs) that any single database in the pool can consume. The default values for different editions are as follows: + -- Basic. 5 DTUs +-- Standard. 100 DTUs +-- Premium. 125 DTUs + + Int32 + + Int32 + + + none + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the elastic pool. + + Dictionary`2[String] + + Dictionary`2[String] + + + none + + + ServerName + + Specifies the name of the server in which this cmdlet creates the elastic pool. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the elastic pool that this cmdlet creates. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Create an elastic pool -------------------------- + + PS C:\> + + PS C:\> New-AzureRMSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" -Edition "Standard" -Dtu 400 -DatabaseDtuMin 10 -DatabaseDtuMax 100 + + This command creates an elastic pool in the Standard service tier named elasticpool01. The server named server01 hosts the elastic pool in an Azure resource group named resourcegroup01. The command specifies DTU property values for the pool and the databases in the pool. + + + ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 Location : Central US CreationDate : 8/26/2015 10:00:17 PM State : Ready Edition : Standard Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 Tags : + + + + + + + + + + + + + + Azure SQL Database + + + + Get-AzureRMSqlElasticPool + + + + Get-AzureRMSqlElasticPoolActivity + + + + Get-AzureRMSqlElasticPoolDatabase + + + + Remove-AzureRMSqlElasticPool + + + + Set-AzureRMSqlElasticPool + + + + + + + + New-AzureRMSqlServer + + Creates an Azure SQL Database server. + + + + + New + AzureRMSqlServer + + + + The New-AzureRMSqlServer cmdlet creates an Azure SQL Database server. + + + + New-AzureRMSqlServer + + ServerName + + Specifies the name of the new server. + + String + + + SqlAdministratorCredentials + + Specifies the SQL Database server administrator credential for the new server. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential. + + PSCredential + + + Location + + Specifies the location of the data center where this cmdlet creates the server. + + String + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new server. + + Dictionary`2[String] + + + ServerVersion + + Specifies the version of the new server. Valid values are: 2.0 and 12.0. + Specify 2.0 to create a version 11 server, or 12.0 to create a version 12 server. + + String + + + ResourceGroupName + + Specifies the name of the resource group in which this cmdlet creates the server. + + String + + + + + + ServerName + + Specifies the name of the new server. + + String + + String + + + none + + + SqlAdministratorCredentials + + Specifies the SQL Database server administrator credential for the new server. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential. + + PSCredential + + PSCredential + + + none + + + Location + + Specifies the location of the data center where this cmdlet creates the server. + + String + + String + + + none + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new server. + + Dictionary`2[String] + + Dictionary`2[String] + + + none + + + ServerVersion + + Specifies the version of the new server. Valid values are: 2.0 and 12.0. + Specify 2.0 to create a version 11 server, or 12.0 to create a version 12 server. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group in which this cmdlet creates the server. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Create a new Azure SQL Database server -------------------------- + + PS C:\> + + PS C:\> New-AzureRMSqlServer -ResourceGroupName "resourcegroup01" -Location "Central US" -ServerName "server01" -ServerVersion "12.0" + + This command creates a version 12 Azure SQL Database server. + + + ResourceGroupName : resourcegroup01 ServerName : server01 Location : Australia East SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : + + + + + + + + + + + + + + Azure SQL Database + + + + Get-AzureRMSqlServer + + + + Remove-AzureRMSqlServer + + + + Set-AzureRMSqlServer + + + + New-AzureRMSqlServerFirewallRule + + + + + + + + New-AzureRMSqlServerFirewallRule + + Creates a firewall rule for an Azure SQL Database server. + + + + + New + AzureRMSqlServerFirewallRule + + + + The New-AzureRMSqlServerFirewallRule cmdlet creates a firewall rule for the specified Azure SQL Database server. + + + + New-AzureRMSqlServerFirewallRule + + AllowAllAzureIPs + + Indicates that this firewall rule enables all Azure IP addresses to access the server. + + SwitchParameter + + + ServerName + + Specifies the name of a server. This cmdlet creates a firewall rule on the server that this cmdlet specifies. Specify the server name, not the fully qualified DNS name. + + String + + + ResourceGroupName + + Specifies the name of a resource group that contains a server. This cmdlet creates a firewall rule on a server in the resource group that this cmdlet specifies. + + String + + + + New-AzureRMSqlServerFirewallRule + + FirewallRuleName + + Specifies the name of the new firewall rule. + + String + + + StartIpAddress + + Specifies the start value of the IP address range for the firewall rule. + + String + + + EndIpAddress + + Specifies the end value of the IP address range for this rule. + + String + + + ServerName + + Specifies the name of a server. This cmdlet creates a firewall rule on the server that this cmdlet specifies. Specify the server name, not the fully qualified DNS name. + + String + + + ResourceGroupName + + Specifies the name of a resource group that contains a server. This cmdlet creates a firewall rule on a server in the resource group that this cmdlet specifies. + + String + + + + + + FirewallRuleName + + Specifies the name of the new firewall rule. + + String + + String + + + none + + + StartIpAddress + + Specifies the start value of the IP address range for the firewall rule. + + String + + String + + + none + + + EndIpAddress + + Specifies the end value of the IP address range for this rule. + + String + + String + + + none + + + ServerName + + Specifies the name of a server. This cmdlet creates a firewall rule on the server that this cmdlet specifies. Specify the server name, not the fully qualified DNS name. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of a resource group that contains a server. This cmdlet creates a firewall rule on a server in the resource group that this cmdlet specifies. + + String + + String + + + none + + + AllowAllAzureIPs + + Indicates that this firewall rule enables all Azure IP addresses to access the server. + + SwitchParameter + + SwitchParameter + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Create a firewall rule -------------------------- + + PS C:\> + + PS C:\> New-AzureRMSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -FirewallRuleName "rule01" -StartIpAddress "192.168.0.198" -EndIpAddress "192.168.0.199" + + This command creates a firewall rule named rule01 on the server named server01. The rule includes the specified start and end IP addresses. + + + ResourceGroupName : resourcegroup01 ServerName : server01 StartIpAddress : 192.168.0.198 EndIpAddress : 192.168.0.199 FirewallRuleName : rule01 + + + + + + + + + + + + + Azure SQL Database + + + + Get-AzureRMSqlServerFirewallRule + + + + Remove-AzureRMSqlServerFirewallRule + + + + Set-AzureRMSqlServerFirewallRule + + + + + + + + Remove-AzureRMSqlDatabase + + Removes an Azure SQL database. + + + + + Remove + AzureRMSqlDatabase + + + + The Remove-AzureRMSqlDatabase cmdlet removes an Azure SQL database. + + + + Remove-AzureRMSqlDatabase + + DatabaseName + + Specifies the name of the database that this cmdlet removes. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + + ServerName + + Specifies the name of the server the database is in. + + String + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + + + + + DatabaseName + + Specifies the name of the database that this cmdlet removes. + + String + + String + + + none + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ServerName + + Specifies the name of the server the database is in. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + none + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + false + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Remove a database from an Azure SQL server -------------------------- + + PS C:\> + + PS C:\> Remove-AzureRMSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command removes the database named database01 from server server01. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabase + + + + New-AzureRMSqlDatabase + + + + Resume-AzureRMSqlDatabase + + + + Set-AzureRMSqlDatabase + + + + Suspend-AzureRMSqlDatabase + + + + Azure SQL Database + + + + + + + + Remove-AzureRMSqlDatabaseAuditing + + Removes auditing of an Azure SQL database. + + + + + Remove + AzureRMSqlDatabaseAuditing + + + + The Remove-AzureRMSqlDatabaseAuditing cmdlet removes the auditing of an Azure SQL database. To use this cmdlet, use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database. After you run this cmdlet, auditing of the database is not performed. If the command succeeds and you have used the PassThru parameter, the cmdlet returns an object describing the current auditing policy, as well as the database identifiers. Database identifiers include, but are not limited to, the ResourceGroupName, ServerName and DatabaseName. + + + + Remove-AzureRMSqlDatabaseAuditing + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + + ServerName + + Specifies the name of the server containing the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group containing the database. + + String + + + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + ServerName + + Specifies the name of the server containing the database. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group containing the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Remove the auditing of an Azure SQL database -------------------------- + + PS C:\> + + PS C:\> Remove-AzureRMSqlDatabaseAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command removes the auditing of database named database01. That database is located on server01 in the resource group named resourcegroup01. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseAuditingPolicy + + + + Set-AzureRMSqlDatabaseAuditingPolicy + + + + Azure SQL Database + + + + + + + + Remove-AzureRMSqlDatabaseDataMaskingRule + + Removes a data masking rule from an Azure SQL database. + + + + + Remove + AzureRMSqlDatabaseDataMaskingRule + + + + The Remove-AzureRMSqlDatabaseDataMaskingRule cmdlet removes a specific data masking rule from an Azure SQL database. You can remove a data masking rule by using the ResourceGroupName, ServerName, DatabaseName, and RuleId parameters to identify the rule to be removed. + + + + Remove-AzureRMSqlDatabaseDataMaskingRule + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + + RuleId + + Specifies the identifier for the data masking rule. + + String + + + ServerName + + Specifies the name of the server that contains the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + RuleId + + Specifies the identifier for the data masking rule. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that contains the database. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + String + + + none + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + false + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Remove a database data masking rule -------------------------- + + PS C:\> + + PS C:\> Remove-AzureRMSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -RuleId "rule01" + + This command removes the rule that has the ID rule01, that was defined for the database database01 located in server01 in resource group resourcegroup01. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseDataMaskingRule + + + + New-AzureRMSqlDatabaseDataMaskingRule + + + + Set-AzureRMSqlDatabaseDataMaskingRule + + + + Azure SQL Database + + + + + + + + Remove-AzureRMSqlDatabaseSecondary + + Terminates data replication between an Azure SQL Database and the specified secondary database. + + + + + Remove + AzureRMSqlDatabaseSecondary + + + + This cmdlet replaces the Stop-AzureSqlDatabaseCopy cmdlet. It will force terminates the geo-replication link. There is no replication synchronization prior to termination. + + + + Remove-AzureRMSqlDatabaseSecondary + + DatabaseName + + The name of the primary Azure SQL Database with the replication link to remove. + + String + + + PartnerResourceGroupName + + The name of the partner Azure Resource Group. + + String + + + PartnerServerName + + The name of the partner Azure SQL Server. + + String + + + ServerName + + The name of the Azure SQL Server with the replication link to remove. + + String + + + ResourceGroupName + + The name of the Azure Resource Group with the replication link to remove. + + String + + + + + + DatabaseName + + The name of the primary Azure SQL Database with the replication link to remove. + + String + + String + + + + + + PartnerResourceGroupName + + The name of the partner Azure Resource Group. + + String + + String + + + + + + PartnerServerName + + The name of the partner Azure SQL Server. + + String + + String + + + + + + ServerName + + The name of the Azure SQL Server with the replication link to remove. + + String + + String + + + + + + ResourceGroupName + + The name of the Azure Resource Group with the replication link to remove. + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Remove-AzureRMSqlElasticPool + + Deletes an elastic database pool. + + + + + Remove + AzureRMSqlElasticPool + + + + The Remove-AzureRMSqlElasticPool cmdlet deletes an elastic pool in Azure SQL Database. + + + + Remove-AzureRMSqlElasticPool + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet deletes. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + + ServerName + + Specifies the name of the server that contains the elastic pool that this cmdlet modifies. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the elastic pool that this cmdlet deletes. + + String + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + + + + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet deletes. + + String + + String + + + none + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ServerName + + Specifies the name of the server that contains the elastic pool that this cmdlet modifies. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the elastic pool that this cmdlet deletes. + + String + + String + + + none + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + false + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Delete an elastic pool -------------------------- + + PS C:\> + + PS C:\> Remove-AzureRMSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" + + This command deletes an elastic pool named elasticpool01. + + + + + + + + + + + + + + + + Azure SQL Database + + + + Get-AzureRMSqlElasticPool + + + + Get-AzureRMSqlElasticPoolActivity + + + + Get-AzureRMSqlElasticPoolDatabase + + + + New-AzureRMSqlElasticPool + + + + Set-AzureRMSqlElasticPool + + + + + + + + Remove-AzureRMSqlServer + + Removes an Azure SQL Database server. + + + + + Remove + AzureRMSqlServer + + + + The Remove-AzureRMSqlServer cmdlet removes an Azure SQL Database server. + + + + Remove-AzureRMSqlServer + + ServerName + + Specifies the name of the server that this cmdlet removes. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + + ResourceGroupName + + Specifies the name of the resource group that contains the server that this cmdlet removes. + + String + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + + + + + ServerName + + Specifies the name of the server that this cmdlet removes. + + String + + String + + + none + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the server that this cmdlet removes. + + String + + String + + + none + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + false + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Remove a server -------------------------- + + PS C:\> + + PS C:\> Remove-AzureRMSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command removes the Azure SQL Database server named server01. + + + + + + + + + + + + + + + + Azure SQL Database + + + + Get-AzureRMSqlServer + + + + New-AzureRMSqlServer + + + + Set-AzureRMSqlServer + + + + + + + + Remove-AzureRMSqlServerActiveDirectoryAdministrator + + Removes an Azure AD administrator for SQL Server. + + + + + Remove + AzureRMSqlServerActiveDirectoryAdministrator + + + + The Remove-AzureRMSqlServerActiveDirectoryAdministrator cmdlet removes an Azure Active Directory (Azure AD) administrator for Azure SQL Server in the current subscription. + + + + Remove-AzureRMSqlServerActiveDirectoryAdministrator + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + + ServerName + + Specifies the name of the SQL Server for which this cmdlet removes an administrator. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the SQL Server for which this cmdlet removes an administrator. + + String + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + + + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ServerName + + Specifies the name of the SQL Server for which this cmdlet removes an administrator. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the SQL Server for which this cmdlet removes an administrator. + + String + + String + + + none + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + false + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Remove an administrator -------------------------- + + PS C:\> + + PS C:\> Remove-AzureRMSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" + + + Removes the Azure AD administrator for the server named server01 that is associated with resource group resourcegroup01. + + + Confirm +Are you sure you want to remove the Azure Sql Server Active Directory Administrator on server 'server01'? +[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y + +ResourceGroupName ServerName DisplayName ObjectId +----------------- ---------- ----------- -------- +resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b + + + + + + + + + + + + + Get-AzureRMSqlServerActiveDirectoryAdministrator + + + + Set-AzureRMSqlServerActiveDirectoryAdministrator + + + + + + + + Remove-AzureRMSqlServerAuditing + + Removes auditing of an Azure SQL server. + + + + + Remove + AzureRMSqlServerAuditing + + + + The Remove-AzureRMSqlServerAuditing cmdlet removes the auditing of an Azure SQL server. To use this cmdlet, specify the ResourceGroupName and ServerName parameters to identify the server. After you run this cmdlet, auditing of the databases in the provided Azure SQL server, that are defined as using this policy of that Azure SQL server, is not performed. If the command succeeds, and you specify the PassThru parameter, the cmdlet returns an object that describes the current auditing policy and the Azure SQL server identifiers. Server identifiers include the ResourceGroupName and ServerName. + + + + Remove-AzureRMSqlServerAuditing + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + + ServerName + + Specifies the name of the Azure SQL server. + + String + + + ResourceGroupName + + Specifies the name of the resource group of the Azure SQL server. + + String + + + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + ServerName + + Specifies the name of the Azure SQL server. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group of the Azure SQL server. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Remove the auditing of an Azure SQL server -------------------------- + + PS C:\> + + PS C:\> Remove-AzureRMSqlDatabaseAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command removes the auditing of all the databases located in server01 in resource group resourcegroup01 that use the policy of that server. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseAuditingPolicy + + + + Set-AzureRMSqlDatabaseAuditingPolicy + + + + + + + + Remove-AzureRMSqlServerFirewallRule + + Deletes a firewall rule from an Azure SQL Database server. + + + + + Remove + AzureRMSqlServerFirewallRule + + + + The Remove-AzureRMSqlServerFirewallRule cmdlet deletes a firewall rule from the specified Azure SQL Database server. + + + + Remove-AzureRMSqlServerFirewallRule + + FirewallRuleName + + Specifies the name of the firewall rule that this cmdlet deletes. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + + ServerName + + Specifies the name of a server. This cmdlet deletes a firewall rule from the server that this parameter specifies. + + String + + + ResourceGroupName + + Specifies the name of a resource group. This cmdlet deletes a firewall rule on a server in the resource group that this parameter specifies. + + String + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + + + + + FirewallRuleName + + Specifies the name of the firewall rule that this cmdlet deletes. + + String + + String + + + none + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ServerName + + Specifies the name of a server. This cmdlet deletes a firewall rule from the server that this parameter specifies. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of a resource group. This cmdlet deletes a firewall rule on a server in the resource group that this parameter specifies. + + String + + String + + + none + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + false + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Delete a rule -------------------------- + + PS C:\> + + PS C:\> Remove-AzureRMSqlServerFirewallRule -FirewallRuleName "rule01" -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command deletes a firewall rule named rule01 on the server named server01. + + + + + + + + + + + + + + + + Azure SQL Database + + + + Get-AzureRMSqlServerFirewallRule + + + + New-AzureRMSqlServerFirewallRule + + + + Set-AzureRMSqlServerFirewallRule + + + + + + + + Resume-AzureRMSqlDatabase + + Resumes an Azure SQL Data Warehouse database. + + + + + Resume + AzureRMSqlDatabase + + + + The Resume-AzureRMSqlDatabase cmdlet resumes an Azure SQL Data Warehouse database. + + + + Resume-AzureRMSqlDatabase + + ServerName + + Specifies the name of the server that hosts the database that this cmdlet resumes. + + String + + + DatabaseName + + Specifies the name of the database that this cmdlet resumes. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database that this cmdlet resumes. + + String + + + + + + ServerName + + Specifies the name of the server that hosts the database that this cmdlet resumes. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database that this cmdlet resumes. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database that this cmdlet resumes. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + This Resume-AzureRMSqlDatabase cmdlet works only on Azure SQL Data Warehouse databases. This operation is not supported on Azure SQL Database Basic, Standard and Premium editions. + + + + + -------------------------- Example 1: Resumes an Azure SQL Data Warehouse database -------------------------- + + PS C:\> + + PS C:\> Resume-AzureSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command resumes a suspended Azure SQL Data Warehouse database. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabase + + + + New-AzureRMSqlDatabase + + + + Remove-AzureRMSqlDatabase + + + + Set-AzureRMSqlDatabase + + + + Suspend-AzureRMSqlDatabase + + + + + + + + Set-AzureRMSqlDatabase + + Sets properties for an Azure SQL database, or moves an existing database into an elastic pool. + + + + + Set + AzureRMSqlDatabase + + + + The Set-AzureRMSqlDatabase cmdlet sets properties for an Azure SQL database. You can specify the ElasticPoolName parameter to move a database into an elastic pool. If database is already in an elastic pool, you can specify the RequestedServiceObjectiveName parameter to assign a performance level. + + + + Set-AzureRMSqlDatabase + + DatabaseName + + Specifies the name of the database. + + String + + + MaxSizeBytes + + Specifies the new maximum size for the database in bytes. You can specify either this parameter or MaxSizeGB. See the MaxSizeGB parameter for acceptable values based on edition. + + Int64 + + + Edition + + Specifies the edition for the database. Valid values are: +-- Default +-- None +-- Premium +-- Basic +-- Standard + + DatabaseEdition + + + RequestedServiceObjectiveName + + Specifies the name of the service objective to assign to the database. For information about service objectives, see Azure SQL Database Service Tiers and Performance Levels (https://msdn.microsoft.com/en-us/library/azure/dn741336.aspx) in the Microsoft Developer Library. + + String + + + ElasticPoolName + + Specifies name of the elastic pool in which to put the database. + + String + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new server. + + Dictionary`2[String] + + + ServerName + + Specifies the name of the server that contains the database. + + String + + + ResourceGroupName + + Specifies the name of resource group of the server that contains the database. + + String + + + + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + MaxSizeBytes + + Specifies the new maximum size for the database in bytes. You can specify either this parameter or MaxSizeGB. See the MaxSizeGB parameter for acceptable values based on edition. + + Int64 + + Int64 + + + none + + + Edition + + Specifies the edition for the database. Valid values are: +-- Default +-- None +-- Premium +-- Basic +-- Standard + + DatabaseEdition + + DatabaseEdition + + + none + + + RequestedServiceObjectiveName + + Specifies the name of the service objective to assign to the database. For information about service objectives, see Azure SQL Database Service Tiers and Performance Levels (https://msdn.microsoft.com/en-us/library/azure/dn741336.aspx) in the Microsoft Developer Library. + + String + + String + + + none + + + ElasticPoolName + + Specifies name of the elastic pool in which to put the database. + + String + + String + + + none + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new server. + + Dictionary`2[String] + + Dictionary`2[String] + + + none + + + ServerName + + Specifies the name of the server that contains the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of resource group of the server that contains the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Update a database to a Standard S2 database -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlDatabase -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ServerName "server01" -Edition "Standard" -RequestedServiceObjectiveName "S2" + + This command updates a database named database01 to a Standard S2 database in a server named server01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 Edition : Standard CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 268435456000 Status : Online CreationDate : 7/3/2015 7:33:37 AM CurrentServiceObjectiveId : 455330e1-00cd-488b-b5fa-177c226f28b7 CurrentServiceObjectiveName : S2 RequestedServiceObjectiveId : 455330e1-00cd-488b-b5fa-177c226f28b7 RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : Tags : + + + + + + + + + + + + -------------------------- Example 2: Add a database to an elastic pool -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlDatabase -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ServerName "server01" -ElasticPoolName "elasticpool01" + + The following command adds a database named database01 to the elastic pool named elasticpool01 in the server named server01. + + + ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 Edition : Standard CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 268435456000 Status : Online CreationDate : 7/3/2015 7:33:37 AM CurrentServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 CurrentServiceObjectiveName : ElasticPool RequestedServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 RequestedServiceObjectiveName : ElasticPoolName : elasticpool01 EarliestRestoreDate : Tags : + + + + + + + + + + + + + Get-AzureRMSqlDatabase + + + + New-AzureRMSqlDatabase + + + + Remove-AzureRMSqlDatabase + + + + Resume-AzureRMSqlDatabase + + + + Suspend-AzureRMSqlDatabase + + + + Azure SQL Database + + + + + + + + Set-AzureRMSqlDatabaseAuditingPolicy + + Sets the auditing policy for an Azure SQL database. + + + + + Set + AzureRMSqlDatabaseAuditingPolicy + + + + The Set-AzureRMSqlDatabaseAuditingPolicy cmdlet changes the auditing policy of an Azure SQL database. To use the cmdlet, use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database. Specify the StorageAccountName parameter to specify the storage account to be used for the audit logs and the StorageKeyType parameter to define which of that storage keys to use. + You can also define retention for the audit logs table by setting the value of the RetentionInDays and TableIdentifier parameters to define the period and the seed for the names of the audit logs tables. Specify the EventType parameter to define which event types to audit. + After the cmdlet runs successfully, auditing of the database is enabled. If the database used the policy of its server for auditing before you ran this cmdlet, auditing stops using the policy of its server. If the cmdlet succeeds and you use the PassThru parameter, it returns an object describing the current auditing policy, as well as the database identifiers. Database identifiers include, but are not limited to, ResourceGroupName, ServerName, and DatabaseName. + + + + Set-AzureRMSqlDatabaseAuditingPolicy + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + + EventType + + Specifies the event types to audit. Valid values are: + -- PlainSQL_Success +-- PlainSQL_Failure +-- ParameterizedSQL_Success +-- ParameterizedSQL_Failure +-- StoredProcedure_Success +-- StoredProcedure_Failure +-- Login_Success +-- Login_Failure +-- TransactionManagement_Success +-- TransactionManagement_Failure +-- All +-- None + You can specify several event types. You can specify All to audit all of the event types or None to specify that no events will be audited. If you specify All or None at the same time, the cmdlet fails to run. + + String[] + + + StorageAccountName + + Specifies the name of the storage account to be used when auditing the database. Wildcards are not permitted. This parameter is not required. When this parameter is not provided, the cmdlet will use the storage account that was defined previously as part of the auditing policy of the database. If this is the first time a database auditing policy is defined and this parameter is not provided, the cmdlet will fail. + + String + + + StorageKeyType + + Specifies which of the storage access keys to use. Valid values are: + -- Primary +-- Secondary + The default value is Primary. + + String + + + RetentionInDays + + Specifies the number of retention days for the audit logs table. A value of zero (0) means that the table is not retained. The default value is zero. If you specify a value greater than zero, you must specify a value for the TableIdentifer parameter. + + Nullable`1[UInt32] + + + TableIdentifier + + Specifies the name of the audit logs table. Specify this value if you specify a value greater than zero for the RetentionInDays parameter. + + String + + + ServerName + + Specifies the name of the server that contains the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + EventType + + Specifies the event types to audit. Valid values are: + -- PlainSQL_Success +-- PlainSQL_Failure +-- ParameterizedSQL_Success +-- ParameterizedSQL_Failure +-- StoredProcedure_Success +-- StoredProcedure_Failure +-- Login_Success +-- Login_Failure +-- TransactionManagement_Success +-- TransactionManagement_Failure +-- All +-- None + You can specify several event types. You can specify All to audit all of the event types or None to specify that no events will be audited. If you specify All or None at the same time, the cmdlet fails to run. + + String[] + + String[] + + + none + + + StorageAccountName + + Specifies the name of the storage account to be used when auditing the database. Wildcards are not permitted. This parameter is not required. When this parameter is not provided, the cmdlet will use the storage account that was defined previously as part of the auditing policy of the database. If this is the first time a database auditing policy is defined and this parameter is not provided, the cmdlet will fail. + + String + + String + + + none + + + StorageKeyType + + Specifies which of the storage access keys to use. Valid values are: + -- Primary +-- Secondary + The default value is Primary. + + String + + String + + + none + + + RetentionInDays + + Specifies the number of retention days for the audit logs table. A value of zero (0) means that the table is not retained. The default value is zero. If you specify a value greater than zero, you must specify a value for the TableIdentifer parameter. + + Nullable`1[UInt32] + + Nullable`1[UInt32] + + + none + + + TableIdentifier + + Specifies the name of the audit logs table. Specify this value if you specify a value greater than zero for the RetentionInDays parameter. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that contains the database. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Set the auditing policy of a database -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -StorageAccountName "Storage31" + + This command sets the auditing policy of database named database01 located in server01 to use the storage account named Storage31. + + + + + + + + + + + + + + -------------------------- Example 2: Set the storage account key of an existing auditing policy of a database -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -StorageAccountKey Secondary + + This command sets the auditing policy of database named database01 located in server01 to keep using the same storage account name, but use the secondary key. + + + + + + + + + + + + + + -------------------------- Example 3: Set the auditing policy of a database to use a specific event type -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -EventType Login_Failure + + This command sets the auditing policy of database named database01 located in server01 to log the Login_Failure event type. The command does not change the storage settings. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseAuditingPolicy + + + + Remove-AzureRMSqlDatabaseAuditing + + + + Azure SQL Database + + + + + + + + Set-AzureRMSqlDatabaseDataMaskingPolicy + + Sets data masking for an Azure SQL database. + + + + + Set + AzureRMSqlDatabaseDataMaskingPolicy + + + + The Set-AzureRMSqlDatabaseDataMaskingPolicy cmdlet sets the data masking policy for an Azure SQL database. To use this cmdlet, use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database. You can set the DataMaskingState parameter to specify whether data masking operations are enabled or disabled. You can also set the PrivilegedLogins parameter to specify which users are allowed to see the unmasked data. If the cmdlet succeeds and the PassThru parameter is used, it returns an object describing the current data masking policy as well as the database identifiers. Database identifiers include, but are not limited to, ResourceGroupName, ServerName, and DatabaseName. + + + + Set-AzureRMSqlDatabaseDataMaskingPolicy + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + + PrivilegedLogins + + Specifies a semicolon separated list of privileged user ids that can view the masking data. + + String + + + DataMaskingState + + Specifies whether data masking operation is enabled or disabled. Valid values are: +-- Enabled +-- Disabled + The default value is Enabled. + + String + + + ServerName + + Specifies the name of the server containing the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group containing the database. + + String + + + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + PrivilegedLogins + + Specifies a semicolon separated list of privileged user ids that can view the masking data. + + String + + String + + + none + + + DataMaskingState + + Specifies whether data masking operation is enabled or disabled. Valid values are: +-- Enabled +-- Disabled + The default value is Enabled. + + String + + String + + + none + + + ServerName + + Specifies the name of the server containing the database. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group containing the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingPolicyModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Set the data masking policy for a database -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlDatabaseDataMaskingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command sets the data masking policy from database named database01 on the server named server01. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseDataMaskingPolicy + + + + Get-AzureRMSqlDatabaseDataMaskingRule + + + + New-AzureRMSqlDatabaseDataMaskingRule + + + + Remove-AzureRMSqlDatabaseDataMaskingRule + + + + Set-AzureRMSqlDatabaseDataMaskingRule + + + + Azure SQL Database + + + + + + + + Set-AzureRMSqlDatabaseDataMaskingRule + + Sets the properties of a data masking rule in an Azure SQL database. + + + + + Set + AzureRMSqlDatabaseDataMaskingRule + + + + The Set-AzureRMSqlDatabaseDataMaskingRule cmdlet is used to set a data masking rule in an Azure SQL database. To use the cmdlet, provide the ResourceGroupName, ServerName, DatabaseName, and RuleId parameters to identify the rule. You can provide any of the parameters of SchemaName, TableName, and ColumnName to retarget the rule. Specify the MaskingFunction parameter to modify how the data is masked. If you specify a value of Number or Text for MaskingFunction, you can specify the NumberFrom and NumberTo parameters for number masking or the PrefixSize, ReplacementString, and SuffixSize parameters for text masking. If the command succeeds, and if you specify the PassThru parameter, the cmdlet returns an object that describe the data masking rule properties, and the rule identifiers. Rule identifiers include, but are not limited to, ResourceGroupName, ServerName,DatabaseName and RuleId. + + + + Set-AzureRMSqlDatabaseDataMaskingRule + + ColumnName + + Specifies the name of the column that is the target of this masking rule. + + String + + + TableName + + Specifies the name of the table in the database of which the masked column is part. + + String + + + SchemaName + + + + String + + + MaskingFunction + + Specifies the masking function that the rule uses. Valid values are: + -- Default +-- NoMasking +-- Text +-- Number +-- SocialSecurityNumber +-- CreditCardNumber +-- Email + The default value is Default. + + String + + + PrefixSize + + Specifies the number of characters in the beginning of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + Nullable`1[UInt32] + + + ReplacementString + + Specifies the number of characters in the end of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + String + + + SuffixSize + + Specifies the number of characters in the end of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + Nullable`1[UInt32] + + + NumberFrom + + Specifies the lower bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of Number for the MaskingFunction parameter. The default value is 0. + + Nullable`1[Double] + + + NumberTo + + Specifies the upper bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of Number for the MaskingFunction parameter. The default value is 0. + + Nullable`1[Double] + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + + RuleId + + Specifies the identifier for the data masking rule. + + String + + + ServerName + + Specifies the name of the server that contains the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + + + + + ColumnName + + Specifies the name of the column that is the target of this masking rule. + + String + + String + + + none + + + TableName + + Specifies the name of the table in the database of which the masked column is part. + + String + + String + + + none + + + SchemaName + + + + String + + String + + + none + + + MaskingFunction + + Specifies the masking function that the rule uses. Valid values are: + -- Default +-- NoMasking +-- Text +-- Number +-- SocialSecurityNumber +-- CreditCardNumber +-- Email + The default value is Default. + + String + + String + + + none + + + PrefixSize + + Specifies the number of characters in the beginning of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + Nullable`1[UInt32] + + Nullable`1[UInt32] + + + none + + + ReplacementString + + Specifies the number of characters in the end of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + String + + String + + + none + + + SuffixSize + + Specifies the number of characters in the end of the text that is not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + Nullable`1[UInt32] + + Nullable`1[UInt32] + + + none + + + NumberFrom + + Specifies the lower bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of Number for the MaskingFunction parameter. The default value is 0. + + Nullable`1[Double] + + Nullable`1[Double] + + + none + + + NumberTo + + Specifies the upper bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of Number for the MaskingFunction parameter. The default value is 0. + + Nullable`1[Double] + + Nullable`1[Double] + + + none + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + RuleId + + Specifies the identifier for the data masking rule. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that contains the database. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Change the range of a data masking rule in a database -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -RuleId "Rule17" -NumberFrom 23 -NumberTo 42 + + This command modifies a data masking rule that has the ID Rule17. That rule operates in the database named database01 on server server01. This command changes the boundaries for the interval in which a random number is generated as the masked value. The new range is between 23 and 42. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseDataMaskingRule + + + + New-AzureRMSqlDatabaseDataMaskingRule + + + + Remove-AzureRMSqlDatabaseDataMaskingRule + + + + Azure SQL Database + + + + + + + + Set-AzureRMSqlDatabaseSecondary + + Switches a secondary Azure SQL Database to the primary in order to failover. + + + + + Set + AzureRMSqlDatabaseSecondary + + + + This cmdlet is designed as a general configuration command, but at the moment it is limited to initiating failover. Use it with the -AllowDataLoss parameter to initiate a force failover during an outage. You don’t have to specify it when performing a planned operation , such as DR drill. In the latter case the secondary databases will be synchronized with the primary before switching. + + + + Set-AzureRMSqlDatabaseSecondary + + DatabaseName + + The name of the Azure SQL Database Secondary. + + String + + + PartnerResourceGroupName + + The name of the Azure Resource Group of the partner Azure SQL Database. + + String + + + Failover + + Determines if this operation is a failover. + + SwitchParameter + + + AllowDataLoss + + Determines if this failover operation will allow data loss. + + SwitchParameter + + + ServerName + + The name of the Azure SQL Server of the Azure SQL Database Secondary. + + String + + + ResourceGroupName + + The name of the Azure Resource Group of the Azure SQL Database Secondary. + + String + + + + Set-AzureRMSqlDatabaseSecondary + + DatabaseName + + The name of the Azure SQL Database Secondary. + + String + + + PartnerResourceGroupName + + The name of the Azure Resource Group of the partner Azure SQL Database. + + String + + + ServerName + + The name of the Azure SQL Server of the Azure SQL Database Secondary. + + String + + + ResourceGroupName + + The name of the Azure Resource Group of the Azure SQL Database Secondary. + + String + + + + + + DatabaseName + + The name of the Azure SQL Database Secondary. + + String + + String + + + + + + PartnerResourceGroupName + + The name of the Azure Resource Group of the partner Azure SQL Database. + + String + + String + + + + + + ServerName + + The name of the Azure SQL Server of the Azure SQL Database Secondary. + + String + + String + + + + + + ResourceGroupName + + The name of the Azure Resource Group of the Azure SQL Database Secondary. + + String + + String + + + + + + Failover + + Determines if this operation is a failover. + + SwitchParameter + + SwitchParameter + + + + + + AllowDataLoss + + Determines if this failover operation will allow data loss. + + SwitchParameter + + SwitchParameter + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Set-AzureRMSqlDatabaseTransparentDataEncryption + + Modifies TPE for an Azure SQL database. + + + + + Set + AzureRMSqlDatabaseTransparentDataEncryption + + + + The Set-AzureRMSqlDatabaseTransparentDataEncryption cmdlet modifies the Transparent Data Encryption (TDE) property of an Azure SQL database. For more information, see Transparent Data Encryption with Azure SQL Database (https://msdn.microsoft.com/library/dn948096) in the Microsoft Developer Network Library. + + + + Set-AzureRMSqlDatabaseTransparentDataEncryption + + State + + Specifies the value of the TDE property. Valid values are: + -- Enabled +-- Disabled + + TransparentDataEncryptionStateType + + + ServerName + + Specifies the name of the server that hosts the database that this cmdlet modifies. + + String + + + DatabaseName + + Specifies the name of the database that this cmdlet modifies. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database that this cmdlet modifies. + + String + + + + + + State + + Specifies the value of the TDE property. Valid values are: + -- Enabled +-- Disabled + + TransparentDataEncryptionStateType + + TransparentDataEncryptionStateType + + + none + + + ServerName + + Specifies the name of the server that hosts the database that this cmdlet modifies. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database that this cmdlet modifies. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database that this cmdlet modifies. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Enable TPE for a database -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlDatabaseTransparentDataEncryption -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -State Enabled + + This command enables TPE for the database named database01 on the server named server01. + + + ResourceGroupName ServerName DatabaseName State ----------------- ---------- ------------ ----- resourcegroup01 server01 database01 Enabled + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseTransparentDataEncryption + + + + Get-AzureRMSqlDatabaseTransparentDataEncryptionActivity + + + + + + + + Set-AzureRMSqlElasticPool + + Modifies properties for an elastic database pool in Azure SQL Database. + + + + + Set + AzureRMSqlElasticPool + + + + The Set-AzureRMSqlElasticPool cmdlet modifies properties for an elastic database pool in Azure SQL Database. This cmdlet can modify the minimum Database Throughput Units (DTUs) per database, and the maximum DTUs per database, the number of DTUs for the pool, and the storage limit for the pool. + + + + Set-AzureRMSqlElasticPool + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet modifies. + + String + + + Edition + + Specifies the edition of Azure SQL Database for the elastic pool. You cannot change the edition. + + DatabaseEdition + + + Dtu + + Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are as follows: + -- Basic. 100 DTUs +-- Standard. 100 DTUs +-- Premium. 125 DTUs + + Int32 + + + StorageMB + + Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the New-AzureRMSqlElasticPool cmdlet. + + Int32 + + + DatabaseDtuMin + + Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. The default value is zero (0). + + Int32 + + + DatabaseDtuMax + + Specifies the maximum number of DTUs that any single database in the pool can consume. The default values for different editions are as follows: + -- Basic. 5 DTUs +-- Standard. 100 DTUs +-- Premium. 125 DTUs + + Int32 + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the elastic pool. + + Dictionary`2[String] + + + ServerName + + Specifies the name of the server that contains the elastic pool that this cmdlet updates. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the elastic pool that this cmdlet modifies. + + String + + + + + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet modifies. + + String + + String + + + none + + + Edition + + Specifies the edition of Azure SQL Database for the elastic pool. You cannot change the edition. + + DatabaseEdition + + DatabaseEdition + + + none + + + Dtu + + Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are as follows: + -- Basic. 100 DTUs +-- Standard. 100 DTUs +-- Premium. 125 DTUs + + Int32 + + Int32 + + + none + + + StorageMB + + Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the New-AzureRMSqlElasticPool cmdlet. + + Int32 + + Int32 + + + none + + + DatabaseDtuMin + + Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. The default value is zero (0). + + Int32 + + Int32 + + + none + + + DatabaseDtuMax + + Specifies the maximum number of DTUs that any single database in the pool can consume. The default values for different editions are as follows: + -- Basic. 5 DTUs +-- Standard. 100 DTUs +-- Premium. 125 DTUs + + Int32 + + Int32 + + + none + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the elastic pool. + + Dictionary`2[String] + + Dictionary`2[String] + + + none + + + ServerName + + Specifies the name of the server that contains the elastic pool that this cmdlet updates. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the elastic pool that this cmdlet modifies. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Modify properties for an elastic pool -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlDatabaseElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" -Dtu 1000 -DatabaseDtuMax 100 -DatabaseDtuMin 20 + + This command modifies properties for an elastic pool named elasticpool01. The command sets the number of DTUs for the elastic pool to be 1000 and sets the minimum and maximum DTUs. + + + ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 Location : Central US CreationDate : 8/26/2015 10:00:17 PM State : Ready Edition : Standard Dtu : 200 DatabaseDtuMax : 100 DatabaseDtuMin : 20 StorageMB : 204800 Tags : + + + + + + + + + + + + + + Azure SQL Database + + + + Get-AzureRMSqlElasticPool + + + + Get-AzureRMSqlElasticPoolActivity + + + + Get-AzureRMSqlElasticPoolDatabase + + + + New-AzureRMSqlElasticPool + + + + + + + + Set-AzureRMSqlServer + + Modifies properties of an Azure SQL Database server. + + + + + Set + AzureRMSqlServer + + + + The Set-AzureRMSqlServer cmdlet modifies properties of an Azure SQL Database server. + + + + Set-AzureRMSqlServer + + ServerName + + Specifies the name of the server that this cmdlet modifies. + + String + + + SqlAdministratorPassword + + Specifies a new password, as a SecureSting, for the database server administrator for the server. To obtain a SecureSting, use the Get-Credential cmdlet. For more information, type Get-Help ConvertTo-SecureString. + + SecureString + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the server. + + Dictionary`2[String] + + + ServerVersion + + Specifies the version to which this cmdlet changes the server. Valid values are: 2.0 and 12.0. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + + ResourceGroupName + + Specifies the name of the resource group that contains the server that this cmdlet modifies. + + String + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + + + + + ServerName + + Specifies the name of the server that this cmdlet modifies. + + String + + String + + + none + + + SqlAdministratorPassword + + Specifies a new password, as a SecureSting, for the database server administrator for the server. To obtain a SecureSting, use the Get-Credential cmdlet. For more information, type Get-Help ConvertTo-SecureString. + + SecureString + + SecureString + + + none + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the server. + + Dictionary`2[String] + + Dictionary`2[String] + + + none + + + ServerVersion + + Specifies the version to which this cmdlet changes the server. Valid values are: 2.0 and 12.0. + + String + + String + + + none + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the server that this cmdlet modifies. + + String + + String + + + none + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + false + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Reset admin password on Azure SQL Server -------------------------- + + PS C:\> + + PS C:\> $serverPassword = "newpassword" PS C:\> $secureString = ConvertTo-SecureString $serverPassword -AsPlainText -Force +PS C:\> Set-AzureSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01" -SqlAdministratorPassword $secureString + + Resets the admin password to "newpassword" on Azure SQL Server "server01". + + + ResourceGroupName : resourcegroup01 ServerName : server01 Location : Australia East SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : + + + + + + + + + + + + + Azure SQL Database + + + + + + + + Set-AzureRMSqlServerActiveDirectoryAdministrator + + Provisions an Azure AD administrator for SQL Server. + + + + + Set + AzureRMSqlServerActiveDirectoryAdministrator + + + + The Set-AzureRMSqlServerActiveDirectoryAdministrator cmdlet provisions an Azure Active Directory (Azure AD) administrator for Azure SQL Server in the current subscription. + Only one administrator can be provisioned at a time. + The following members of Azure AD can be provisioned as an administrator for SQL Server: + -- Native members of Azure AD +-- Federated members of Azure AD +-- Imported members from other Azure AD who are native or federated members +-- Azure AD groups created as security groups + +Microsoft accounts, such as those in the Outllook.com, Hotmail.com, or Live.com domains, are not supported as administrators. Other guest accounts, such as those in the Gmail.com or Yahoo.com domains, are not supported as administrators. + We recommend that you provision a dedicated Azure AD group as an administrator. + + + + Set-AzureRMSqlServerActiveDirectoryAdministrator + + DisplayName + + Specifies the display name of the Azure AD administrator that this cmdlet provisions for SQL Server. + + String + + + ObjectId + + Specifies the unique ID of the Azure AD administrator that this cmdlet provisions for SQL Server. If the display name is not unique, you must specify a value for this parameter. + + Guid + + + ServerName + + Specifies the name of the SQL Server for which this cmdlet provisions an administrator. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the SQL Server for which this cmdlet provisions an administrator. + + String + + + + + + DisplayName + + Specifies the display name of the Azure AD administrator that this cmdlet provisions for SQL Server. + + String + + String + + + none + + + ObjectId + + Specifies the unique ID of the Azure AD administrator that this cmdlet provisions for SQL Server. If the display name is not unique, you must specify a value for this parameter. + + Guid + + Guid + + + none + + + ServerName + + Specifies the name of the SQL Server for which this cmdlet provisions an administrator. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the SQL Server for which this cmdlet provisions an administrator. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Provision an administrator group for a server -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "DBAs" + + + This command provisions an Azure AD administrator group DBAs for the server named server01 that is associated with resource group resourcegroup01. + + + ResourceGroupName ServerName DisplayName ObjectId +----------------- ---------- ----------- -------- +resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b + + + + + + + + + + + -------------------------- Example 2: Provision an administrator user for a server -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "David Chew" + + + This command provisions an Azure AD user David Chew as an administrator for the server named server01. + + + ResourceGroupName ServerName DisplayName ObjectId +----------------- ---------- ----------- -------- +resourcegroup01 server01 David Chew 11E95548-B179-4FE1-9AF4-ACA49D13ABB9 + + + + + + + + + + + -------------------------- Example 3: Provision an administrator group by specifying its ID -------------------------- + + PS C:\> + + PS C:\>Set-AzureRMSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "DBAs" -ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b" + + + This command provisions an Azure AD administrator group DBAs for the server named server01. This command specifies an ID for the ObjectId parameter. If the display name of the object is not unique, the command still works. + + + ResourceGroupName ServerName DisplayName ObjectId +----------------- ---------- ----------- -------- +resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b + + + + + + + + + + + + + Get-AzureRMSqlServerActiveDirectoryAdministrator + + + + Remove-AzureRMSqlServerActiveDirectoryAdministrator + + + + + + + + Set-AzureRMSqlServerAuditingPolicy + + Changes the auditing policy of an Azure SQL server. + + + + + Set + AzureRMSqlServerAuditingPolicy + + + + The Set-AzureRMSqlServerAuditingPolicy cmdlet changes the auditing policy of an Azure SQL server. Specify the ResourceGroupName and ServerName parameters to identify the server, the StorageAccountName parameter to specify the storage account to be used for the audit logs and the StorageKeyType parameter to define which of that storage keys to use. You can also define retention for the audit logs table by setting the value of the RetentionInDays and TableIdentifier parameters to define the period and the seed for the names of the audit logs tables. Specify the EventType parameter to define which event types to audit. After you run this cmdlet, auditing of the databases that use the policy of this server is enabled. If the cmdlet succeeds, and you specify the PassThru parameter, the cmdlet returns an object that describes the current auditing policy, and the server’s identifiers. Server identifiers include, but are not limited to, ResourceGroupName and ServerName. + + + + Set-AzureRMSqlServerAuditingPolicy + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + + EventType + + Specifies the event types to audit. Valid values are: + -- PlainSQL_Success +-- PlainSQL_Failure +-- ParameterizedSQL_Success +-- ParameterizedSQL_Failure +-- StoredProcedure_Success +-- StoredProcedure_Failure +-- Login_Success +-- Login_Failure +-- TransactionManagement_Success +-- TransactionManagement_Failure +-- All +-- None + You can specify several event types. You can specify All to audit all of the event types or None to specify that no events will be audited. If you specify All or None at the same time, the cmdlet fails. + + String[] + + + StorageAccountName + + Specifies the name of the storage account to be used when auditing the database. Wildcard characters are not permitted. If you do not specify this parameter, the cmdlet uses the storage account that was defined previously as part of the auditing policy of the database. If this is the first time a database auditing policy is defined and you do not specify this parameter, the cmdlet fails. + + String + + + StorageKeyType + + Specifies which of the storage access keys to use. Valid values are: + -- Primary +-- Secondary + The default value is Primary. + + String + + + RetentionInDays + + Specifies the number of retention days for the audit logs table. A value of zero (0) means that the table is not retained. The default value is zero. If you specify a value greater than zero, you must specify a value for the TableIdentifer parameter. + + Nullable`1[UInt32] + + + TableIdentifier + + Specifies the name of the audit logs table. Specify this value if you specify a value greater than zero for the RetentionInDays parameter. + + String + + + ServerName + + Specifies the name of the server that contains the database. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + EventType + + Specifies the event types to audit. Valid values are: + -- PlainSQL_Success +-- PlainSQL_Failure +-- ParameterizedSQL_Success +-- ParameterizedSQL_Failure +-- StoredProcedure_Success +-- StoredProcedure_Failure +-- Login_Success +-- Login_Failure +-- TransactionManagement_Success +-- TransactionManagement_Failure +-- All +-- None + You can specify several event types. You can specify All to audit all of the event types or None to specify that no events will be audited. If you specify All or None at the same time, the cmdlet fails. + + String[] + + String[] + + + none + + + StorageAccountName + + Specifies the name of the storage account to be used when auditing the database. Wildcard characters are not permitted. If you do not specify this parameter, the cmdlet uses the storage account that was defined previously as part of the auditing policy of the database. If this is the first time a database auditing policy is defined and you do not specify this parameter, the cmdlet fails. + + String + + String + + + none + + + StorageKeyType + + Specifies which of the storage access keys to use. Valid values are: + -- Primary +-- Secondary + The default value is Primary. + + String + + String + + + none + + + RetentionInDays + + Specifies the number of retention days for the audit logs table. A value of zero (0) means that the table is not retained. The default value is zero. If you specify a value greater than zero, you must specify a value for the TableIdentifer parameter. + + Nullable`1[UInt32] + + Nullable`1[UInt32] + + + none + + + TableIdentifier + + Specifies the name of the audit logs table. Specify this value if you specify a value greater than zero for the RetentionInDays parameter. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that contains the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Set the auditing policy of an Azure SQL server -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -StorageAccountName "Storage22" + + This command sets the auditing policy of the server named server01 to use storage account named Storage22. + + + + + + + + + + + + + + -------------------------- Example 2: Set the storage account key of an already existing auditing policy of an Azure SQL server -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -StorageAccountKey Secondary + + This command sets the auditing policy of the server named server01 to use the secondary key. The command does not modify the storage account name. + + + + + + + + + + + + + + -------------------------- Example 3: Set the auditing policy of an Azure SQL server to use a specific event type -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -EventType Login_Failure + + This command sets the auditing policy of the server named server01 to use the Login_Failure event type. This command does not modify any other setting. + + + + + + + + + + + + + + + + Get-AzureRMSqlServerAuditingPolicy + + + + Use-AzureRMSqlServerAuditingPolicy + + + + + + + + Set-AzureRMSqlServerFirewallRule + + Modifies a firewall rule in Azure SQL Database server. + + + + + Set + AzureRMSqlServerFirewallRule + + + + The Set-AzureRMSqlServerFirewallRule cmdlet modifies a firewall rule in Azure SQL Database server. + + + + Set-AzureRMSqlServerFirewallRule + + FirewallRuleName + + Specifies the name of the firewall rule that this cmdlet modifies. + + String + + + StartIpAddress + + Specifies the start value of the IP address range for the firewall rule. + + String + + + EndIpAddress + + Specifies the end value of the IP address range for this rule. + + String + + + ServerName + + Specifies the name of a server. This cmdlet modifies a firewall rule on the server that this parameter specifies. + + String + + + ResourceGroupName + + Specifies the name of a resource group. This cmdlet modifies a firewall rule on a server in the resource group that this cmdlet specifies. + + String + + + + + + FirewallRuleName + + Specifies the name of the firewall rule that this cmdlet modifies. + + String + + String + + + none + + + StartIpAddress + + Specifies the start value of the IP address range for the firewall rule. + + String + + String + + + none + + + EndIpAddress + + Specifies the end value of the IP address range for this rule. + + String + + String + + + none + + + ServerName + + Specifies the name of a server. This cmdlet modifies a firewall rule on the server that this parameter specifies. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of a resource group. This cmdlet modifies a firewall rule on a server in the resource group that this cmdlet specifies. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Modify a firewall rule -------------------------- + + PS C:\> + + PS C:\> Set-AzureRMSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -FirewallRuleName "rule01" -StartIpAddress "192.168.0.197" -EndIpAddress "192.168.0.199" + + This command modifies a firewall rule named rule01 on the server named server01. The command modifies the start and end IP addresses. + + + ResourceGroupName : resourcegroup01 ServerName : server01 StartIpAddress : 192.168.0.199 EndIpAddress : 192.168.0.200 FirewallRuleName : rule01 + + + + + + + + + + + + + Azure SQL Database + + + + Get-AzureRMSqlServerFirewallRule + + + + New-AzureRMSqlServerFirewallRule + + + + Remove-AzureRMSqlServerFirewallRule + + + + + + + + Start-AzureRMSqlDatabaseExecuteIndexRecommendation + + Starts the workflow that runs a recommended index operation. + + + + + Start + AzureRMSqlDatabaseExecuteIndexRecommendation + + + + The Start-AzureRMSqlDatabaseExecuteIndexRecommendation cmdlet starts the workflow that runs a recommended index operation in Azure SQL Database. + + + + Start-AzureRMSqlDatabaseExecuteIndexRecommendation + + ServerName + + Specifies the server that hosts the database for which this cmdlet starts a workflow. + + String + + + DatabaseName + + Specifies the name of the database for which this cmdlet starts the workflow. + + String + + + IndexRecommendationName + + Specifies the name of the index recommendation that this cmdlet runs. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the server. This cmdlet starts a workflow on a database that this server hosts. + + String + + + + + + ServerName + + Specifies the server that hosts the database for which this cmdlet starts a workflow. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database for which this cmdlet starts the workflow. + + String + + String + + + none + + + IndexRecommendationName + + Specifies the name of the index recommendation that this cmdlet runs. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the server. This cmdlet starts a workflow on a database that this server hosts. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Run an index recommendation -------------------------- + + PS C:\> + + PS C:\> Start-AzureRMSqlDatabaseExecuteIndexRecommendation -ResourceGroup "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -IndexRecommendationName "INDEX_NAME" + + This command runs index recommendation. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseIndexRecommendations + + + + Stop-AzureRMSqlDatabaseExecuteIndexRecommendation + + + + + + + + Start-AzureRMSqlServerUpgrade + + Starts the upgrade of an Azure SQL Database server. + + + + + Start + AzureRMSqlServerUpgrade + + + + The Start-AzureRMSqlServerUpgrade cmdlet starts the upgrade of an Azure SQL Database server version 11 to version 12. Monitor the progress of an upgrade by using the Get-AzureRMSqlServerUpgrade cmdlet. + + + + Start-AzureRMSqlServerUpgrade + + ServerVersion + + Specifies the version to which this cmdlet upgrades the server. Currently, the only valid value is 12.0. + + String + + + ScheduleUpgradeAfterUtcDateTime + + Specifies the earliest time, as a DateTime object, to upgrade the server. Specify a value in the ISO8601 format, in Coordinated Universal Time (UTC). For more information, type Get-Help Get-Date. + + Nullable`1[DateTime] + + + DatabaseCollection + + Specifies an array of RecommendedDatabaseProperties objects that this cmdlet uses for the server upgrade. + + RecommendedDatabaseProperties[] + + + ElasticPoolCollection + + Collection of UpgradeRecommendedElasticPoolProperties objects to be used for the server upgrade. Check the examples on how to construct a sample object. + + UpgradeRecommendedElasticPoolProperties[] + + + ServerName + + Specifies the name of the server that this cmdlet upgrades. + + String + + + ResourceGroupName + + Specifies the name of the resource group in which this cmdlet upgrades a server. + + String + + + + + + ServerVersion + + Specifies the version to which this cmdlet upgrades the server. Currently, the only valid value is 12.0. + + String + + String + + + none + + + ScheduleUpgradeAfterUtcDateTime + + Specifies the earliest time, as a DateTime object, to upgrade the server. Specify a value in the ISO8601 format, in Coordinated Universal Time (UTC). For more information, type Get-Help Get-Date. + + Nullable`1[DateTime] + + Nullable`1[DateTime] + + + none + + + DatabaseCollection + + Specifies an array of RecommendedDatabaseProperties objects that this cmdlet uses for the server upgrade. + + RecommendedDatabaseProperties[] + + RecommendedDatabaseProperties[] + + + none + + + ElasticPoolCollection + + Collection of UpgradeRecommendedElasticPoolProperties objects to be used for the server upgrade. Check the examples on how to construct a sample object. + + UpgradeRecommendedElasticPoolProperties[] + + UpgradeRecommendedElasticPoolProperties[] + + + none + + + ServerName + + Specifies the name of the server that this cmdlet upgrades. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group in which this cmdlet upgrades a server. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Upgrade a Simple server -------------------------- + + PS C:\> + + PS C:\> Start-AzureRMSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server01" -ServerVersion 12.0 + + This command upgrades the server named server01 in resource group named resourcegroup01 to version 12.0. server01 must currently be version 2.0. + + + ResourceGroupName : resourcegroup01 +ServerName : server01 +ServerVersion : 12.0 +ScheduleUpgradeAfterUtcDateTime : +DatabaseCollection : + + + + + + + + + + + -------------------------- Example 2: Upgrade server by using schedule time and database recommendation -------------------------- + + PS C:\> + + PS C:\> $ScheduleTime = (Get-Date).AddMinutes(5).ToUniversalTime() +PS C:\> $DatabaseMap = New-Object -TypeName Microsoft.Azure.Management.Sql.Models.RecommendedDatabaseProperties +PS C:\> $DatabaseMap.Name = "contosodb" +PS C:\> $DatabaseMap.TargetEdition = "Standard" +PS C:\> $DatabaseMap.TargetServiceLevelObjective = "S0" +PS C:\> Start-AzureRMSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server01" -ServerVersion 12.0 -ScheduleUpgradeAfterUtcDateTime $ScheduleTime -DatabaseCollection ($DatabaseMap) + + The first command creates a time five minutes in the future by using the Get-Date core cmdlet. The command stores the date in the $ScheduleTime variable. For more information, type Get-Help Get-Date. +The second command creates a RecommendedDatabaseProperties object, and then stores that object in the $DatabaseMap variable. +The next three commands assign values to properties of the object stored in $DatabaseMap. +The final command upgrades the existing server named server02 in the resource group named resourcegroup01 to version 12.0. The earliest time to upgrade is five minutes after you run the command, as specified by the $ScheduleTime variable. After the upgrade, the database contosodb has the edition Standard and the Service Level Objective value of S0. + + + + + + + + + + + + + + + + Get-AzureRMSqlServerUpgrade + + + + Stop-AzureRMSqlServerUpgrade + + + + + + + + Stop-AzureRMSqlDatabaseExecuteIndexRecommendation + + Stops the workflow that runs a recommended index operation. + + + + + Stop + AzureRMSqlDatabaseExecuteIndexRecommendation + + + + The Stop-AzureRMSqlDatabaseExecuteIndexRecommendation cmdlet stops the workflow that runs a recommended index operation. + + + + Stop-AzureRMSqlDatabaseExecuteIndexRecommendation + + ServerName + + Specifies the server that hosts the database for which this cmdlet stops a workflow. + + String + + + DatabaseName + + Specifies the name of the database for which this cmdlet stops the workflow. + + String + + + IndexRecommendationName + + Specifies the name of the index recommendation that this cmdlet stops. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the server. This cmdlet stops a workflow on a database that this server hosts. + + String + + + + + + ServerName + + Specifies the server that hosts the database for which this cmdlet stops a workflow. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database for which this cmdlet stops the workflow. + + String + + String + + + none + + + IndexRecommendationName + + Specifies the name of the index recommendation that this cmdlet stops. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the server. This cmdlet stops a workflow on a database that this server hosts. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Stop running an index recommendation -------------------------- + + PS C:\> + + PS C:\> Stop-AzureRMSqlDatabaseExecuteIndexRecommendation -ResourceGroup "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -IndexRecommendationName "INDEX_NAME" + + This command stops running the index recommendation. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseIndexRecommendations + + + + Start-AzureRMSqlDatabaseExecuteIndexRecommendation + + + + + + + + Stop-AzureRMSqlServerUpgrade + + Stops the upgrade of an Azure SQL Database server. + + + + + Stop + AzureRMSqlServerUpgrade + + + + The Stop-AzureRMSqlServerUpgrade cmdlet stops the upgrade of an Azure SQL Database server. + + + + Stop-AzureRMSqlServerUpgrade + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + + ServerName + + Specifies the name of the server for which this cmdlet stops an upgrade. + + String + + + ResourceGroupName + + Specifies the name of the resource group in which this cmdlet stops the upgrade of a server. + + String + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + + + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ServerName + + Specifies the name of the server for which this cmdlet stops an upgrade. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group in which this cmdlet stops the upgrade of a server. + + String + + String + + + none + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + false + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Stop a server upgrade -------------------------- + + PS C:\> + + PS C:\> Stop-AzureRMSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server02" + + This command stops the request to upgrade the server named server02 in the resource group named resourcegroup01. + + + + + + + + + + + + + + + + Get-AzureRMSqlServerUpgrade + + + + Start-AzureRMSqlServerUpgrade + + + + + + + + Suspend-AzureRMSqlDatabase + + Suspends an Azure SQL Data Warehouse database. + + + + + Suspend + AzureRMSqlDatabase + + + + The Suspend-AzureRMSqlDatabase cmdlet suspends an Azure SQL Data Warehouse database. + + + + Suspend-AzureRMSqlDatabase + + ServerName + + Specifies the name of the server which hosts the database that this cmdlet suspends. + + String + + + DatabaseName + + Specifies the name of the database that this cmdlet suspends. + + String + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + + + + ServerName + + Specifies the name of the server which hosts the database that this cmdlet suspends. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database that this cmdlet suspends. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + This Suspend-AzureRMSqlDatabase cmdlet works only on Azure SQL Data Warehouse databases. This operation is not supported on Azure SQL Database Basic, Standard and Premium editions. + + + + + -------------------------- Example 1: Suspends an Azure SQL Data Warehouse database -------------------------- + + PS C:\> + + PS C:\> Suspend-AzureSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command suspends an active Azure SQL Data Warehouse database. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabase + + + + New-AzureRMSqlDatabase + + + + Remove-AzureRMSqlDatabase + + + + Resume-AzureRMSqlDatabase + + + + Set-AzureRMSqlDatabase + + + + + + + + Use-AzureRMSqlServerAuditingPolicy + + Specifies that a database uses the auditing policy of its hosting server. + + + + + Use + AzureRMSqlServerAuditingPolicy + + + + The Use-AzureRMSqlServerAuditingPolicy cmdlet specifies that a database uses the auditing policy of its host server. Specify the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database. If no auditing policy is defined for the database server, this cmdlet fails. + + + + Use-AzureRMSqlServerAuditingPolicy + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + + ServerName + + Specifies the name of the server that hosts the database to use the auditing policy. + + String + + + DatabaseName + + Specifies the name of the database to use the auditing policy. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the database to use the auditing policy. + + String + + + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + ServerName + + Specifies the name of the server that hosts the database to use the auditing policy. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database to use the auditing policy. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that contains the database to use the auditing policy. + + String + + String + + + none + + + Profile + + Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile. + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel + + + + + + + + + + + + + + + + + + + -------------------------- Example 1: Define for a database to use the auditing policy of its server -------------------------- + + PS C:\> + + PS C:\> Use-AzureRMSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server02" -DatabaseName "database01" + + This command specifies that the database named database01 on server01 uses the auditing policy of its server. + + + + + + + + + + + + + + + + Get-AzureRMSqlDatabaseAuditingPolicy + + + + Get-AzureRMSqlServerAuditingPolicy + + + + Set-AzureRMSqlDatabaseAuditingPolicy + + + + Set-AzureRMSqlServerAuditingPolicy + + + + + \ No newline at end of file