From a756cb6e910bf69d07e06c6feb96d8183c8a4443 Mon Sep 17 00:00:00 2001 From: yaakoviyun Date: Wed, 17 Feb 2016 09:11:38 +0200 Subject: [PATCH 1/5] updated Microsoft.Azure.Commands.Sql.dll-Help --- .../Microsoft.Azure.Commands.Sql.dll-Help.xml | 26691 ++++++++-------- 1 file changed, 13026 insertions(+), 13665 deletions(-) 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 8dcd923a6f94..97c3ce8b717e 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,406 +1,2563 @@ - - - - - - Get-AzureRmSqlCapability + + + + + Get-AzureRmSqlCapability + + Gets SQL Database capabilities for the current subscription. + + + + + Get + AzureRmSqlCapability + + - Gets SQL Database capabilities for the current subscription. + 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 - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + 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. + + + + + 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 + + + EditionName + + Specifies the name of the database edition for which this cmdlet gets capabilities. + + String + + + ServerVersionName + + Specifies the name of the server version for which this cmdlet gets capabilities. + + String + + + ServiceObjectiveName + + Specifies the name of the service objective for which this cmdlet gets capabilities. + + String + + + + + + Defaults + + Indicates that this cmdlet gets only defaults. + + SwitchParameter + + SwitchParameter + + + none + + + EditionName + + Specifies the name of the database edition for which this cmdlet gets capabilities. + + String + + String + + + none + + + 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 + + + ServiceObjectiveName + + Specifies the name of the service objective for which this cmdlet gets capabilities. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Location_Capabilities.Model.LocationCapabilityModel + + + + + + + + + + + + + + + Example 1: Get capabilities for the current subscription for a region + + + + PS C:\> Get-AzureRmSqlCapability -LocationName "Central US" +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 +SupportedServerVersions : {12.0, 2.0} + + This command returns the capabilities for SQL Databases on the current subscription for the Central US region. + + + + + + + + + + + Example 2: Get default capabilities for the current subscription for a region + + + + PS C:\> Get-AzureRmSqlCapability -LocationName "Central US" -Defaults +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 +ExpandedDetails : Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S0 (Default) + + This command returns the default capabilities for SQL Databases on the current subscription in the Central US region. + + + + + + + + + + + Example 3: Get details for a service objective + + + + PS C:\> Get-AzureRmSqlCapability -LocationName "Central US" -ServiceObjectiveName "S1" +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 +ExpandedDetails : Version: 12.0 (Available) -> Edition: Standard (Default) -> Service Objective: S1 (Available) + Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S1 (Available) + + This command gets default capabilities for SQL Databases for the specified service objective on the current subscription. + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlDatabaseActivity + + Gets the status of moving elastic databases. + + + + + Get + AzureRmSqlDatabaseActivity + + + + The Get-AzureRmSqlDatabaseActivity cmdlet gets the status of elastic databases moving into or out of an elastic database pool in Azure SQL Database. + + + + Get-AzureRmSqlDatabaseActivity + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the SQL Server that hosts the elastic database pool. + + String + + + OperationId + + Specifies the ID of the operation that this cmdlet gets. + + Guid] + + + DatabaseName + + Specifies the name of the database for which this cmdlet gets status. + + 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 + + String + + + none + + + ElasticPoolName + + Specifies the name of the elastic database pool for which this cmdlet gets status. + + String + + String + + + none + + + OperationId + + Specifies the ID of the operation that this cmdlet gets. + + Guid] + + Guid] + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the SQL Server that hosts the elastic database pool. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseActivityModel + + + + + + + + + + + + + + + Example 1: Get status for all SQL Database instances + + + + 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. + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + + + + 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 + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the server where the database is located. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server where the database is located. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel + + + + + + + + + + + + + + + Example 1: Get the auditing policy of an Azure SQL database + + + + PS C:\> Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" +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 + + This command gets the auditing policy of database database01 located in server01 in resource group resourcegroup01. + + + + + + + + + + + + + Remove-AzureRmSqlDatabaseAuditing + + + + Set-AzureRmSqlDatabaseAuditingPolicy + + + + Azure SQL Database Cmdlets + + + + + + + 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 + + ResourceGroupName + + Specifies the name of the resource group the database is assigned to. + + String + + + ServerName + + Specifies the name of the server where the database is located. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server where the database is located. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingPolicyModel + + + + + + + + + + + + + + + Example 1: Get the data masking policy for an Azure SQL database + + + + PS C:\> Get-AzureRmSqlDatabaseDataMaskingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" +DatabaseName : database01 +ResourceGroupName : resourcegroup01 +ServerName : server01 +DataMaskingState : Enabled +PrivilegedUsers : + + This command gets the data masking policy from database database01 in resource group resourcegroup01 on server server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseDataMaskingRule + + + + New-AzureRmSqlDatabaseDataMaskingRule + + + + Remove-AzureRmSqlDatabaseDataMaskingRule + + + + Set-AzureRmSqlDatabaseDataMaskingPolicy + + + + Set-AzureRmSqlDatabaseDataMaskingRule + + + + Azure SQL Database Cmdlets + + + + + + + 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 for 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 for that Azure SQL database are returned. + + + + Get-AzureRmSqlDatabaseDataMaskingRule + + ResourceGroupName + + Specifies the name of the resource group the database is assigned to. + + String + + + ServerName + + Specifies the name of the server. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + ColumnName + + Specifies the name of the column targeted by the masking rule. + + System.String + + + SchemaName + + Specifies the name of a schema. + + System.String + + + TableName + + Specifies the name of an Azure SQL Table. + + System.String + + + + + + ColumnName + + Specifies the name of the column targeted by the masking rule. + + System.String + + System.String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group the database is assigned to. + + String + + String + + + none + + + SchemaName + + Specifies the name of a schema. + + System.String + + System.String + + + none + + + ServerName + + Specifies the name of the server. + + String + + String + + + none + + + TableName + + Specifies the name of an Azure SQL Table. + + System.String + + System.String + + + none + + + + + + + + + + + + + None. + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel + + + + + + + + + + + + + + + Example 1: Get all data masking rules from a database + + + + PS C:\> Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command gets all data masking rules from database01 in resource group resourcegroup01 found on server server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseDataMaskingPolicy + + + + New-AzureRmSqlDatabaseDataMaskingRule + + + + Remove-AzureRmSqlDatabaseDataMaskingRule + + + + Set-AzureRmSqlDatabaseDataMaskingPolicy + + + + Set-AzureRmSqlDatabaseDataMaskingRule + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlDatabaseExpanded + + Gets a database along with its expanded property values. + + + + + Get + AzureRmSqlDatabaseExpanded + + + + The Get-AzureRmSqlDatabaseExpanded cmdlet gets a database along with its expanded property values. + + + + Get-AzureRmSqlDatabaseExpanded + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the. + + String + + + DatabaseName + + Specifies the name of the database to retrieve. + + String + + + + + + DatabaseName + + Specifies the name of the database to retrieve. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Get database object with service tier advisor information + + + + PS C:\> Get-AzureSqlDatabaseExpanded -ResourceGroupName "RG1" -ServerName "S1" -DatabaseName "DB1" + + This command returns the database with expanded properties containing the service tier advisor information. + + + + + + + + + + + + + + + Get-AzureRmSqlDatabaseIndexRecommendations + + Gets the recommended index operations for a server or database. + + + + + Get + AzureRmSqlDatabaseIndexRecommendations + + + + The Get-AzureRmSqlDatabaseIndexRecommendations cmdlet gets the recommended index operations for an Azure SQL Database server or database. + + + + Get-AzureRmSqlDatabaseIndexRecommendations + + ResourceGroupName + + Specifies the name of the resource group that the serve is assigned tor. This cmdlet gets index recommendations for a database hosted by this server. + + String + + + DatabaseName + + Specifies the name of the database for which this cmdlet gets index recommendations. + + String + + + IndexRecommendationName + + Specifies the name of the index recommendation that this cmdlet gets. + + String + + + TableName + + Specifies the name of an Azure SQL Table. + + String + + + 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 index recommendations. + + 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 the serve is assigned tor. This cmdlet gets index recommendations for a database hosted by this server. + + String + + String + + + none + + + ServerName + + Specifies the server that hosts the database for which this cmdlet gets index recommendations. + + String + + String + + + none + + + TableName + + Specifies the name of an Azure SQL Table. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Get index recommendations for all databases on server + + + + PS C:\> Get-AzureRmSqlDatabaseIndexRecommendations -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command returns index recommendations for all databases on server server01. + + + + + + + + + + + Example 2: Get index recommendations for a specific database + + + + 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:\> Get-AzureRmSqlDatabaseIndexRecommendations -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -IndexRecommendationName "INDEX_NAME" + + This command returns single index recommendation by name. + + + + + + + + + + + + + Start-AzureRmSqlDatabaseExecuteIndexRecommendation + + + + Stop-AzureRmSqlDatabaseExecuteIndexRecommendation + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlDatabaseReplicationLink + + Gets the geo-replication links between an Azure SQL Database and the specified Azure resource group or Azure SQL Server. + + + + + Get + AzureRmSqlDatabaseReplicationLink + + + + The Get-AzureRMSqlDatabaseReplicationLink cmdlet replaces the Get-AzureSqlDatabaseCopy cmdlet. It gets all geo-replication links between the specified Azure SQL Database and a resource group or Azure SQL Server. + + + + Get-AzureRmSqlDatabaseReplicationLink + + ResourceGroupName + + Specifies the name of the Azure resource group for the database for which to retrieve links. + + String + + + ServerName + + Specifies the name of the Azure SQL Server for the database to retrieve links for. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database for which to retrieve links. + + String + + + PartnerResourceGroupName + + Specifies the name of the Azure resource group the partner is assigned to. + + String + + + + Get-AzureRmSqlDatabaseReplicationLink + + ResourceGroupName + + Specifies the name of the Azure resource group for the database for which to retrieve links. + + String + + + ServerName + + Specifies the name of the Azure SQL Server for the database to retrieve links for. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database for which to retrieve links. + + String + + + PartnerServerName + + Specifies the name of the Azure SQL Server for the partner. + + String + + + PartnerResourceGroupName + + Specifies the name of the Azure resource group the partner is assigned to. + + String + + + + + + DatabaseName + + Specifies the name of the Azure SQL Database for which to retrieve links. + + String + + String + + + none + + + PartnerResourceGroupName + + Specifies the name of the Azure resource group the partner is assigned to. + + String + + String + + + none + + + PartnerServerName + + Specifies the name of the Azure SQL Server for the partner. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the Azure resource group for the database for which to retrieve links. + + String + + String + + + none + + + ServerName + + Specifies the name of the Azure SQL Server for the database to retrieve links for. + + String + + String + + + none + + + + + + + + + + + + + This cmdlet accepts instances of the ReplicationLink or the Database object for the primary or secondary database. + + + + + + + + + + + + + + The output type is a ReplicationLink object. + + + + + + + + 1: + + + + + + + + + + + + + + + + + + + + Get-AzureRmSqlDatabaseRestorePoints + + This cmdlet retrieves the distinct restore points that an Azure SQL Data warehouse can be restored from. + + + + + Get + AzureRmSqlDatabaseRestorePoints + + + + The Get-AzureRmSqlDatabaseRestorePoints cmdlet retrieves the distinct restore points that an Azure SQL Data warehouse can be restored from. For an Azure SQL Database, the restore window is continuous, meaning that any point in time within the database's backup retention period can be used as a restore point. + + + + Get-AzureRmSqlDatabaseRestorePoints + + ResourceGroupName + + Specifies the name of the resource group the Azure SQL Database is assigned to. + + String + + + ServerName + + Specifies the name of the Azure SQL Server hosting the database. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database. + + String + + + + + + DatabaseName + + Specifies the name of the Azure SQL Database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group the Azure SQL Database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the Azure SQL Server hosting the database. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Get all restore points + + + + PS C:\> Get-AzureRmSqlDatabaseRestorePoints -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +Location : Central US +RestorePointType : CONTINUOUS +RestorePointCreationDate : +EarliestRestoreDate : 8/12/2015 12:00:00 AM + + This command returns all available restore points for the Azure SQL Database named database01. + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlDatabaseSecureConnectionPolicy + + Gets the secure connection policy for 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 + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of server that hosts the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of server that hosts the database. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseSecureConnectionPolicyModel + + + + + + + + + + + + + + + Example 1: Get the secure connection policy of an Azure SQL database + + + + PS C:\> Get-AzureRmSqlDatabaseSecureConnectionPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" +DatabaseName : database01 +ConnectionStrings : Microsoft.Azure.Commands.Sql.SecureConnection.Model.ConnectionStrings +ResourceGroupName : resourcegroup01 +ServerName : server01 +ProxyDnsName : server01.database.secure.windows.net +ProxyPort : 1433 +SecureConnectionState : Optional + + This command gets the secure connection policy of an Azure SQL database named database01 located on server server01. + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + Gets the threat detection policy for a database. + + + + + Get + AzureRmSqlDatabaseThreatDetectionPolicy + + + + The Get-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet gets the threat detection policy of an Azure SQL database. To use this cmdlet, specify the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database for which this cmdlet gets the policy. + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of a server. + + String + + + DatabaseName + + Specifies the name of a database. + + String + + + + + + DatabaseName + + Specifies the name of a database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a server. + + String + + String + + + none + + + + + + + + + + + + + You cannot pipe input to this cmdlet. + + + + + + + Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel + + + + + + + This cmdlet returns a Model.DatabaseThreatDetectionPolicyModel object. + + + + + + + + Example 1: Get the threat detection policy for a database + + + + PS C:\> Get-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +DatabaseName : Database01 +ResourceGroupName : ResourceGroup11 +ServerName : Server01 +ThreatDetectionState : Disabled +NotificationRecipientsEmails : +EmailAdmins : False +ExcludedDetectionTypes : {} + + This command gets the threat detection policy for a database named Database01. The database is located on the server named Server01, which is assigned to the resource group ResourceGroup11. + + + + + + + + + + + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Azure SQL Database Cmdlets + + + + + + + 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 + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the server. + + String + + + DatabaseName + + Specifies the name of 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 + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionActivityModel + + + + + + + + + + + + + + + Example 1: Get TDE activity for a database + + + + PS C:\> Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01" +ResourceGroupName : resourcegroup01 +ServerName : server01 +DatabaseName : database01 +Status : Encrypting +PercentComplete : 3.662109 + + This command gets the TDE activity for the database named database01 on the server named server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseTransparentDataEncryption + + + + Set-AzureRmSqlDatabaseTransparentDataEncryption + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlDatabaseTransparentDataEncryption + + Gets the TDE state for an Azure SQL database. + + + + + Get + AzureRmSqlDatabaseTransparentDataEncryption + + + + + The Get-AzureRmSqlDatabaseTransparentDataEncryption cmdlet gets the state of Transparent Data Encryption (TDE) for 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 TDE, but both encryption and decryption can be long-running operations. To see the encryption scan progress, run the Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity cmdlet. + + + + + Get-AzureRmSqlDatabaseTransparentDataEncryption + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + 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 + + + + + + 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 the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the database for which this cmdlet gets TDE status. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel + + + + + + + + + + + + + + + Example 1: Get TDE status for a database + + + + PS C:\> Get-AzureRmSqlDatabaseTransparentDataEncryption -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01" +ResourceGroupName ServerName DatabaseName State +----------------- ---------- ------------ ----- +resourcegroup01 server01 database01 Disabled + + This command gets the status of TDE for the database named Database01 on the server named server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity + + + + Set-AzureRmSqlDatabaseTransparentDataEncryption + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlDatabaseUpgradeHint + + Gets pricing tier hints for a SQL database. + + + + + Get + AzureRmSqlDatabaseUpgradeHint + + + + The Get-AzureRmSqlDatabaseUpgradeHint cmdlet gets pricing tier hints for upgrading an 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 + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + 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 databases in elastic database pools should be excluded from the returned recommendations. + + Boolean + + + + + + 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 databases in elastic database pools should be excluded from the returned recommendations. + + Boolean + + Boolean + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the database for which this cmdlet gets an upgrade hint. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Get recommendations for all databases on a server + + + + PS C:\> Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command returns upgrade hints for all databases on the server named server01. + + + + + + + + + + + Example 2: Get recommendations for specific database + + + + PS C:\> Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command returns upgrade hints for a specific database. + + + + + + + + + + + Example 3: Get recommendation for all databases that are not in an elastic database pool + + + + PS C:\> Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" -ExcludeElasticPoolCandidates $True + + This command returns upgrade hints for all databases that are not in an elastic database pool. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseExpanded + + + + Get-AzureRmSqlElasticPoolRecommendation + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlDatabase + + Gets one or more Azure SQL databases. + + + + + Get + AzureRmSqlDatabase + + - Gets one or more Azure SQL databases. + The Get-AzureRmSqlDatabase cmdlet gets one or more Azure SQL databases from an Azure SQL Database Server. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Get-AzureRmSqlDatabase + + ResourceGroupName + + Specifies the name of the resource group that the database server is assigned to. + + String + + + ServerName + + Specifies the name of the server the database is assigned to. + + String + + + DatabaseName + + Specifies the name of the database to retrieve. + + String + + + + + + DatabaseName + + Specifies the name of the database to retrieve. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server the database is assigned to. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + Example 1: Get all databases on a server + + + + PS C:\> Get-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" +ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : master Location : Central US @@ -436,27 +2593,25 @@ 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 +Tags : + + This command gets all databases on the server named server01. + + + + + + + + + + + Example 2: Get a database by name on a server + + + + PS C:\> Get-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" +ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US @@ -473,2461 +2628,620 @@ 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 -PrivilegedUsers : - - - - - - - - - - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - +Tags : + + This command gets a database named Database02 from a server named Server01. + + + + + + + + + + + + + New-AzureRmSqlDatabase + + + + Remove-AzureRmSqlDatabase + + + + Resume-AzureRmSqlDatabase + + + + Set-AzureRmSqlDatabase + + + + Suspend-AzureRmSqlDatabase + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlElasticPoolActivity + + Gets the status of operations on an elastic pool. + + - - String - - - ResourceGroupName - - - - String - - - - - - ServerName - - - - String - - String - - - none - - - DatabaseName - - - - String - - String - - - none - - - ResourceGroupName - - - - String - - String - - - none - - - Profile - - - - azureprofile - - azureprofile - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - - - - - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + Get + AzureRmSqlElasticPoolActivity + + - Gets the geo-replication links between an Azure SQL Database and the specified Azure Resource Group or Azure SQL Server. + The Get-AzureRmSqlElasticPoolActivity cmdlet gets the status of operations on an elastic pool for an Azure SQL Database. You can see the status of both pool creation and configuration updates. - - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - - - - - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Get-AzureRmSqlElasticPoolActivity + + ResourceGroupName + + Specifies the name of a resource group that the elastic pool is assigned to. + + String + + + ServerName + + Specifies the name of a server that contains an elastic pool. + + String + + + ElasticPoolName + + Specifies the name of an elastic pool. + + String + + + + + + ElasticPoolName + + Specifies the name of an elastic pool. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of a resource group that the elastic pool is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a server that contains an elastic pool. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolActivityModel + + + + + + + + + + + + + + + Example 1: Get the status of operations for an elastic pool + + + + PS C:\> Get-AzureRmSqlElasticPoolActivity -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" + + This command gets the status of the operations for the elastic pool named elasticpool01. + + + + + + + + + + + + + Get-AzureRmSqlElasticPool + + + + Get-AzureRmSqlElasticPoolDatabase + + + + New-AzureRmSqlElasticPool + + + + Remove-AzureRmSqlElasticPool + + + + Set-AzureRmSqlElasticPool + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlElasticPoolDatabase + + Gets elastic databases in an elastic pool and their property values. + + + + + Get + AzureRmSqlElasticPoolDatabase + + - Gets the progress of a TDE scan of an Azure SQL database. + The Get-AzureRmSqlElasticPoolDatabase cmdlet gets elastic databases in an elastic pool and their property values. You can specify the name of an elastic database in Azure SQL Database to see the property values for only that 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Get-AzureRmSqlElasticPoolDatabase + + ResourceGroupName + + Specifies the name of a resource group that the elastic pool is assigned to. + + String + + + ServerName + + Specifies the name of a server that contains an elastic pool. + + String + + + ElasticPoolName + + Specifies the name of an elastic pool. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database that this cmdlet gets. + + String + + + + + + DatabaseName + + Specifies the name of the Azure SQL Database that this cmdlet gets. + + String + + String + + + none + + + ElasticPoolName + + Specifies the name of an elastic pool. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of a resource group that the elastic pool is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a server that contains an elastic pool. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + Example 1: Get all databases in an elastic pool + + + + PS C:\> Get-AzureRmSqlElasticPoolDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticPool01" + + This command gets all databases in an elastic pool named elasticPool01. + + + + + + + + + + + + + Get-AzureRmSqlElasticPool + + + + Get-AzureRmSqlElasticPoolActivity + + + + New-AzureRmSqlElasticPool + + + + Remove-AzureRmSqlElasticPool + + + + Set-AzureRmSqlElasticPool + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlElasticPoolRecommendation + + Gets elastic pool recommendations. + + + + + Get + AzureRmSqlElasticPoolRecommendation + + - Gets pricing tier hints for a database for upgrading SQL Database. + 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 databases in the elastic pool. + -- DatabaseDtuMax. DTU cap for databases in the elastic pool. +-- Dtu. DTU guarantee for the elastic pool. +-- StorageMb. Storage in megabytes for the elastic pool. +-- Edition. Edition for the elastic pool. Valid values are: Basic, Standard, and Premium. +-- IncludeAllDatabases. Indicates whether to all databases in the elastic pool are returned. +-- Name. Name of the elastic pool. - - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Get-AzureRmSqlElasticPoolRecommendation + + ResourceGroupName + + Specifies name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of the server for which this cmdlet gets recommendations. + + String + + + + + + ResourceGroupName + + Specifies name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server for which this cmdlet gets recommendations. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Get recommendations for a server + + + + PS C:\> Get-AzureRmSqlElasticPoolRecommendation -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command gets the elastic pool recommendations for the server named server01. + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlElasticPool + + Gets elastic pools and their property values in an Azure SQL Database. + + + + + Get + AzureRmSqlElasticPool + + - Gets elastic pools and their property values in an Azure SQL Database. + The Get-AzureRmSqlElasticPool cmdlet gets elastic pools and their property values. Specify the name of an existing elastic pool to see the property values for only that pool. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Get-AzureRmSqlElasticPool + + ResourceGroupName + + Specifies the name of the resource group that the elastic pool is assigned to. + + String + + + ServerName + + Specifies the name of the server that contains the elastic + + String + + + ElasticPoolName + + Specifies the name of the elastic pool. + + String + + + + + + ElasticPoolName + + Specifies the name of the elastic pool. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the elastic pool is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that contains the elastic + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + + + + + + + + + + + + + + + Example 1: Get all elastic pools + + + + PS C:\> Get-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 @@ -2953,28 +3267,25 @@ 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 +Tags : + + This command gets all of the elastic pools on the server named server01. + + + + + + + + + + + Example 2: Get a specific elastic pool + + + + PS C:\>Get-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticPool27" +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 @@ -2986,32 +3297,29 @@ 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 : +Tags : + + This command gets the elastic pool named elasticPool0127 on the server named server01. + + + + + + + + + + + Example 3: Get metrics for a Azure SQL Elastic Database Pool + + + + PS C:\>Get-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" | Get-Metrics -TimeGrain 0:5:0 +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...} +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 @@ -3022,7 +3330,7 @@ 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...} +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 @@ -3033,7 +3341,7 @@ 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...} +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 @@ -3044,7 +3352,7 @@ 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...} +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 @@ -3055,717 +3363,1150 @@ 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...} +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 +Unit : Percent + + This command returns metrics for an Azure SQL elastic database pool named "elasticpool01". + + + + + + + + + + + + + New-AzureRmSqlElasticPool + + + + Remove-AzureRmSqlElasticPool + + + + Set-AzureRmSqlElasticPool + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlServerActiveDirectoryAdministrator + + Gets information about an Azure AD administrator for SQL Server. + + + + + Get + AzureRmSqlServerActiveDirectoryAdministrator + + - Gets the status of operations on an elastic pool. + The Get-AzureRmSqlServerActiveDirectoryAdministrator cmdlet gets information about an Azure Active Directory (Azure AD) administrator for an Azure SQL Server in the current subscription. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Get-AzureRmSqlServerActiveDirectoryAdministrator + + ResourceGroupName + + Specifies the name of the resource group that the SQL Server is assigned to. + + String + + + ServerName + + Specifies the name of the SQL Server for which this cmdlet gets information. + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group that the SQL Server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the SQL Server for which this cmdlet gets information. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + + + + + + + + + + + + + + + Example 1: Gets information about an administrator for a server + + + + PS C:\> Get-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" +ResourceGroupName ServerName DisplayName ObjectId +----------------- ---------- ----------- -------- +resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b + + This command gets information about an Azure AD administrator for a server named Server01 that is associated with a resource group named resourcegroup01. + + + + + + + + + + + + + Remove-AzureRmSqlServerActiveDirectoryAdministrator + + + + Set-AzureRmSqlServerActiveDirectoryAdministrator + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlServerAuditingPolicy + + Gets the auditing policy of an Azure SQL server. + + + + + Get + AzureRmSqlServerAuditingPolicy + + - Gets elastic databases in an elastic pool and their property values. + 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 - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Get-AzureRmSqlServerAuditingPolicy + + ResourceGroupName + + Specifies the name of the resource group that the Azure SQL server is assigned to. + + String + + + ServerName + + Specifies the name of the Azure SQL server for which this cmdlet gets the auditing policy. + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group that the Azure SQL server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the Azure SQL server for which this cmdlet gets the auditing policy. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel + + + + + + + + + + + + + + + Example 1: Get the auditing policy of an Azure SQL server + + + + PS C:\> Get-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" +ResourceGroupName : resourcegroup01 +ServerName : server01 +StorageAccountName : +StorageKeyType : Primary +EventType : {PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure...} +AuditState : New +RetentionInDays : 0 +TableIdentifier : Server01 + + This command gets the auditing policy of the server server01 in resource group resourcegroup01. + + + + + + + + + + + + + Set-AzureRmSqlServerAuditingPolicy + + + + Use-AzureRmSqlServerAuditingPolicy + + + + Azure SQL Database Cmdlets + + + + + + + Get-AzureRmSqlServerCommunicationLink + + Gets a SQL Server communication link. + + + + + Get + AzureRmSqlServerCommunicationLink + + - Gets elastic pool recommendations. + The Get-AzureRmSqlServerCommunicationLink cmdlet gets a SQL Server communication link. - - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Get-AzureRmSqlServerCommunicationLink + + ResourceGroupName + + Specifies the name of the Azure resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of the SQL Server. + + String + + + LinkName + + Specifies the name of the communication link to get. + + String + + + + + + LinkName + + Specifies the name of the communication link to get. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the Azure resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the SQL Server. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1: + + + + + + + + + + + + + + + + + + New-AzureRmSqlServerCommunicationLink + + + + Remove-AzureRmSqlServerCommunicationLink + + + + Set-AzureRmSqlServerCommunicationLink + + + + + + + Get-AzureRmSqlServerFirewallRule + + Gets firewall rules for an Azure SQL Database server. + + + + + Get + AzureRmSqlServerFirewallRule + + - Returns information about Azure SQL Database servers. + 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 - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Get-AzureRmSqlServerFirewallRule + + ResourceGroupName + + Specifies the name of the resource group the SQL Server is assigned to. + + String + + + ServerName + + Specifies the name of the SQL Server. + + String + + + FirewallRuleName + + Specifies the name of the firewall rule. + + String + + + + + + FirewallRuleName + + Specifies the name of the firewall rule. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group the SQL Server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the SQL Server. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + + + + + + + + + + + + + + + Example 1: Get all rules for a server + + + + PS C:\> Get-AzureRmSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "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 + + This command gets all the firewall rules for the server named server01. + + + + + + + + + + + + + New-AzureRmSqlServerFirewallRule + + + + Remove-AzureRmSqlServerFirewallRule + + + + Set-AzureRmSqlServerFirewallRule + + + + Azure SQL Database Cmdlets + + + + + + + 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 + + ResourceGroupName + + Specifies the name of a resource group. This cmdlet gets service objectives for an Azure SQL Database server assigned to this resource. + + String + + + ServerName + + Specifies the name of an Azure SQL Database server. + + 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 + + + DatabaseName + + Specifies the name of an Azure SQL Database. + + String + + + + + + 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 assigned to this resource. + + String + + String + + + none + + + ServerName + + Specifies the name of an Azure SQL Database server. + + String + + String + + + none + + + 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 + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServiceObjective.Model.AzureSqlServerServiceObjectiveModel + + + + + + + + + + + + + + + Example 1: Get service objectives + + + + PS C:\> Get-AzureRmSqlServerServiceObjective -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "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 + + This command gets the service objectives for the server named server01 and the database named database01. + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + + + + 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 hosted on the specified server. + + + + Get-AzureRmSqlServerUpgradeHint + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of the server for which this cmdlet gets an upgrade hint. + + String + + + ExcludeElasticPools + + Indicates whether databases that are included in elastic database pools should be returned. + + Boolean + + + + + + ExcludeElasticPools + + Indicates whether databases that are included in elastic database pools should be returned. + + Boolean + + Boolean + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server for which this cmdlet gets an upgrade hint. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Get combined recommendations + + + + PS C:\> Get-AzureRmSqlServerUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" +ElasticPools Databases +------------ --------- +{} {database01, database02} + + This command gets combined recommendations for all the databases on a server named server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseExpanded + + + + Get-AzureRmSqlElasticPoolRecommendation + + + + Azure SQL Database Cmdlets + + + + + + + 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 + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of the server for which this cmdlet gets upgrade status. + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server for which this cmdlet gets upgrade status. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel + + + + + + + + + + + + + + + Example 1: Get the status of an upgrade + + + + PS C:\> Get-AzureRmSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server01" | Format-List +ResourceGroupName : resourcegroup01 +ServerName : server01 +Status : Queued + + This command gets the status of an upgrade from the server named server01 in resource group named resourcegroup01. + + + + + + + + + + + + + Start-AzureRmSqlServerUpgrade + + + + Stop-AzureRmSqlServerUpgrade + + + + Azure SQL Database Cmdlets + + + + + + + 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 for only that server. + + + + Get-AzureRmSqlServer + + ResourceGroupName + + Specifies the name of the resource group that servers are assigned to. + + String + + + ServerName + + Specifies the name of the server that this cmdlet gets. + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group that servers are assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that this cmdlet gets. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + + + + + + + + + + + + + + + Example 1: Get all Azure SQL Servers assigned to a resource group + + + + PS C:\> Get-AzureRmSqlServer -ResourceGroupName "resourcegroup01" +ResourceGroupName : resourcegroup01 ServerName : server01 Location : Central US -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : +SqlAdministratorLogin : adminLoginSqlAdministratorPassword : ServerVersion : 12.0 Tags : @@ -3775,54 +4516,49 @@ 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 +Tags : + + This command gets information about all the Azure SQL Database servers assigned to the resource group resourcegroup01. + + + + + + + + + + + Example 2: Get information about an Azure SQL Database server + + + + PS C:\> Get-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -ServerName "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 +Tags : + + This command gets information about the Azure SQL Database server named server01. + + + + + + + + + + + Example 3: Get all Azure SQL Servers in the subscription + + + + PS C:\> Get-AzureRmResourceGroup | Get-AzureRmSqlServer +ResourceGroupName : resourcegroup01 ServerName : server01 Location : Central US SqlAdministratorLogin : adminLogin @@ -3844,1499 +4580,1182 @@ 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 +Tags : + + This command gets information about all the Azure SQL Database servers in the current subscription. + + + + + + + + + + + + + New-AzureRmSqlServer + + + + Remove-AzureRmSqlServer + + + + Set-AzureRmSqlServer + + + + Azure SQL Database Cmdlets + + + + + + + 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 + + - Gets the status of an Azure SQL Database server upgrade. + The New-AzureRmSqlDatabaseCopy cmdlet replaces the Start-AzureSqlDatabaseCopy 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. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + New-AzureRmSqlDatabaseCopy + + ResourceGroupName + + Specifies the name of the Azure Resource Group that the database being copied is assigned to. + + String + + + ServerName + + Specifies the name of the Azure SQL Server that contains the database to copy. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database to copy. + + String + + + CopyResourceGroupName + + Specifies the name of the Azure Resource Group in which to assign the copy. + + String + + + CopyServerName + + Specifies the name of the Azure SQL Server which will host the copy. + + String + + + ElasticPoolName + + Specifies the name of the Elastic Pool in which to assign the copy. + + String + + + ServiceObjectiveName + + Specifies the name of the service objective to assign to the copy. + + String + + + Tags + + Specifies the tags to associate with the Azure SQL Database copy. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + CopyDatabaseName + + Specifies the name of the Azure SQL Database copy. + + String + + + + + + CopyDatabaseName + + Specifies the name of the Azure SQL Database copy. + + String + + String + + + none + + + CopyResourceGroupName + + Specifies the name of the Azure Resource Group in which to assign the copy. + + String + + String + + + none + + + CopyServerName + + Specifies the name of the Azure SQL Server which will host the copy. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the Azure SQL Database to copy. + + String + + String + + + none + + + ElasticPoolName + + Specifies the name of the Elastic Pool in which to assign the copy. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the Azure Resource Group that the database being copied is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the Azure SQL Server that contains the database to copy. + + String + + String + + + none + + + ServiceObjectiveName + + Specifies the name of the service objective to assign to the copy. + + String + + String + + + none + + + Tags + + Specifies the tags to associate with the Azure SQL Database copy. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + none + + + + + + + + + + + + + The New-AzureRmSqlDatabaseCopy cmdlet accepts pipelined instances of the Database object for the source database. + + + + + + + + + + + + + + The output is object of type Database. It represents the new database created as a copy. + + + + + + + + 1: + + + + + + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + + + + New-AzureRmSqlDatabaseDataMaskingRule + + Creates a data masking rule for an Azure SQL database. + + + + + New + AzureRmSqlDatabaseDataMaskingRule + + - Gets pricing tier hints for upgrading a SQL Database server. + The New-AzureRmSqlDatabaseDataMaskingRule cmdlet creates a data masking rule for 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. - - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - - - - - Get-AzureRmSqlServerCommunicationLink + + + New-AzureRmSqlDatabaseDataMaskingRule + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + 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. + + 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. + + Double] + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + PrefixSize + + Specifies the number of characters in the beginning of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + UInt32] + + + ReplacementString + + Specifies the number of characters in the end of the text that are 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 at the end of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + UInt32] + + + ColumnName + + Specifies the name of the column targeted by the masking rule. + + 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. + + + NoMasking + Default + Text + Number + SocialSecurityNumber + CreditCardNumber + Email + + + + SchemaName + + Specifies the name of a schema. + + String + + + TableName + + Specifies the name of the database table containing the masked column. + + String + + + + + + ColumnName + + Specifies the name of the column targeted by the masking rule. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + 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 + + + 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. + + Double] + + 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. + + Double] + + 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 + + + PrefixSize + + Specifies the number of characters in the beginning of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + UInt32] + + UInt32] + + + none + + + ReplacementString + + Specifies the number of characters in the end of the text that are 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 + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + SchemaName + + Specifies the name of a schema. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the database. + + String + + String + + + none + + + SuffixSize + + Specifies the number of characters at the end of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + UInt32] + + UInt32] + + + none + + + TableName + + Specifies the name of the database table containing the masked column. + + String + + String + + + none + + + + + + + + + + + + + None. + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel + + + + + + + + + + + + + + + Example 1: Create a data masking rule for a number column in a database + + + + 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; all of these items are contained in the database database01. The rule is a number masking rule that uses a random number between 5 and 14 as the mask value. The rule is named rule01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseDataMaskingRule + + + + Remove-AzureRmSqlDatabaseDataMaskingRule + + + + Set-AzureRmSqlDatabaseDataMaskingRule + + + + Azure SQL Database Cmdlets + + + + + + + New-AzureRmSqlDatabaseSecondary + + Creates a new secondary database for an existing Azure SQL Database and starts data replication. + + + + + New + AzureRmSqlDatabaseSecondary + + - Gets server communication links and their property values in an Azure SQL Server. + The New-AzureRMSqlDatabaseSecondary 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. - - - - Get - AzureRmSqlServerCommunicationLink - - - - The Get-AzureRmSqlServerCommunicationLink cmdlet gets server-to-server partnerships for Elastic transactions and their property values. Specify the name of an existing server communication link to see the property values for only that one. - - - - Get-AzureRmSqlServerCommunicationLink - - LinkName - - Specifies the name of the server communication link that this cmdlet gets. - - String - - - ServerName - - Specifies the name of the one of the servers that contain the server communication link that this cmdlet gets. - - String - - - ResourceGroupName - - Specifies the name of the resource group that contains the server communication link that this cmdlet gets. - - String - - - - - - LinkName - - Specifies the name of the server communication link that this cmdlet gets. - - String - - String - - - - - - ServerName - - Specifies the name of the one of the servers that contain the server communication link that this cmdlet gets. - - String - - String - - - - - - ResourceGroupName - - Specifies the name of the resource group that contains the server communication link that this cmdlet gets. - - String - - String - - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerCommunicationLinkModel - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- Example 1: Get all communication links for a server -------------------------- - - PS C:\> - - PS C:\> Get-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" - - Gets all server-to-server partnership for Elastic transactions that the specified server is involved in. - - - - - - - - - - - - - - -------------------------- Example 2: Get a named communication link for a server -------------------------- - - PS C:\> - - PS C:\> Get-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" -LinkName "link01" - - Gets the specified server-to-server partnership for Elastic transactions. - - - - - - - - - - - - - - - - - - - - New-AzureRmSqlDatabase + + + New-AzureRmSqlDatabaseSecondary + + ResourceGroupName + + Specifies the name of the Azure Resource Group the primary Azure SQL Database is assigned to. + + String + + + ServerName + + Specifies the name of the Azure SQL Server of the primary Azure SQL Database. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database to act as primary. + + String + + + AllowConnections + + Specifies the read intent of the secondary Azure SQL Database. + + + No + All + + + + SecondaryElasticPoolName + + Specifies the name of the Elastic Pool in which to put the secondary. + + String + + + SecondaryServiceObjectiveName + + Specifies the name of the service objective to assign to the secondary. + + String + + + Tags + + Specifies the tags to associate with the Azure SQL Database replication link. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + PartnerResourceGroupName + + Specifies the name of the Azure Resource Group the secondary database will be assigned to. + + String + + + PartnerServerName + + Specifies the name of the Azure SQL Server on which to create secondary. + + String + + + + + + AllowConnections + + Specifies the read intent of the secondary Azure SQL Database. + + AllowConnections + + AllowConnections + + + none + + + DatabaseName + + Specifies the name of the Azure SQL Database to act as primary. + + String + + String + + + none + + + PartnerResourceGroupName + + Specifies the name of the Azure Resource Group the secondary database will be assigned to. + + String + + String + + + none + + + PartnerServerName + + Specifies the name of the Azure SQL Server on which to create secondary. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the Azure Resource Group the primary Azure SQL Database is assigned to. + + String + + String + + + none + + + SecondaryElasticPoolName + + Specifies the name of the Elastic Pool in which to put the secondary. + + String + + String + + + none + + + SecondaryServiceObjectiveName + + Specifies the name of the service objective to assign to the secondary. + + String + + String + + + none + + + ServerName + + Specifies the name of the Azure SQL Server of the primary Azure SQL Database. + + String + + String + + + none + + + Tags + + Specifies the tags to associate with the Azure SQL Database replication link. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + none + + + + + + + + + + + + + The New-AzureRmSqlDatabaseSecondary cmdlet accepts pipelined instances of the Database object for the primary database. + + + + + + + + + + + + + + The output type is a ReplicationLink object. + + + + + + + + 1: + + + + + + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + Remove-AzureRmSqlDatabaseSecondary + + + + Set-AzureRmSqlDatabaseSecondary + + + + + + + New-AzureRmSqlDatabase + + Creates an Azure SQL database or an elastic database. + + + + + New + AzureRmSqlDatabase + + - Creates an Azure SQL database or an elastic database. + 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 - - - - 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: + + + New-AzureRmSqlDatabase + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of the server that will host the database. + + String + + + CatalogCollation + + Specifies the name of the Azure SQL database catalog collation. + + String + + + CollationName + + Specifies the name of the Azure SQL database collation. + + String + + + 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: + + + None + Premium + Basic + Standard + DataWarehouse + Free + + + + ElasticPoolName + + Specifies the name of the elastic pool in which to put the database. + + String + + + MaxSizeBytes + + Specifies the maximum size of the database in bytes. + + Int64 + + + RequestedServiceObjectiveName + + Specifies the name of the service objective to assign to the database. + + String + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new database. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + DatabaseName + + Specifies the name of the database. + + String + + + + + + CatalogCollation + + Specifies the name of the Azure SQL database catalog collation. + + String + + String + + + none + + + CollationName + + Specifies the name of the Azure SQL database collation. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + DatabaseEdition + + DatabaseEdition + + + none + + + ElasticPoolName + + Specifies the name of the elastic pool in which to put the database. + + String + + String + + + none + + + MaxSizeBytes + + Specifies the maximum size of the database in bytes. + + Int64 + + Int64 + + + none + + + RequestedServiceObjectiveName + + Specifies the name of the service objective to assign to the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that will host the database. + + String + + String + + + none + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new database. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + Example 1: Create a database on a specified server + + + + PS C:\> New-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" +ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US @@ -5353,27 +5772,25 @@ 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 +Tags : + + This command creates a database named database01 on server server01. + + + + + + + + + + + Example 2: Create an elastic database on a specified server + + + + PS C:\> New-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -ElasticPoolName "elasticpool01" +ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database02 Location : Central US @@ -5390,1246 +5807,331 @@ 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - - - - - - - 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 - +Tags : + + This command creates a database named database01 in the elastic pool named elasticpool01 on server server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabase + + + + Remove-AzureRmSqlDatabase + + + + Resume-AzureRmSqlDatabase + + + + Set-AzureRmSqlDatabase + + + + Suspend-AzureRmSqlDatabase + + + + New-AzureRmSqlServer + + + + New-AzureRmSqlElasticPool + + + + Azure SQL Database Cmdlets + + + + + + + New-AzureRmSqlElasticPool + + Creates an elastic database pool for an Azure SQL Database. + + - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - - - - - - - New-AzureRmSqlElasticPool + + New + AzureRmSqlElasticPool + + - Creates an elastic database pool in Azure SQL Database. + The New-AzureRmSqlElasticPool cmdlet creates an elastic database pool for an 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 + + + New-AzureRmSqlElasticPool + + ResourceGroupName + + Specifies the name of the resource group that the elastic pool will be assigned to. + + String + + + ServerName + + Specifies the name of the server that will host the elastic pool. + + String + + + DatabaseDtuMax + + Specifies the maximum number of Database Throughput Units (DTUs) that any single database in the pool can consume. The default values for the different editions are as follows: + -- Basic. 5 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 + + 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 + + + Dtu + + Specifies the total number of shared DTUs for the elastic pool. The default values for the different editions are as follows: + -- Basic. 100 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 + + Int32 + + + Edition + + Specifies the edition of the Azure SQL Database used 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 + For the current preview, the edition must be Standard. + + + None + Premium + Basic + Standard + DataWarehouse + Free + + + + 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 + + https://azure.microsoft.com/en-us/documentation/articles/sql-database-elastic-pool-reference/ + + + . + + + Int32 + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the elastic pool. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet creates. + + String + + + + + + DatabaseDtuMax + + Specifies the maximum number of Database Throughput Units (DTUs) that any single database in the pool can consume. The default values for the different editions are as follows: + -- Basic. 5 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 + + 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 + + + Dtu + + Specifies the total number of shared DTUs for the elastic pool. The default values for the different editions are as follows: + -- Basic. 100 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + Int32 + + Int32 + + + none + + + Edition + + Specifies the edition of the Azure SQL Database used for the elastic pool. Valid values are: + -- Premium +-- Basic +-- Standard + For the current preview, the edition must be Standard. + + DatabaseEdition + + DatabaseEdition + + + none + + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet creates. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the elastic pool will be assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that will host the elastic pool. + + String + + String + + + 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 + + https://azure.microsoft.com/en-us/documentation/articles/sql-database-elastic-pool-reference/ + + + . + + + Int32 + + Int32 + + + none + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the elastic pool. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + + + + + + + + + + + + + + + Example 1: Create an elastic pool + + + + PS C:\> New-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" -Edition "Standard" -Dtu 400 -DatabaseDtuMin 10 -DatabaseDtuMax 100 +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 @@ -6641,5132 +6143,5064 @@ Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 -Tags : - - - - - - - - - - - - - - Azure SQL Database - - - - - Get-AzureRmSqlElasticPool - - - - - Get-AzureRmSqlElasticPoolActivity - - - - - Get-AzureRmSqlElasticPoolDatabase - - - - - Remove-AzureRmSqlElasticPool - - - - - Set-AzureRmSqlElasticPool - - - - - - - - - New-AzureRmSqlServer +Tags : + + This command creates an elastic pool in the Standard service tier named elasticpool01. The server named server01, assigned to an Azure resource group named resourcegroup01, hosts the elastic pool in. The command specifies DTU property values for the pool and the databases in the pool. + + + + + + + + + + + + + Get-AzureRmSqlElasticPool + + + + Get-AzureRmSqlElasticPoolActivity + + + + Get-AzureRmSqlElasticPoolDatabase + + + + Remove-AzureRmSqlElasticPool + + + + Set-AzureRmSqlElasticPool + + + + Azure SQL Database Cmdlets + + + + + + + New-AzureRmSqlServerCommunicationLink + + Creates a SQL Server communication link. + + + + + New + AzureRmSqlServerCommunicationLink + + - Creates an Azure SQL Database server. + The New-AzureRmSqlServerCommunicationLink cmdlet creates a SQL Server communication link. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + New-AzureRmSqlServerCommunicationLink + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of a SQL Server. + + String + + + LinkName + + Specifies a name for the new communication link. + + String + + + PartnerServer + + Specifies the partner server for the new link. + + String + + + + + + LinkName + + Specifies a name for the new communication link. + + String + + String + + + none + + + PartnerServer + + Specifies the partner server for the new link. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a SQL Server. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1: + + + + + + + + + + + + + + + + + + Get-AzureRmSqlServerCommunicationLink + + + + Remove-AzureRmSqlServerCommunicationLink + + + + Set-AzureRmSqlServerCommunicationLink + + + + + + + New-AzureRmSqlServerFirewallRule + + Creates a firewall rule for an Azure SQL Database server. + + + + + New + AzureRmSqlServerFirewallRule + + - Creates a firewall rule for an Azure SQL Database server. + The New-AzureRmSqlServerFirewallRule cmdlet creates a firewall rule for the specified 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + New-AzureRmSqlServerFirewallRule + + ResourceGroupName + + Specifies the name of a resource group that server is assigned to. + + String + + + ServerName + + Specifies the name of a server. Specify the server name, not the fully qualified DNS name. + + String + + + AllowAllAzureIPs + + Indicates that this firewall rule allows all Azure IP addresses to access the server. + + + + + New-AzureRmSqlServerFirewallRule + + ResourceGroupName + + Specifies the name of a resource group that server is assigned to. + + String + + + ServerName + + Specifies the name of a server. Specify the server name, not the fully qualified DNS name. + + String + + + EndIpAddress + + Specifies the end value of the IP address range for this rule. + + String + + + 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 + + + + + + AllowAllAzureIPs + + Indicates that this firewall rule allows all Azure IP addresses to access the server. + + SwitchParameter + + SwitchParameter + + + none + + + EndIpAddress + + Specifies the end value of the IP address range for this rule. + + String + + String + + + none + + + FirewallRuleName + + Specifies the name of the new firewall rule. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of a resource group that server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a server. Specify the server name, not the fully qualified DNS name. + + String + + String + + + none + + + StartIpAddress + + Specifies the start value of the IP address range for the firewall rule. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + + + + + + + + + + + + + + + Example 1: Create a firewall rule + + + + PS C:\> New-AzureRmSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -FirewallRuleName "rule01" -StartIpAddress "192.168.0.198" -EndIpAddress "192.168.0.199" +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 - - - - - - - - - New-AzureRmSqlServerCommunicationLink +FirewallRuleName : rule01 + + This command creates a firewall rule named rule01 on the server named server01. The rule includes the specified start and end IP addresses. + + + + + + + + + + + + + Get-AzureRmSqlServerFirewallRule + + + + Remove-AzureRmSqlServerFirewallRule + + + + Set-AzureRmSqlServerFirewallRule + + + + Azure SQL Database Cmdlets + + + + + + + New-AzureRmSqlServer + + Creates an Azure SQL Database server. + + + + + New + AzureRmSqlServer + + - Creates an Azure SQL Server partnership for Elastic transactions. Once established, Elastic transactions will be able to span databases in either of the servers paired. + The New-AzureRmSqlServer cmdlet creates an Azure SQL Database server. - - - - New - AzureRmSqlServerCommunicationLink - - - - The New-AzureRmSqlServerCommunicationLink cmdlet creates an Azure SQL Server partnership for Elastic transactions. The partnership can be set up for two servers at a time and once established, Elastic transactions will be able to span databases in either of the servers paired. Users can create many server partnerships as necessary and involve a server in multiple partnerships to span Elastic transactions over a larger number of servers. - - - - New-AzureRmSqlServerCommunicationLink - - LinkName - - Specifies the name of the server communication link that this cmdlet creates. - - String - - - PartnerServer - - Specifies the name of the other server taking part in this partnership. - - String - - - ServerName - - Specifies the name of the server to set up the partnership on. - - String - - - ResourceGroupName - - Specifies the name of the resource group the server named in the 'ServerName' parameter. - - String - - - - - - LinkName - - Specifies the name of the server communication link that this cmdlet creates. - - String - - String - - - - - - PartnerServer - - Specifies the name of the other server taking part in this partnership. - - String - - String - - - - - - ServerName - - Specifies the name of the server to set up the partnership on. - - String - - String - - - - - - ResourceGroupName - - Specifies the name of the resource group the server named in the 'ServerName' parameter. - - String - - String - - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerCommunicationLinkModel - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- Example 1: Create a new Azure SQL Server communication link -------------------------- - - PS C:\> - - PS C:\> New-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" -LinkName "link01" -PartnerServer "server02" - - - - - - - - - - - - - - - - - - - - - - Remove-AzureRmSqlDatabase + + + New-AzureRmSqlServer + + ResourceGroupName + + Specifies the name of the resource group which the server will be assigned to. + + 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 + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new server. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + Location + + Specifies the location of the data center where this cmdlet creates the server. + + String + + + ServerName + + Specifies the name of the new server. + + String + + + SqlAdministratorCredentials + + Specifies the SQL Database server administrator credentials 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 + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group which the server will be assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the new server. + + String + + 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 + + + SqlAdministratorCredentials + + Specifies the SQL Database server administrator credentials 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 + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new server. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + + + + + + + + + + + + + + + Example 1: Create a new Azure SQL Database server + + + + PS C:\> New-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -Location "Central US" -ServerName "server01" -ServerVersion "12.0" +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Australia East +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : + + This command creates a version 12 Azure SQL Database server. + + + + + + + + + + + + + Get-AzureRmSqlServer + + + + Remove-AzureRmSqlServer + + + + Set-AzureRmSqlServer + + + + New-AzureRmSqlServerFirewallRule + + + + Azure SQL Database Cmdlets + + + + + + + Remove-AzureRmSqlDatabaseAuditing + + Removes the auditing of an Azure SQL database. + + + + + Remove + AzureRmSqlDatabaseAuditing + + - Removes an Azure SQL database. + 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. + If you remove auditing of an Azure SQL database, threat detection is also removed. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Remove-AzureRmSqlDatabaseAuditing + + + + + + + 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:\> Remove-AzureRmSqlDatabaseAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command removes the auditing of database named database01. That database is located on server01, which is assigned to the resource group named resourcegroup01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseAuditingPolicy + + + + Set-AzureRmSqlDatabaseAuditingPolicy + + + + Azure SQL Database Cmdlets + + + + + + + Remove-AzureRmSqlDatabaseDataMaskingRule + + Removes a data masking rule from an Azure SQL database. + + + + + Remove + AzureRmSqlDatabaseDataMaskingRule + + - Removes auditing of an Azure SQL database. + 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 - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Remove-AzureRmSqlDatabaseDataMaskingRule + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + ColumnName + + Specifies the name of the column targeted by the masking rule. + + System.String + + + SchemaName + + Specifies the name of a schema. + + System.String + + + TableName + + Specifies the name of an Azure SQL Table. + + System.String + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + + + 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. + + + + + + + ColumnName + + Specifies the name of the column targeted by the masking rule. + + System.String + + System.String + + + none + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + SchemaName + + Specifies the name of a schema. + + System.String + + System.String + + + none + + + ServerName + + Specifies the name of the server that hosts the database. + + String + + String + + + none + + + TableName + + Specifies the name of an Azure SQL Table. + + System.String + + System.String + + + none + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + 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 + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel + + + + + + + + + + + + + + + Example 1: Remove a database data masking rule + + + + PS C:\> Remove-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -RuleId "rule01" + + This command removes rule rule01 defined for the database database01 The database is located on server01 and assigned to resource group resourcegroup01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseDataMaskingRule + + + + New-AzureRmSqlDatabaseDataMaskingRule + + + + Set-AzureRmSqlDatabaseDataMaskingRule + + + + Azure SQL Database Cmdlets + + + + + + + Remove-AzureRmSqlDatabaseSecondary + + Terminates data replication between an Azure SQL Database and the specified secondary database. + + + + + Remove + AzureRmSqlDatabaseSecondary + + - Removes a data masking rule from an Azure SQL database. + The Remove-AzureRmSqlDatabaseSecondary cmdlet replaces the Stop-AzureSqlDatabaseCopy cmdlet. It forces termination of a geo-replication link. There is no replication synchronization prior to termination. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Remove-AzureRmSqlDatabaseSecondary + + ResourceGroupName + + Specifies the name of the Azure Resource Group associated with the replication link to remove. + + String + + + ServerName + + Specifies the name of the Azure SQL Server with the replication link to remove. + + String + + + DatabaseName + + Specifies the name of the primary Azure SQL Database with the replication link to remove. + + String + + + PartnerResourceGroupName + + Specifies the name of the partner Azure Resource Group. + + String + + + PartnerServerName + + Specifies the name of the partner Azure SQL Server. + + String + + + + + + DatabaseName + + Specifies the name of the primary Azure SQL Database with the replication link to remove. + + String + + String + + + none + + + PartnerResourceGroupName + + Specifies the name of the partner Azure Resource Group. + + String + + String + + + none + + + PartnerServerName + + Specifies the name of the partner Azure SQL Server. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the Azure Resource Group associated with the replication link to remove. + + String + + String + + + none + + + ServerName + + Specifies the name of the Azure SQL Server with the replication link to remove. + + String + + String + + + none + + + + + + + + + + + + + The Remove-AzureRmSqlDatabaseSecondary cmdlet accepts pipelined instances of the Database object for the primary or secondary database. + + + + + + + + + + + + + + There is no output type for this operation. + + + + + + + + 1: + + + + + + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + New-AzureRmSqlDatabaseSecondary + + + + Set-AzureRmSqlDatabaseSecondary + + + + + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + Removes the threat detection policy from a database. + + + + + Remove + AzureRmSqlDatabaseThreatDetectionPolicy + + - Terminates data replication between an Azure SQL Database and the specified secondary database. + The Remove-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet removes the threat detection policy from an Azure SQL database. + To use this cmdlet, specify the ResourceGroupName, ServerName and DatabaseName parameters to identify the database from which this cmdlet removes the policy. - - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - - - - - - - Remove-AzureRmSqlElasticPool + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of a server. + + String + + + DatabaseName + + Specifies the name of a database where the threat detection policy should be removed. + + String + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + + + + DatabaseName + + Specifies the name of a database where the threat detection policy should be removed. + + String + + String + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a server. + + String + + String + + + none + + + + + + + + + + + + + You cannot pipe input to this cmdlet. + + + + + + + Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel + + + + + + + This cmdlet returns a DatabaseThreatDetectionPolicyModel object. + + + + + + + + Example 1: Remove a threat detection policy for a database + + + + PS C:\> Remove-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" + + This command removes the threat detection policy from a database named Database01 on the server named Server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Azure SQL Database Cmdlets + + + + + + + Remove-AzureRmSqlDatabase + + Removes an Azure SQL database. + + + + + Remove + AzureRmSqlDatabase + + - Deletes an elastic database pool. + The Remove-AzureRmSqlDatabase cmdlet removes an Azure SQL database. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Remove-AzureRmSqlDatabase + + ResourceGroupName + + Specifies the name of the resource group the database is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the. + + String + + + DatabaseName + + Specifies the name of the database that this cmdlet removes. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + + + 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. + + + + + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the. + + String + + String + + + none + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + 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 + + + + + + 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:\> 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 Cmdlets + + + + + + + Remove-AzureRmSqlElasticPool + + Deletes an elastic database pool. + + + + + Remove + AzureRmSqlElasticPool + + - Removes an Azure SQL Database server. + The Remove-AzureRmSqlElasticPool cmdlet deletes an Azure SQL Database elastic pool. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Remove-AzureRmSqlElasticPool + + ResourceGroupName + + Specifies the name of the resource group that the elastic pool is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the elastic. + + String + + + ElasticPoolName + + Specifies the name of the elastic pool that this cmdlet deletes. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + + + 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. + + + + + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group that the elastic pool is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the elastic. + + String + + String + + + none + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + 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 + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + + + + + + + + + + + + + + + Example 1: Delete an elastic pool + + + + PS C:\> Remove-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" + + This command deletes an elastic pool named elasticpool01. + + + + + + + + + + + + + Get-AzureRmSqlElasticPool + + + + Get-AzureRmSqlElasticPoolActivity + + + + Get-AzureRmSqlElasticPoolDatabase + + + + New-AzureRmSqlElasticPool + + + + Set-AzureRmSqlElasticPool + + + + Azure SQL Database Cmdlets + + + + + + + Remove-AzureRmSqlServerActiveDirectoryAdministrator + + Removes an Azure AD administrator for SQL Server. + + + + + Remove + AzureRmSqlServerActiveDirectoryAdministrator + + - Removes an Azure AD administrator for SQL Server. + The Remove-AzureRmSqlServerActiveDirectoryAdministrator cmdlet removes an Azure Active Directory (Azure AD) administrator for Azure SQL Server in the current subscription. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Remove-AzureRmSqlServerActiveDirectoryAdministrator + + ResourceGroupName + + Specifies the name of the resource group that the SQL Server is assigned to. + + String + + + ServerName + + Specifies the name of the SQL Server for which this cmdlet removes an administrator. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + + + 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. + + + + + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the SQL Server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the SQL Server for which this cmdlet removes an administrator. + + String + + String + + + none + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + 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 + + + + + + Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + + + + + + + + + + + + + + + Example 1: Remove an administrator + + + + PS C:\> Remove-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" +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 +resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b + + Removes the Azure AD administrator for the server named server01 associated with the resource group resourcegroup01. + + + + + + + + + + + + + Get-AzureRmSqlServerActiveDirectoryAdministrator + + + + Set-AzureRmSqlServerActiveDirectoryAdministrator + + + + Azure SQL Database Cmdlets + + + + + + + Remove-AzureRmSqlServerAuditing + + Removes the auditing of an Azure SQL server. + + + + + Remove + AzureRmSqlServerAuditing + + - Removes auditing of an Azure SQL server. + 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 on the 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 - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Remove-AzureRmSqlServerAuditing + + ResourceGroupName + + Specifies the name of the resource group the Azure SQL server is assigned to. + + String + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + ServerName + + Specifies the name 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 + + + ResourceGroupName + + Specifies the name of the resource group the Azure SQL server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the Azure SQL server. + + String + + String + + + 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:\> Remove-AzureRmSqlDatabaseAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command removes the auditing of all the databases located on server01 in resource group. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseAuditingPolicy + + + + Set-AzureRmSqlDatabaseAuditingPolicy + + + + Azure SQL Database Cmdlets + + + + + + + Remove-AzureRmSqlServerCommunicationLink + + Removes a SQL Server communication link. + + + + + Remove + AzureRmSqlServerCommunicationLink + + - Deletes a firewall rule from an Azure SQL Database server. + The Remove-AzureRmSqlServerCommunicationLink removes a SQL Server communication link. - - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - - - - - Remove-AzureRmSqlServerCommunicationLink + + + Remove-AzureRmSqlServerCommunicationLink + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of a SQL Server. + + String + + + LinkName + + Specifies the name of the link to remove. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + + + 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. + + + + + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + LinkName + + Specifies the name of the link to remove. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a SQL Server. + + String + + String + + + none + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1: + + + + + + + + + + + + + + + + + + Get-AzureRmSqlServerCommunicationLink + + + + New-AzureRmSqlServerCommunicationLink + + + + Set-AzureRmSqlServerCommunicationLink + + + + + + + Remove-AzureRmSqlServerFirewallRule + + Deletes a firewall rule from an Azure SQL Database server. + + + + + Remove + AzureRmSqlServerFirewallRule + + - Deletes an Azure SQL Server communication link. + The Remove-AzureRmSqlServerFirewallRule cmdlet deletes a firewall rule from the specified Azure SQL Database server. - - - - Remove - AzureRmSqlServerCommunicationLink - - - - The Remove-AzureRmSqlServerCommunicationLink cmdlet deletes an existing server-to-server partnership for Elastic transactions. - - - - Remove-AzureRmSqlServerCommunicationLink - - LinkName - - Specifies the name of the server communication link 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 server communication link that this cmdlet deletes. - - String - - - ResourceGroupName - - Specifies the name of the resource group that contains the server communication link 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 - - - - - - LinkName - - Specifies the name of the server communication link that this cmdlet deletes. - - String - - String - - - - - - Force - - Forces the command to run without asking for user confirmation. - - SwitchParameter - - SwitchParameter - - - - - - ServerName - - Specifies the name of the server that contains the server communication link that this cmdlet deletes. - - String - - String - - - - - - ResourceGroupName - - Specifies the name of the resource group that contains the server communication link that this cmdlet deletes. - - String - - 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 - - SwitchParameter - - - - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerCommunicationLinkModel - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- Example 1: Delete a server communication link -------------------------- - - PS C:\> - - PS C:\> Remove-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" -LinkName "link01" - - Deletes an existing server-to-server partnership for Elastic transactions. - - - - - - - - - - - - - - - - - - - - Resume-AzureRmSqlDatabase + + + Remove-AzureRmSqlServerFirewallRule + + ResourceGroupName + + Specifies the name of a resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of the server. + + String + + + FirewallRuleName + + Specifies the name of the firewall rule that this cmdlet deletes. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + + + 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. + + + + + + + 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 + + + ResourceGroupName + + Specifies the name of a resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server. + + String + + String + + + none + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + 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 + + + + + + Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Delete a rule + + + + PS C:\> Remove-AzureRmSqlServerFirewallRule -FirewallRuleName "rule01" -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command deletes a firewall rule named rule01 on the server named server01. + + + + + + + + + + + + + Get-AzureRmSqlServerFirewallRule + + + + New-AzureRmSqlServerFirewallRule + + + + Set-AzureRmSqlServerFirewallRule + + + + Azure SQL Database Cmdlets + + + + + + + Remove-AzureRmSqlServer + + Removes an Azure SQL Database server. + + + + + Remove + AzureRmSqlServer + + - Resumes an Azure SQL Data Warehouse database. + The Remove-AzureRmSqlServer cmdlet removes an Azure SQL Database server. - - - - 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. - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Remove-AzureRmSqlServer + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of the server to be removed. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + + + 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. + + + + + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server to be removed. + + String + + String + + + none + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + 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 + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + + + + + + + + + + + + + + + Example 1: Remove a server + + + + PS C:\> Remove-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01" + + This command removes the Azure SQL Database server named server01. + + + + + + + + + + + + + Get-AzureRmSqlServer + + + + New-AzureRmSqlServer + + + + Set-AzureRmSqlServer + + + + Azure SQL Database Cmdlets + + + + + + + Resume-AzureRmSqlDatabase + + Resumes an Azure SQL Data Warehouse database. + + + + + Resume + AzureRmSqlDatabase + + - Sets properties for an Azure SQL database, or moves an existing database into an elastic pool. + The Resume-AzureRmSqlDatabase cmdlet resumes an Azure SQL Data Warehouse database. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Resume-AzureRmSqlDatabase + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + 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 + + + + + + DatabaseName + + Specifies the name of the database that this cmdlet resumes. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the database that this cmdlet resumes. + + String + + String + + + none + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + + The 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:\> Resume-AzureRmSqlDatabase -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 + + + + Azure SQL Database Cmdlets + + + + + + + Set-AzureRmSqlDatabaseAuditingPolicy + + Sets the auditing policy for an Azure SQL database. + + + + + Set + AzureRmSqlDatabaseAuditingPolicy + + - Sets the auditing policy for an Azure SQL database. + 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 the storage keys. + 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 audit log table names. 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 that policy. 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 - - - - 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 + + + Set-AzureRmSqlDatabaseAuditingPolicy + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + 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 + 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. + + + PlainSQL_Success + PlainSQL_Failure + ParameterizedSQL_Success + ParameterizedSQL_Failure + StoredProcedure_Success + StoredProcedure_Failure + Login_Success + Login_Failure + TransactionManagement_Success + TransactionManagement_Failure + All + None + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + 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. + + UInt32] + + + 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 - - - ThreatDetectionState - - Defines if threat detection is enabled or disabled for this database. - - String - - - NotificationRecipientsEmail - - A semicolon separated list of email addresses to send the alerts to. - - String - - - EmailAdmins - - Defines whether to email service and co-administrators. - - Boolean - - - ExcludedDetectionTypes - - A semicolon separated list of detection types to filter. - - 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 + The default value is Primary. + + + Primary + Secondary + + + + 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 + + + + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + 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 + 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 + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + 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. + + UInt32] + + UInt32] + + + none + + + ServerName + + Specifies the name of the server that hosts the database. + + 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + The default value is Primary. + + String + + String + + + 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 + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel + + + + + + + + + + + + + + + Example 1: Set the auditing policy of a database + + + + PS C:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -StorageAccountName "Storage31" + + This command sets the auditing policy of database named database01 located on 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:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -StorageAccountKey Secondary + + This command sets the auditing policy of database named database01 located on server01 to keep using the same storage account name but to now use the secondary key. + + + + + + + + + + + Example 3: Set the auditing policy of a database to use a specific event type + + + + PS C:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -EventType Login_Failure + + This command sets the auditing policy of database named database01 located on server01; the policy will log the Login_Failure event type. The command does not change the storage settings. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseAuditingPolicy + + + + Remove-AzureRmSqlDatabaseAuditing + + + + Azure SQL Database Cmdlets + + + + + + + Set-AzureRmSqlDatabaseDataMaskingPolicy + + Sets data masking for an Azure SQL database. + + + + + Set + AzureRmSqlDatabaseDataMaskingPolicy + + - Sets data masking for an Azure SQL database. + 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 - - - - 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 PrivilegedUsers 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 - - The parameter PrivilegedLogins is being deprecated and will be removed in a future release. Use the PrivilegedUsers parameter to provide SQL users excluded from masking. - - String - - - PrivilegedUsers - - 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: + + + Set-AzureRmSqlDatabaseDataMaskingPolicy + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the server hosting the database. + + String + + + DatabaseName + + Specifies the name of the database where the policy will be set. + + 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 - - The parameter PrivilegedLogins is being deprecated and will be removed in a future release. Use the PrivilegedUsers parameter to provide SQL users excluded from masking. - - String - - String - - - none - - - PrivilegedUsers - - 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: + The default value is Enabled. + + + Enabled + Disabled + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + PrivilegedLogins + + Specifies which SQL users are excluded from masking. + This parameter is deprecated and will be removed from future releases. + + String + + + PrivilegedUsers + + Specifies a semicolon-separated list of privileged user IDs. These users are allowed to view the masking data. + + System.String + + + + + + DatabaseName + + Specifies the name of the database where the policy will be set. + + 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + The default value is Enabled. + + String + + String + + + 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 + + + PrivilegedLogins + + Specifies which SQL users are excluded from masking. + This parameter is deprecated and will be removed from future releases. + + String + + String + + + none + + + PrivilegedUsers + + Specifies a semicolon-separated list of privileged user IDs. These users are allowed to view the masking data. + + System.String + + System.String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server hosting the database. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingPolicyModel + + + + + + + + + + + + + + + Example 1: Set the data masking policy for a database + + + + PS C:\>Set-AzureRmSqlDatabaseDataMaskingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" + + This command sets the data masking policy for a database named database01 on the server named server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseDataMaskingPolicy + + + + Get-AzureRmSqlDatabaseDataMaskingRule + + + + New-AzureRmSqlDatabaseDataMaskingRule + + + + Remove-AzureRmSqlDatabaseDataMaskingRule + + + + Set-AzureRmSqlDatabaseDataMaskingRule + + + + Azure SQL Database Cmdlets + + + + + + + Set-AzureRmSqlDatabaseDataMaskingRule + + Sets the properties of a data masking rule for an Azure SQL database. + + + + + Set + AzureRmSqlDatabaseDataMaskingRule + + - Sets the properties of a data masking rule in an Azure SQL database. + The Set-AzureRmSqlDatabaseDataMaskingRule cmdlet is used to set a data masking rule for 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 describes the data masking rule properties and the rule identifiers. Rule identifiers include, but are not limited to, ResourceGroupName, ServerName, DatabaseName, and RuleId. - - - - 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 + + + Set-AzureRmSqlDatabaseDataMaskingRule + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the database. + + String + + + DatabaseName + + Specifies the name of the database. + + 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 + The default value is Default. + + + NoMasking + Default + Text + Number + SocialSecurityNumber + CreditCardNumber + Email + + + + 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. + + 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. + + Double] + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + PrefixSize + + Specifies the number of characters at the beginning of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + UInt32] + + + ReplacementString + + Specifies the number of characters at the end of the text that are 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 at the end of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + UInt32] + + + ColumnName + + Specifies the name of the column targeted by the masking rule. + + String + + + SchemaName + + Specifies the name of a schema. + + String + + + TableName + + Specifies the name of the database table containing the masked column. + + String + + + + + + ColumnName + + Specifies the name of the column targeted by the masking rule. + + String + + String + + + none + + + DatabaseName + + Specifies the name of the database. + + 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + The default value is Default. + + String + + String + + + 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. + + Double] + + 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. + + Double] + + 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 + + + PrefixSize + + Specifies the number of characters at the beginning of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + UInt32] + + UInt32] + + + none + + + ReplacementString + + Specifies the number of characters at the end of the text that are 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 + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + SchemaName + + Specifies the name of a schema. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the database. + + String + + String + + + none + + + SuffixSize + + Specifies the number of characters at the end of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. + + UInt32] + + UInt32] + + + none + + + TableName + + Specifies the name of the database table containing the masked column. + + String + + String + + + none + + + + + + + + + + + + + None. + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel + + + + + + + + + + + + + + + Example 1: Change the range of a data masking rule in a database + + + + 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 Cmdlets + + + + + + + Set-AzureRmSqlDatabaseSecondary + + Switches a secondary Azure SQL Database to the primary in order to initiate failover. + + + + + Set + AzureRmSqlDatabaseSecondary + + + + The Set-AzureRmSqlDatabaseSecondary cmdlet is designed as a general configuration command, but is currently limited to initiating failover. Use it with the AllowDataLoss parameter to initiate a force failover during an outage. You do not have to this parameter 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 + + ResourceGroupName + + Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. + + String + + + ServerName + + Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database Secondary. + + String + + + AllowDataLoss + + Determines if this failover operation will allow data loss. + + + + Failover + + Determines if this operation is a failover. + + + + PartnerResourceGroupName + + Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. + + String + + + + Set-AzureRmSqlDatabaseSecondary + + ResourceGroupName + + Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. + + String + + + ServerName + + Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database Secondary. + + String + + + PartnerResourceGroupName + + Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. + + String + + + + + + AllowDataLoss + + Determines if this failover operation will allow data loss. + + SwitchParameter + + SwitchParameter + + + none + + + DatabaseName + + Specifies the name of the Azure SQL Database Secondary. + + String + + String + + + none + + + Failover + + Determines if this operation is a failover. + + SwitchParameter + + SwitchParameter + + + none + + + PartnerResourceGroupName + + Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. + + String + + String + + + none + + + + + + + + + + + + + Set-AzureRmSqlDatabaseSecondary accepts instances of the Database object for the secondary database to fail over and make the primary database. + + + + + + + + + + + + + + The output type is a ReplicationLink object. + + + + + + + + 1: + + + + + + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + New-AzureRmSqlDatabaseSecondary + + + + Remove-AzureRmSqlDatabaseSecondary + + + + + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + Sets a threat detection policy on a database. + + + + + Set + AzureRmSqlDatabaseThreatDetectionPolicy + + - Switches a secondary Azure SQL Database to the primary in order to failover. + The Set-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet sets a threat detection policy on an Azure SQL database. In order to enable threat detection on a database an auditing policy must be enabled on that database. + To use this cmdlet, specify the ResourceGroupName, ServerName and DatabaseName parameters to identify the database. - - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - - - - - - - Set-AzureRmSqlDatabaseTransparentDataEncryption + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of the server. + + String + + + DatabaseName + + Specifies the name of the database where the policy will be set. + + String + + + EmailAdmins + + Specifies whether the threat detection policy contacts administrators by using email. + + Boolean] + + + ExcludedDetectionType + + Specifies an array of detection types to exclude from the policy. Valid values are: + +-- Sql_Injection +-- Sql_Injection_Vulnerability +-- Access_Anomaly +-- Usage_Anomaly +-- None + + + Sql_Injection + Sql_Injection_Vulnerability + Access_Anomaly + Usage_Anomaly + None + + + + NotificationRecipientsEmails + + Specifies a semicolon-separated list of email addresses to which the policy sends alerts. + + String + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + + + + DatabaseName + + Specifies the name of the database where the policy will be set. + + String + + String + + + none + + + EmailAdmins + + Specifies whether the threat detection policy contacts administrators by using email. + + Boolean] + + Boolean] + + + none + + + ExcludedDetectionType + + Specifies an array of detection types to exclude from the policy. Valid values are: + +-- Sql_Injection +-- Sql_Injection_Vulnerability +-- Access_Anomaly +-- Usage_Anomaly +-- None + + String[] + + String[] + + + none + + + NotificationRecipientsEmails + + Specifies a semicolon-separated list of email addresses to which the policy sends alerts. + + String + + String + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server. + + String + + String + + + none + + + + + + + + + + + + + You cannot pipe input to this cmdlet. + + + + + + + Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel + + + + + + + This cmdlet returns a Model.DatabaseThreatDetectionPolicyModel object. + + + + + + + + Example 1: Set the threat detection policy for a database + + + + PS C:\> Set-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" + + This command sets the threat detection policy for a database named Database01 on the server named Server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Azure SQL Database Cmdlets + + + + + + + Set-AzureRmSqlDatabaseTransparentDataEncryption + + Modifies TDE for an Azure SQL database. + + + + + Set + AzureRmSqlDatabaseTransparentDataEncryption + + - Modifies TPE for an Azure SQL database. + + 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 - - - - 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 + + + Set-AzureRmSqlDatabaseTransparentDataEncryption + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the. + + String + + + DatabaseName + + Specifies the name of the database that this cmdlet modifies. + + String + + + 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 + + + Enabled + Disabled + + + + + + + DatabaseName + + Specifies the name of the database that this cmdlet modifies. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the. + + String + + String + + + none + + + 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + TransparentDataEncryptionStateType + + TransparentDataEncryptionStateType + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel + + + + + + + + + + + + + + + Example 1: Enable TDE for a database + + + + PS C:\> Set-AzureRmSqlDatabaseTransparentDataEncryption -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -State Enabled +ResourceGroupName ServerName DatabaseName State ----------------- ---------- ------------ ----- -resourcegroup01 server01 database01 Enabled - - - - - - - - - - - - - - Get-AzureRmSqlDatabaseTransparentDataEncryption - - - - - Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity - - - - - - - - - Set-AzureRmSqlElasticPool +resourcegroup01 server01 database01 Enabled + + This command enables TDE for the database named database01 on the server named server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseTransparentDataEncryption + + + + Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity + + + + Azure SQL Database Cmdlets + + + + + + + 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. In addition, you can specify the ElasticPoolName parameter to move a database into an elastic pool. If a database is already in an elastic pool, you can use the RequestedServiceObjectiveName parameter to assign a performance level. + + + + Set-AzureRmSqlDatabase + + ResourceGroupName + + Specifies the name of resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + Edition + + Specifies the edition for the database. Valid values are: + +-- Default +-- None +-- Premium +-- Basic +-- Standard + + + None + Premium + Basic + Standard + DataWarehouse + Free + + + + ElasticPoolName + + Specifies name of the elastic pool in which to move 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 allowed values per edition. + + Int64 + + + 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 + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new server. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + Edition + + Specifies the edition for the database. Valid values are: + +-- Default +-- None +-- Premium +-- Basic +-- Standard + + DatabaseEdition + + DatabaseEdition + + + none + + + ElasticPoolName + + Specifies name of the elastic pool in which to move 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 allowed values per edition. + + Int64 + + Int64 + + + 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 + + + ResourceGroupName + + Specifies the name of resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the database. + + String + + String + + + none + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the new server. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + Example 1: Update a database to a Standard S2 database + + + + PS C:\> Set-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ServerName "server01" -Edition "Standard" -RequestedServiceObjectiveName "S2" +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 : + + This command updates a database named database01 to a Standard S2 database on a server named server01. + + + + + + + + + + + Example 2: Add a database to an elastic pool + + + + PS C:\> Set-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ServerName "server01" -ElasticPoolName "elasticpool01" +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 : + + The following command adds a database named database01 to the elastic pool named elasticpool01 hosted on the server named server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabase + + + + New-AzureRmSqlDatabase + + + + Remove-AzureRmSqlDatabase + + + + Resume-AzureRmSqlDatabase + + + + Suspend-AzureRmSqlDatabase + + + + Azure SQL Database Cmdlets + + + + + + + Set-AzureRmSqlElasticPool + + Modifies properties of an elastic database pool in Azure SQL Database. + + + + + Set + AzureRmSqlElasticPool + + - Modifies properties for an elastic database pool in Azure SQL Database. + The Set-AzureRmSqlElasticPool cmdlet modifies properties for an elastic database pool in an Azure SQL Database. This cmdlet can modify the minimum Database Throughput Units (DTUs) per database, as well as the maximum DTUs per database, the number of DTUs for the pool, and the storage limit for the pool. - - - - 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 + + + Set-AzureRmSqlElasticPool + + ResourceGroupName + + Specifies the name of the resource group that the elastic pool is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the elastic pool. + + String + + + ElasticPoolName + + Specifies the name of the elastic pool. + + String + + + DatabaseDtuMax + + Specifies the maximum number of DTUs that any single database in the pool can consume. The default values for different editions are: + -- Basic. 5 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 + + 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 + + + Dtu + + Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are: + -- Basic. 100 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 + + Int32 + + + Edition + + Specifies the edition of the Azure SQL Database for the elastic pool. You cannot change the edition. + + + None + Premium + Basic + Standard + DataWarehouse + Free + + + + StorageMB + + Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the New-AzureRmSqlElasticPool cmdlet. + + Int32 + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the elastic pool. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + + + + DatabaseDtuMax + + Specifies the maximum number of DTUs that any single database in the pool can consume. The default values for different editions are: + -- Basic. 5 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 + + 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 + + + Dtu + + Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are: + -- Basic. 100 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + Int32 + + Int32 + + + none + + + Edition + + Specifies the edition of the Azure SQL Database for the elastic pool. You cannot change the edition. + + DatabaseEdition + + DatabaseEdition + + + none + + + ElasticPoolName + + Specifies the name of the elastic pool. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the elastic pool is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the elastic pool. + + String + + String + + + none + + + StorageMB + + Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the New-AzureRmSqlElasticPool cmdlet. + + Int32 + + Int32 + + + none + + + Tags + + Specifies a dictionary of tags that this cmdlet associates with the elastic pool. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel + + + + + + + + + + + + + + + Example 1: Modify properties for an elastic pool + + + + PS C:\>Set-AzureRmSqlDatabaseElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" -Dtu 1000 -DatabaseDtuMax 100 -DatabaseDtuMin 20 +ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 @@ -11778,2327 +11212,2254 @@ 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 +Tags : + + This command modifies properties for an elastic pool named elasticpool01. The command sets the number of DTUs for the elastic pool to 1000 and sets the minimum and maximum DTUs. + + + + + + + + + + + + + Get-AzureRmSqlElasticPool + + + + Get-AzureRmSqlElasticPoolActivity + + + + Get-AzureRmSqlElasticPoolDatabase + + + + New-AzureRmSqlElasticPool + + + + Azure SQL Database Cmdlets + + + + + + + Set-AzureRmSqlServerActiveDirectoryAdministrator + + Provisions an Azure AD administrator for SQL Server. + + + + + 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 + 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 a SQL Server administrator: + -- Native members of Azure AD -- Federated members of Azure AD --- Imported members from other Azure AD who are native or federated members +-- Imported members from other Azure ADs 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + 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, either. + We recommend that you provision a dedicated Azure AD group as an administrator. + + + + Set-AzureRmSqlServerActiveDirectoryAdministrator + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of 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. + + String + + + ObjectId + + Specifies the unique ID of the Azure AD administrator that this cmdlet provisions. If the display name is not unique, you must specify a value for this parameter. + + Guid + + + + + + DisplayName + + Specifies the display name of the Azure AD administrator that this cmdlet provisions. + + String + + String + + + none + + + ObjectId + + Specifies the unique ID of the Azure AD administrator that this cmdlet provisions. If the display name is not unique, you must specify a value for this parameter. + + Guid + + Guid + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the SQL Server for which this cmdlet provisions an administrator. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel + + + + + + + + + + + + + + + Example 1: Provision an administrator group for a server + + + + PS C:\>Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "DBAs" +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 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b + + This command provisions an Azure AD administrator group named DBAs for the server named server01. This server is associated with resource group resourcegroup01. + + + + + + + + + + + Example 2: Provision an administrator user for a server + + + + PS C:\>Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "David Chew" +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 David Chew 11E95548-B179-4FE1-9AF4-ACA49D13ABB9 + + This command provisions an Azure AD user (David Chew) as an administrator for the server named server01. + + + + + + + + + + + Example 3: Provision an administrator group by specifying its ID + + + + PS C:\> Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "DBAs" -ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b" +ResourceGroupName ServerName DisplayName ObjectId ----------------- ---------- ----------- -------- -resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b - - - - - - - - - - - - - Get-AzureRmSqlServerActiveDirectoryAdministrator - - - - - Remove-AzureRmSqlServerActiveDirectoryAdministrator - - - - - - - - - Set-AzureRmSqlServerAuditingPolicy +resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b + + This command provisions an Azure AD administrator group named DBAs for the server named server01. The command specifies an ID for the ObjectId parameter. This ensures that the command will succeed even if the display name of the group is not unique. + + + + + + + + + + + + + Get-AzureRmSqlServerActiveDirectoryAdministrator + + + + Remove-AzureRmSqlServerActiveDirectoryAdministrator + + + + Azure SQL Database Cmdlets + + + + + + + Set-AzureRmSqlServerAuditingPolicy + + Changes the auditing policy of an Azure SQL server. + + + + + Set + AzureRmSqlServerAuditingPolicy + + - Changes the auditing policy of an Azure SQL server. + 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 the 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 audit log table names. 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 identifiers. Server identifiers include, but are not limited to, ResourceGroupName and ServerName. - - - - 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 + + + Set-AzureRmSqlServerAuditingPolicy + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + String + + + 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 + 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 command fails. + + + PlainSQL_Success + PlainSQL_Failure + ParameterizedSQL_Success + ParameterizedSQL_Failure + StoredProcedure_Success + StoredProcedure_Failure + Login_Success + Login_Failure + TransactionManagement_Success + TransactionManagement_Failure + All + None + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + RetentionInDays + + Specifies the number of retention days for the audit logs table. A value of zero (0) means that the table is not retained; this is the . If you specify a value greater than zero you must also specify a value for the TableIdentifer parameter. + + UInt32] + + + 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 command 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 + The default value is Primary. + + + Primary + Secondary + + + + 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 + + + + + + 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 + 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 command fails. + + String[] + + String[] + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group that contains the database. + + 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; this is the . If you specify a value greater than zero you must also specify a value for the TableIdentifer parameter. + + UInt32] + + UInt32] + + + none + + + ServerName + + Specifies the name of the server that contains the database. + + 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 command 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + The default value is Primary. + + String + + String + + + 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 + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel + + + + + + + + + + + + + + + Example 1: Set the auditing policy of an Azure SQL server + + + + PS C:\> Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -StorageAccountName "Storage22" + + This command sets the auditing policy of the server named server01 to use a storage account named Storage22. + + + + + + + + + + + Example 2: Set the storage account key of an existing auditing policy of an Azure SQL server + + + + 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:\> 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 + + + + Azure SQL Database Cmdlets + + + + + + + Set-AzureRmSqlServerCommunicationLink + + Modifies a SQL Server communication link. + + + + + Set + AzureRmSqlServerCommunicationLink + + - Modifies a firewall rule in Azure SQL Database server. + The Set-AzureRmSqlServerCommunicationLink cmdlet modifies a SQL Server communication link. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Set-AzureRmSqlServerCommunicationLink + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of a SQL Server. + + String + + + LinkName + + Specifies the name of the link to modify. + + String + + + PartnerServer + + Specifies a partner server. + + String + + + + + + LinkName + + Specifies the name of the link to modify. + + String + + String + + + none + + + PartnerServer + + Specifies a partner server. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a SQL Server. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1: + + + + + + + + + + + + + + + + + + Get-AzureRmSqlServerCommunicationLink + + + + New-AzureRmSqlServerCommunicationLink + + + + Remove-AzureRmSqlServerCommunicationLink + + + + + + + Set-AzureRmSqlServerFirewallRule + + Modifies a firewall rule in Azure SQL Database server. + + + + + Set + AzureRmSqlServerFirewallRule + + + + The Set-AzureRmSqlServerFirewallRule cmdlet modifies a firewall rule in an Azure SQL Database server. + + + + Set-AzureRmSqlServerFirewallRule + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of the server. + + String + + + FirewallRuleName + + Specifies the name of the firewall rule that this cmdlet modifies. + + String + + + EndIpAddress + + Specifies the end value of the IP address range for this 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 + + String + + + none + + + FirewallRuleName + + Specifies the name of the firewall rule that this cmdlet modifies. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server. + + String + + String + + + none + + + StartIpAddress + + Specifies the start value of the IP address range for the firewall rule. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel + + + + + + + + + + + + + + + Example 1: Modify a firewall rule + + + + PS C:\> Set-AzureRmSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -FirewallRuleName "rule01" -StartIpAddress "192.168.0.197" -EndIpAddress "192.168.0.199" +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 +FirewallRuleName : rule01 + + This command modifies a firewall rule named rule01 on the server named server01. The command modifies the start and end IP addresses. + + + + + + + + + + + + + Get-AzureRmSqlServerFirewallRule + + + + New-AzureRmSqlServerFirewallRule + + + + Remove-AzureRmSqlServerFirewallRule + + + + Azure SQL Database Cmdlets + + + + + + + Set-AzureRmSqlServer + + Modifies properties of an Azure SQL Database server. + + + + + Set + AzureRmSqlServer + + - Starts the workflow that runs a recommended index operation. + The Set-AzureRmSqlServer cmdlet modifies properties of an Azure SQL Database server. - - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Set-AzureRmSqlServer + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of the server that this cmdlet modifies. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + + + ServerVersion + + Specifies the version to which this cmdlet changes the server. Valid values are: 2.0 and 12.0. + + String + + + SqlAdministratorPassword + + Specifies a new password (as a SecureString) for the database server administrator. To obtain a SecureString, 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. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + + + 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. + + + + + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that this cmdlet modifies. + + String + + String + + + none + + + ServerVersion + + Specifies the version to which this cmdlet changes the server. Valid values are: 2.0 and 12.0. + + String + + String + + + none + + + SqlAdministratorPassword + + Specifies a new password (as a SecureString) for the database server administrator. To obtain a SecureString, 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. + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] + + + none + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + 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 + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel + + + + + + + + + + + + + + + Example 1: Reset the admin password on Azure SQL Server + + + + PS C:\>$serverPassword = "newpassword" +PS C:\> $secureString = ConvertTo-SecureString $serverPassword -AsPlainText -Force +PS C:\> Set-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01" -SqlAdministratorPassword $secureString +ResourceGroupName : resourcegroup01 +ServerName : server01 +Location : Australia East +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : +ServerVersion : 12.0 +Tags : + + Resets the admin password to "newpassword" on Azure SQL Server "server01". + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + + + + Start-AzureRmSqlDatabaseExecuteIndexRecommendation + + Starts the workflow that runs a recommended index operation. + + + + + Start + AzureRmSqlDatabaseExecuteIndexRecommendation + + - Starts the upgrade of an Azure SQL Database server. + The Start-AzureRmSqlDatabaseExecuteIndexRecommendation cmdlet starts the workflow that runs a recommended index operation for an Azure SQL Database. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Start-AzureRmSqlDatabaseExecuteIndexRecommendation + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + 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 + + + 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 + + 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 the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the server that hosts the database for which this cmdlet starts a workflow. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Run an index recommendation + + + + PS C:\> Start-AzureRmSqlDatabaseExecuteIndexRecommendation -ResourceGroup "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -IndexRecommendationName "INDEX_NAME" + + This command runs an index recommendation. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseIndexRecommendations + + + + Stop-AzureRmSqlDatabaseExecuteIndexRecommendation + + + + Azure SQL Database Cmdlets + + + + + + + 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. You can monitor the progress of an upgrade by using the Get-AzureRmSqlServerUpgrade cmdlet. + + + + Start-AzureRmSqlServerUpgrade + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + DatabaseCollection + + Specifies an array of RecommendedDatabaseProperties objects that this cmdlet uses for the server upgrade. + + RecommendedDatabaseProperties[] + + + ElasticPoolCollection + + Specifies a collection of UpgradeRecommendedElasticPoolProperties objects to use for the server upgrade. See the examples for information on constructing a sample object. + + UpgradeRecommendedElasticPoolProperties[] + + + ScheduleUpgradeAfterUtcDateTime + + Specifies the earliest time, using 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. + + DateTime] + + + ServerName + + Specifies the name of the server that this cmdlet upgrades. + + String + + + ServerVersion + + Specifies the version to which this cmdlet upgrades the server. The only valid value is 12.0. + + String + + + + + + DatabaseCollection + + Specifies an array of RecommendedDatabaseProperties objects that this cmdlet uses for the server upgrade. + + RecommendedDatabaseProperties[] + + RecommendedDatabaseProperties[] + + + none + + + ElasticPoolCollection + + Specifies a collection of UpgradeRecommendedElasticPoolProperties objects to use for the server upgrade. See the examples for information on constructing a sample object. + + UpgradeRecommendedElasticPoolProperties[] + + UpgradeRecommendedElasticPoolProperties[] + + + none + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ScheduleUpgradeAfterUtcDateTime + + Specifies the earliest time, using 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. + + DateTime] + + DateTime] + + + none + + + ServerName + + Specifies the name of the server that this cmdlet upgrades. + + String + + String + + + none + + + ServerVersion + + Specifies the version to which this cmdlet upgrades the server. The only valid value is 12.0. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel + + + + + + + + + + + + + + + Example 1: Upgrade a server + + + + PS C:\> Start-AzureRmSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server01" -ServerVersion 12.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() +DatabaseCollection : + + This command upgrades the server named server01 assigned to resource group resourcegroup01. + + + + + + + + + + + Example 2: Upgrade a server by using schedule time and database recommendation + + + + 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 + + The first command creates a time five minutes in the future by using the Get-Date cmdlet. The command stores the date in the variable $ScheduleTime. For more information, type Get-Help Get-Date. + The second command creates a RecommendedDatabaseProperties object, and then stores that object in the variable $DatabaseMap. + The next three commands assign values to properties of the object stored in $DatabaseMap. + The final command upgrades the existing server named server01 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 will be running the Standard edition and have the Service Level Objective S0. + + + + + + + + + + + + + Get-AzureRmSqlServerUpgrade + + + + Stop-AzureRmSqlServerUpgrade + + + + Azure SQL Database Cmdlets + + + + + + + Stop-AzureRmSqlDatabaseExecuteIndexRecommendation + + Stops the workflow that runs a recommended index operation. + + + + + Stop + AzureRmSqlDatabaseExecuteIndexRecommendation + + - Stops the workflow that runs a recommended index operation. + The Stop-AzureRmSqlDatabaseExecuteIndexRecommendation cmdlet 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Stop-AzureRmSqlDatabaseExecuteIndexRecommendation + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + 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 + + + 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 + + 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 the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the server that hosts the database for which this cmdlet stops a workflow. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Stop running an index recommendation + + + + PS C:\> Stop-AzureRmSqlDatabaseExecuteIndexRecommendation -ResourceGroup "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -IndexRecommendationName "INDEX_NAME" + + This command stops running an index recommendation. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseIndexRecommendations + + + + Start-AzureRmSqlDatabaseExecuteIndexRecommendation + + + + Azure SQL Database Cmdlets + + + + + + + Stop-AzureRmSqlServerUpgrade + + Stops the upgrade of an Azure SQL Database server. + + + + + Stop + AzureRmSqlServerUpgrade + + - Stops the upgrade of an Azure SQL Database server. + The Stop-AzureRmSqlServerUpgrade cmdlet 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Stop-AzureRmSqlServerUpgrade + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + Force + + Forces the command to run without asking for user confirmation. + + + + ServerName + + Specifies the name of the server for which this cmdlet stops an upgrade. + + String + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + + + 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. + + + + + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + none + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server for which this cmdlet stops an upgrade. + + String + + String + + + none + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + false + + + 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 + + + + + + Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Example 1: Stop a server upgrade + + + + PS C:\> Stop-AzureRmSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server02" + + This command stops the request to upgrade the server named server02 assigned to the resource group named resourcegroup01. + + + + + + + + + + + + + Get-AzureRmSqlServerUpgrade + + + + Start-AzureRmSqlServerUpgrade + + + + Azure SQL Database Cmdlets + + + + + + + Suspend-AzureRmSqlDatabase + + Suspends an Azure SQL Data Warehouse database. + + + + + Suspend + AzureRmSqlDatabase + + - Suspends an Azure SQL Data Warehouse database. + The Suspend-AzureRmSqlDatabase cmdlet 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. - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 + + + Suspend-AzureRmSqlDatabase + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of the server which hosts the. + + String + + + DatabaseName + + Specifies the name of the database that this cmdlet suspends. + + String + + + + + + DatabaseName + + Specifies the name of the database that this cmdlet suspends. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server which hosts the. + + String + + String + + + none + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel + + + + + + + + + + + + + + + + The 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:\> Suspend-AzureRmSqlDatabase -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 + + + + Azure SQL Database Cmdlets + + + + + + + Use-AzureRmSqlServerAuditingPolicy + + Specifies that a database uses the auditing policy of its hosting server. + + + + + Use + AzureRmSqlServerAuditingPolicy + + - Specifies that a database uses the auditing policy of its hosting server. + 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. + If the host uses server level auditing, threat detection is removed. - - - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - + + + Use-AzureRmSqlServerAuditingPolicy + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the database that will use the auditing policy. + + String + + + DatabaseName + + Specifies the name of the database that will 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. + + + + + + + DatabaseName + + Specifies the name of the database that will use the auditing policy. + + String + + String + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server that hosts the database that will use the auditing policy. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel + + + + + + + + + + + + + + + Example 1: Configure a database to use the auditing policy of its server + + + + PS C:\> Use-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server02" -DatabaseName "database01" + + This command specifies that the database named database01 on server02 will use the auditing policy of the server. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseAuditingPolicy + + + + Get-AzureRmSqlServerAuditingPolicy + + + + Set-AzureRmSqlDatabaseAuditingPolicy + + + + Set-AzureRmSqlServerAuditingPolicy + + + + Azure SQL Database Cmdlets + + + + \ No newline at end of file From 85ff95d437a65275d499237c78a6d588d54905c2 Mon Sep 17 00:00:00 2001 From: yaakoviyun Date: Wed, 17 Feb 2016 09:20:10 +0200 Subject: [PATCH 2/5] Revert "updated Microsoft.Azure.Commands.Sql.dll-Help" This reverts commit a756cb6e910bf69d07e06c6feb96d8183c8a4443. --- .../Microsoft.Azure.Commands.Sql.dll-Help.xml | 26691 ++++++++-------- 1 file changed, 13665 insertions(+), 13026 deletions(-) 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 97c3ce8b717e..8dcd923a6f94 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,2563 +1,406 @@ - - - - - Get-AzureRmSqlCapability - - Gets SQL Database capabilities for the current subscription. - - - - - Get - AzureRmSqlCapability - - + + + + + + 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. + Gets SQL Database capabilities for the current subscription. - - - 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. - - - - - 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 - - - EditionName - - Specifies the name of the database edition for which this cmdlet gets capabilities. - - String - - - ServerVersionName - - Specifies the name of the server version for which this cmdlet gets capabilities. - - String - - - ServiceObjectiveName - - Specifies the name of the service objective for which this cmdlet gets capabilities. - - String - - - - - - Defaults - - Indicates that this cmdlet gets only defaults. - - SwitchParameter - - SwitchParameter - - - none - - - EditionName - - Specifies the name of the database edition for which this cmdlet gets capabilities. - - String - - String - - - none - - - 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 - - - ServiceObjectiveName - - Specifies the name of the service objective for which this cmdlet gets capabilities. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Location_Capabilities.Model.LocationCapabilityModel - - - - - - - - - - - - - - - Example 1: Get capabilities for the current subscription for a region - - - - PS C:\> Get-AzureRmSqlCapability -LocationName "Central US" -Location : Central US + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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} - - This command returns the capabilities for SQL Databases on the current subscription for the Central US region. - - - - - - - - - - - Example 2: Get default capabilities for the current subscription for a region - - - - PS C:\> Get-AzureRmSqlCapability -LocationName "Central US" -Defaults -Location : Central US +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) - - This command returns the default capabilities for SQL Databases on the current subscription in the Central US region. - - - - - - - - - - - Example 3: Get details for a service objective - - - - PS C:\> Get-AzureRmSqlCapability -LocationName "Central US" -ServiceObjectiveName "S1" -Location : Central US +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) - - This command gets default capabilities for SQL Databases for the specified service objective on the current subscription. - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlDatabaseActivity - - Gets the status of moving elastic databases. - - - - - Get - AzureRmSqlDatabaseActivity - - - - The Get-AzureRmSqlDatabaseActivity cmdlet gets the status of elastic databases moving into or out of an elastic database pool in Azure SQL Database. - - - - Get-AzureRmSqlDatabaseActivity - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of the SQL Server that hosts the elastic database pool. - - String - - - OperationId - - Specifies the ID of the operation that this cmdlet gets. - - Guid] - - - DatabaseName - - Specifies the name of the database for which this cmdlet gets status. - - 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 - - String - - - none - - - ElasticPoolName - - Specifies the name of the elastic database pool for which this cmdlet gets status. - - String - - String - - - none - - - OperationId - - Specifies the ID of the operation that this cmdlet gets. - - Guid] - - Guid] - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the SQL Server that hosts the elastic database pool. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseActivityModel - - - - - - - - - - - - - - - Example 1: Get status for all SQL Database instances - - - - 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. - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - - - - 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 - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of the server where the database is located. - - String - - - DatabaseName - - Specifies the name of the database. - - String - - - - - - DatabaseName - - Specifies the name of the database. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server where the database is located. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel - - - - - - - - - - - - - - - Example 1: Get the auditing policy of an Azure SQL database - - - - PS C:\> Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -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 - - This command gets the auditing policy of database database01 located in server01 in resource group resourcegroup01. - - - - - - - - - - - - - Remove-AzureRmSqlDatabaseAuditing - - - - Set-AzureRmSqlDatabaseAuditingPolicy - - - - Azure SQL Database Cmdlets - - - - - - - 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 - - ResourceGroupName - - Specifies the name of the resource group the database is assigned to. - - String - - - ServerName - - Specifies the name of the server where the database is located. - - String - - - DatabaseName - - Specifies the name of the database. - - String - - - - - - DatabaseName - - Specifies the name of the database. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server where the database is located. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingPolicyModel - - - - - - - - - - - - - - - Example 1: Get the data masking policy for an Azure SQL database - - - - PS C:\> Get-AzureRmSqlDatabaseDataMaskingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -DatabaseName : database01 -ResourceGroupName : resourcegroup01 -ServerName : server01 -DataMaskingState : Enabled -PrivilegedUsers : - - This command gets the data masking policy from database database01 in resource group resourcegroup01 on server server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseDataMaskingRule - - - - New-AzureRmSqlDatabaseDataMaskingRule - - - - Remove-AzureRmSqlDatabaseDataMaskingRule - - - - Set-AzureRmSqlDatabaseDataMaskingPolicy - - - - Set-AzureRmSqlDatabaseDataMaskingRule - - - - Azure SQL Database Cmdlets - - - - - - - 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 for 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 for that Azure SQL database are returned. - - - - Get-AzureRmSqlDatabaseDataMaskingRule - - ResourceGroupName - - Specifies the name of the resource group the database is assigned to. - - String - - - ServerName - - Specifies the name of the server. - - String - - - DatabaseName - - Specifies the name of the database. - - String - - - ColumnName - - Specifies the name of the column targeted by the masking rule. - - System.String - - - SchemaName - - Specifies the name of a schema. - - System.String - - - TableName - - Specifies the name of an Azure SQL Table. - - System.String - - - - - - ColumnName - - Specifies the name of the column targeted by the masking rule. - - System.String - - System.String - - - none - - - DatabaseName - - Specifies the name of the database. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group the database is assigned to. - - String - - String - - - none - - - SchemaName - - Specifies the name of a schema. - - System.String - - System.String - - - none - - - ServerName - - Specifies the name of the server. - - String - - String - - - none - - - TableName - - Specifies the name of an Azure SQL Table. - - System.String - - System.String - - - none - - - - - - - - - - - - - None. - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel - - - - - - - - - - - - - - - Example 1: Get all data masking rules from a database - - - - PS C:\> Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" - - This command gets all data masking rules from database01 in resource group resourcegroup01 found on server server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseDataMaskingPolicy - - - - New-AzureRmSqlDatabaseDataMaskingRule - - - - Remove-AzureRmSqlDatabaseDataMaskingRule - - - - Set-AzureRmSqlDatabaseDataMaskingPolicy - - - - Set-AzureRmSqlDatabaseDataMaskingRule - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlDatabaseExpanded - - Gets a database along with its expanded property values. - - - - - Get - AzureRmSqlDatabaseExpanded - - - - The Get-AzureRmSqlDatabaseExpanded cmdlet gets a database along with its expanded property values. - - - - Get-AzureRmSqlDatabaseExpanded - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the. - - String - - - DatabaseName - - Specifies the name of the database to retrieve. - - String - - - - - - DatabaseName - - Specifies the name of the database to retrieve. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Example 1: Get database object with service tier advisor information - - - - PS C:\> Get-AzureSqlDatabaseExpanded -ResourceGroupName "RG1" -ServerName "S1" -DatabaseName "DB1" - - This command returns the database with expanded properties containing the service tier advisor information. - - - - - - - - - - - - - - - Get-AzureRmSqlDatabaseIndexRecommendations - - Gets the recommended index operations for a server or database. - - - - - Get - AzureRmSqlDatabaseIndexRecommendations - - - - The Get-AzureRmSqlDatabaseIndexRecommendations cmdlet gets the recommended index operations for an Azure SQL Database server or database. - - - - Get-AzureRmSqlDatabaseIndexRecommendations - - ResourceGroupName - - Specifies the name of the resource group that the serve is assigned tor. This cmdlet gets index recommendations for a database hosted by this server. - - String - - - DatabaseName - - Specifies the name of the database for which this cmdlet gets index recommendations. - - String - - - IndexRecommendationName - - Specifies the name of the index recommendation that this cmdlet gets. - - String - - - TableName - - Specifies the name of an Azure SQL Table. - - String - - - 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 index recommendations. - - 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 the serve is assigned tor. This cmdlet gets index recommendations for a database hosted by this server. - - String - - String - - - none - - - ServerName - - Specifies the server that hosts the database for which this cmdlet gets index recommendations. - - String - - String - - - none - - - TableName - - Specifies the name of an Azure SQL Table. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Example 1: Get index recommendations for all databases on server - - - - PS C:\> Get-AzureRmSqlDatabaseIndexRecommendations -ResourceGroupName "resourcegroup01" -ServerName "server01" - - This command returns index recommendations for all databases on server server01. - - - - - - - - - - - Example 2: Get index recommendations for a specific database - - - - 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:\> Get-AzureRmSqlDatabaseIndexRecommendations -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -IndexRecommendationName "INDEX_NAME" - - This command returns single index recommendation by name. - - - - - - - - - - - - - Start-AzureRmSqlDatabaseExecuteIndexRecommendation - - - - Stop-AzureRmSqlDatabaseExecuteIndexRecommendation - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlDatabaseReplicationLink - - Gets the geo-replication links between an Azure SQL Database and the specified Azure resource group or Azure SQL Server. - - - - - Get - AzureRmSqlDatabaseReplicationLink - - - - The Get-AzureRMSqlDatabaseReplicationLink cmdlet replaces the Get-AzureSqlDatabaseCopy cmdlet. It gets all geo-replication links between the specified Azure SQL Database and a resource group or Azure SQL Server. - - - - Get-AzureRmSqlDatabaseReplicationLink - - ResourceGroupName - - Specifies the name of the Azure resource group for the database for which to retrieve links. - - String - - - ServerName - - Specifies the name of the Azure SQL Server for the database to retrieve links for. - - String - - - DatabaseName - - Specifies the name of the Azure SQL Database for which to retrieve links. - - String - - - PartnerResourceGroupName - - Specifies the name of the Azure resource group the partner is assigned to. - - String - - - - Get-AzureRmSqlDatabaseReplicationLink - - ResourceGroupName - - Specifies the name of the Azure resource group for the database for which to retrieve links. - - String - - - ServerName - - Specifies the name of the Azure SQL Server for the database to retrieve links for. - - String - - - DatabaseName - - Specifies the name of the Azure SQL Database for which to retrieve links. - - String - - - PartnerServerName - - Specifies the name of the Azure SQL Server for the partner. - - String - - - PartnerResourceGroupName - - Specifies the name of the Azure resource group the partner is assigned to. - - String - - - - - - DatabaseName - - Specifies the name of the Azure SQL Database for which to retrieve links. - - String - - String - - - none - - - PartnerResourceGroupName - - Specifies the name of the Azure resource group the partner is assigned to. - - String - - String - - - none - - - PartnerServerName - - Specifies the name of the Azure SQL Server for the partner. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the Azure resource group for the database for which to retrieve links. - - String - - String - - - none - - - ServerName - - Specifies the name of the Azure SQL Server for the database to retrieve links for. - - String - - String - - - none - - - - - - - - - - - - - This cmdlet accepts instances of the ReplicationLink or the Database object for the primary or secondary database. - - - - - - - - - - - - - - The output type is a ReplicationLink object. - - - - - - - - 1: - - - - - - - - - - - - - - - - - - - - Get-AzureRmSqlDatabaseRestorePoints - - This cmdlet retrieves the distinct restore points that an Azure SQL Data warehouse can be restored from. - - - - - Get - AzureRmSqlDatabaseRestorePoints - - - - The Get-AzureRmSqlDatabaseRestorePoints cmdlet retrieves the distinct restore points that an Azure SQL Data warehouse can be restored from. For an Azure SQL Database, the restore window is continuous, meaning that any point in time within the database's backup retention period can be used as a restore point. - - - - Get-AzureRmSqlDatabaseRestorePoints - - ResourceGroupName - - Specifies the name of the resource group the Azure SQL Database is assigned to. - - String - - - ServerName - - Specifies the name of the Azure SQL Server hosting the database. - - String - - - DatabaseName - - Specifies the name of the Azure SQL Database. - - String - - - - - - DatabaseName - - Specifies the name of the Azure SQL Database. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group the Azure SQL Database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the Azure SQL Server hosting the database. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Example 1: Get all restore points - - - - PS C:\> Get-AzureRmSqlDatabaseRestorePoints -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -Location : Central US -RestorePointType : CONTINUOUS -RestorePointCreationDate : -EarliestRestoreDate : 8/12/2015 12:00:00 AM - - This command returns all available restore points for the Azure SQL Database named database01. - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlDatabaseSecureConnectionPolicy - - Gets the secure connection policy for 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 - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of server that hosts the database. - - String - - - DatabaseName - - Specifies the name of the database. - - String - - - - - - DatabaseName - - Specifies the name of the database. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of server that hosts the database. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseSecureConnectionPolicyModel - - - - - - - - - - - - - - - Example 1: Get the secure connection policy of an Azure SQL database - - - - PS C:\> Get-AzureRmSqlDatabaseSecureConnectionPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -DatabaseName : database01 -ConnectionStrings : Microsoft.Azure.Commands.Sql.SecureConnection.Model.ConnectionStrings -ResourceGroupName : resourcegroup01 -ServerName : server01 -ProxyDnsName : server01.database.secure.windows.net -ProxyPort : 1433 -SecureConnectionState : Optional - - This command gets the secure connection policy of an Azure SQL database named database01 located on server server01. - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlDatabaseThreatDetectionPolicy - - Gets the threat detection policy for a database. - - - - - Get - AzureRmSqlDatabaseThreatDetectionPolicy - - - - The Get-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet gets the threat detection policy of an Azure SQL database. To use this cmdlet, specify the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database for which this cmdlet gets the policy. - - - - Get-AzureRmSqlDatabaseThreatDetectionPolicy - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of a server. - - String - - - DatabaseName - - Specifies the name of a database. - - String - - - - - - DatabaseName - - Specifies the name of a database. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of a server. - - String - - String - - - none - - - - - - - - - - - - - You cannot pipe input to this cmdlet. - - - - - - - Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel - - - - - - - This cmdlet returns a Model.DatabaseThreatDetectionPolicyModel object. - - - - - - - - Example 1: Get the threat detection policy for a database - - - - PS C:\> Get-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -DatabaseName : Database01 -ResourceGroupName : ResourceGroup11 -ServerName : Server01 -ThreatDetectionState : Disabled -NotificationRecipientsEmails : -EmailAdmins : False -ExcludedDetectionTypes : {} - - This command gets the threat detection policy for a database named Database01. The database is located on the server named Server01, which is assigned to the resource group ResourceGroup11. - - - - - - - - - - - - - Remove-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Set-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Azure SQL Database Cmdlets - - - - - - - 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 - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of the server. - - String - - - DatabaseName - - Specifies the name of 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 - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionActivityModel - - - - - - - - - - - - - - - Example 1: Get TDE activity for a database - - - - PS C:\> Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ResourceGroupName : resourcegroup01 -ServerName : server01 -DatabaseName : database01 -Status : Encrypting -PercentComplete : 3.662109 - - This command gets the TDE activity for the database named database01 on the server named server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseTransparentDataEncryption - - - - Set-AzureRmSqlDatabaseTransparentDataEncryption - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlDatabaseTransparentDataEncryption - - Gets the TDE state for an Azure SQL database. - - - - - Get - AzureRmSqlDatabaseTransparentDataEncryption - - - - - The Get-AzureRmSqlDatabaseTransparentDataEncryption cmdlet gets the state of Transparent Data Encryption (TDE) for 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 TDE, but both encryption and decryption can be long-running operations. To see the encryption scan progress, run the Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity cmdlet. - - - - - Get-AzureRmSqlDatabaseTransparentDataEncryption - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - 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 - - - - - - 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 the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the database for which this cmdlet gets TDE status. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel - - - - - - - - - - - - - - - Example 1: Get TDE status for a database - - - - PS C:\> Get-AzureRmSqlDatabaseTransparentDataEncryption -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ResourceGroupName ServerName DatabaseName State ------------------ ---------- ------------ ----- -resourcegroup01 server01 database01 Disabled - - This command gets the status of TDE for the database named Database01 on the server named server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity - - - - Set-AzureRmSqlDatabaseTransparentDataEncryption - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlDatabaseUpgradeHint - - Gets pricing tier hints for a SQL database. - - - - - Get - AzureRmSqlDatabaseUpgradeHint - - - - The Get-AzureRmSqlDatabaseUpgradeHint cmdlet gets pricing tier hints for upgrading an 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 - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - 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 databases in elastic database pools should be excluded from the returned recommendations. - - Boolean - - - - - - 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 databases in elastic database pools should be excluded from the returned recommendations. - - Boolean - - Boolean - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the database for which this cmdlet gets an upgrade hint. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Example 1: Get recommendations for all databases on a server - - - - PS C:\> Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" - - This command returns upgrade hints for all databases on the server named server01. - - - - - - - - - - - Example 2: Get recommendations for specific database - - - - PS C:\> Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" - - This command returns upgrade hints for a specific database. - - - - - - - - - - - Example 3: Get recommendation for all databases that are not in an elastic database pool - - - - PS C:\> Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" -ExcludeElasticPoolCandidates $True - - This command returns upgrade hints for all databases that are not in an elastic database pool. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseExpanded - - - - Get-AzureRmSqlElasticPoolRecommendation - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlDatabase - - Gets one or more Azure SQL databases. - - - - - Get - AzureRmSqlDatabase - - +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 - The Get-AzureRmSqlDatabase cmdlet gets one or more Azure SQL databases from an Azure SQL Database Server. + Gets one or more Azure SQL databases. - - - Get-AzureRmSqlDatabase - - ResourceGroupName - - Specifies the name of the resource group that the database server is assigned to. - - String - - - ServerName - - Specifies the name of the server the database is assigned to. - - String - - - DatabaseName - - Specifies the name of the database to retrieve. - - String - - - - - - DatabaseName - - Specifies the name of the database to retrieve. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server the database is assigned to. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - - - - - - - - - - - - - - - Example 1: Get all databases on a server - - - - PS C:\> Get-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -ResourceGroupName : resourcegroup01 + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 @@ -2593,25 +436,27 @@ RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : -Tags : - - This command gets all databases on the server named server01. - - - - - - - - - - - Example 2: Get a database by name on a server - - - - PS C:\> Get-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -ResourceGroupName : resourcegroup01 +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 @@ -2628,620 +473,2461 @@ RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : -Tags : - - This command gets a database named Database02 from a server named Server01. - - - - - - - - - - - - - New-AzureRmSqlDatabase - - - - Remove-AzureRmSqlDatabase - - - - Resume-AzureRmSqlDatabase - - - - Set-AzureRmSqlDatabase - - - - Suspend-AzureRmSqlDatabase - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlElasticPoolActivity - - Gets the status of operations on an elastic pool. - - - - - Get - AzureRmSqlElasticPoolActivity - - +Tags : + + + + + + + + + + + + + New-AzureRmSqlDatabase + + + + + Remove-AzureRmSqlDatabase + + + + + Resume-AzureRmSqlDatabase + + + + + Set-AzureRmSqlDatabase + + + + + Suspend-AzureRmSqlDatabase + + + + + Azure SQL Database + + + + + + + + + Get-AzureRmSqlDatabaseActivity - The Get-AzureRmSqlElasticPoolActivity cmdlet gets the status of operations on an elastic pool for an Azure SQL Database. You can see the status of both pool creation and configuration updates. + Gets the status of moving elastic databases. - - - Get-AzureRmSqlElasticPoolActivity - - ResourceGroupName - - Specifies the name of a resource group that the elastic pool is assigned to. - - String - - - ServerName - - Specifies the name of a server that contains an elastic pool. - - String - - - ElasticPoolName - - Specifies the name of an elastic pool. - - String - - - - - - ElasticPoolName - - Specifies the name of an elastic pool. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of a resource group that the elastic pool is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of a server that contains an elastic pool. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolActivityModel - - - - - - - - - - - - - - - Example 1: Get the status of operations for an elastic pool - - - - PS C:\> Get-AzureRmSqlElasticPoolActivity -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" - - This command gets the status of the operations for the elastic pool named elasticpool01. - - - - - - - - - - - - - Get-AzureRmSqlElasticPool - - - - Get-AzureRmSqlElasticPoolDatabase - - - - New-AzureRmSqlElasticPool - - - - Remove-AzureRmSqlElasticPool - - - - Set-AzureRmSqlElasticPool - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlElasticPoolDatabase - - Gets elastic databases in an elastic pool and their property values. - - - - - Get - AzureRmSqlElasticPoolDatabase - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Get-AzureRmSqlElasticPoolDatabase cmdlet gets elastic databases in an elastic pool and their property values. You can specify the name of an elastic database in Azure SQL Database to see the property values for only that database. + Gets the auditing policy of an Azure SQL database. - - - Get-AzureRmSqlElasticPoolDatabase - - ResourceGroupName - - Specifies the name of a resource group that the elastic pool is assigned to. - - String - - - ServerName - - Specifies the name of a server that contains an elastic pool. - - String - - - ElasticPoolName - - Specifies the name of an elastic pool. - - String - - - DatabaseName - - Specifies the name of the Azure SQL Database that this cmdlet gets. - - String - - - - - - DatabaseName - - Specifies the name of the Azure SQL Database that this cmdlet gets. - - String - - String - - - none - - - ElasticPoolName - - Specifies the name of an elastic pool. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of a resource group that the elastic pool is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of a server that contains an elastic pool. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - - - - - - - - - - - - - - - Example 1: Get all databases in an elastic pool - - - - PS C:\> Get-AzureRmSqlElasticPoolDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticPool01" - - This command gets all databases in an elastic pool named elasticPool01. - - - - - - - - - - - - - Get-AzureRmSqlElasticPool - - - - Get-AzureRmSqlElasticPoolActivity - - - - New-AzureRmSqlElasticPool - - - - Remove-AzureRmSqlElasticPool - - - - Set-AzureRmSqlElasticPool - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlElasticPoolRecommendation - - Gets elastic pool recommendations. - - - - - Get - AzureRmSqlElasticPoolRecommendation - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - 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 databases in the elastic pool. - -- DatabaseDtuMax. DTU cap for databases in the elastic pool. --- Dtu. DTU guarantee for the elastic pool. --- StorageMb. Storage in megabytes for the elastic pool. --- Edition. Edition for the elastic pool. Valid values are: Basic, Standard, and Premium. --- IncludeAllDatabases. Indicates whether to all databases in the elastic pool are returned. --- Name. Name of the elastic pool. + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 +PrivilegedUsers : + + + + + + + + + + + + + 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-AzureRmSqlElasticPoolRecommendation - - ResourceGroupName - - Specifies name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of the server for which this cmdlet gets recommendations. - - String - - - - - - ResourceGroupName - - Specifies name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server for which this cmdlet gets recommendations. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Example 1: Get recommendations for a server - - - - PS C:\> Get-AzureRmSqlElasticPoolRecommendation -ResourceGroupName "resourcegroup01" -ServerName "server01" - - This command gets the elastic pool recommendations for the server named server01. - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlElasticPool - - Gets elastic pools and their property values in 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + - - Get - AzureRmSqlElasticPool - - + + String + + + ResourceGroupName + + + + String + + + + + + ServerName + + + + String + + String + + + none + + + DatabaseName + + + + String + + String + + + none + + + ResourceGroupName + + + + String + + String + + + none + + + Profile + + + + azureprofile + + azureprofile + + + none + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + + + + + + + Get-AzureRmSqlDatabaseRestorePoints - The Get-AzureRmSqlElasticPool cmdlet gets elastic pools and their property values. Specify the name of an existing elastic pool to see the property values for only that pool. + - - - Get-AzureRmSqlElasticPool - - ResourceGroupName - - Specifies the name of the resource group that the elastic pool is assigned to. - - String - - - ServerName - - Specifies the name of the server that contains the elastic - - String - - - ElasticPoolName - - Specifies the name of the elastic pool. - - String - - - - - - ElasticPoolName - - Specifies the name of the elastic pool. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the elastic pool is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that contains the elastic - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel - - - - - - - - - - - - - - - Example 1: Get all elastic pools - - - - PS C:\> Get-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 @@ -3267,25 +2953,28 @@ Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 -Tags : - - This command gets all of the elastic pools on the server named server01. - - - - - - - - - - - Example 2: Get a specific elastic pool - - - - PS C:\>Get-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticPool27" -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 +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 @@ -3297,29 +2986,32 @@ Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 -Tags : - - This command gets the elastic pool named elasticPool0127 on the server named server01. - - - - - - - - - - - Example 3: Get metrics for a Azure SQL Elastic Database Pool - - - - PS C:\>Get-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" | Get-Metrics -TimeGrain 0:5:0 -DimensionName : +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...} +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 @@ -3330,7 +3022,7 @@ 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...} +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 @@ -3341,7 +3033,7 @@ 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...} +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 @@ -3352,7 +3044,7 @@ 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...} +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 @@ -3363,1150 +3055,717 @@ 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...} +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 - - This command returns metrics for an Azure SQL elastic database pool named "elasticpool01". - - - - - - - - - - - - - New-AzureRmSqlElasticPool - - - - Remove-AzureRmSqlElasticPool - - - - Set-AzureRmSqlElasticPool - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlServerActiveDirectoryAdministrator - - Gets information about an Azure AD administrator for SQL Server. - - - - - Get - AzureRmSqlServerActiveDirectoryAdministrator - - +Unit : Percent + + + + + + + + + + + + + Azure SQL Database + + + + + New-AzureRmSqlElasticPool + + + + + Remove-AzureRmSqlElasticPool + + + + + Set-AzureRmSqlElasticPool + + + + + + + + + Get-AzureRmSqlElasticPoolActivity - The Get-AzureRmSqlServerActiveDirectoryAdministrator cmdlet gets information about an Azure Active Directory (Azure AD) administrator for an Azure SQL Server in the current subscription. + Gets the status of operations on an elastic pool. - - - Get-AzureRmSqlServerActiveDirectoryAdministrator - - ResourceGroupName - - Specifies the name of the resource group that the SQL Server is assigned to. - - String - - - ServerName - - Specifies the name of the SQL Server for which this cmdlet gets information. - - String - - - - - - ResourceGroupName - - Specifies the name of the resource group that the SQL Server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the SQL Server for which this cmdlet gets information. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel - - - - - - - - - - - - - - - Example 1: Gets information about an administrator for a server - - - - PS C:\> Get-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -ResourceGroupName ServerName DisplayName ObjectId ------------------ ---------- ----------- -------- -resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b - - This command gets information about an Azure AD administrator for a server named Server01 that is associated with a resource group named resourcegroup01. - - - - - - - - - - - - - Remove-AzureRmSqlServerActiveDirectoryAdministrator - - - - Set-AzureRmSqlServerActiveDirectoryAdministrator - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlServerAuditingPolicy - - Gets the auditing policy of an Azure SQL server. - - - - - Get - AzureRmSqlServerAuditingPolicy - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - 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. + Gets elastic databases in an elastic pool and their property values. - - - Get-AzureRmSqlServerAuditingPolicy - - ResourceGroupName - - Specifies the name of the resource group that the Azure SQL server is assigned to. - - String - - - ServerName - - Specifies the name of the Azure SQL server for which this cmdlet gets the auditing policy. - - String - - - - - - ResourceGroupName - - Specifies the name of the resource group that the Azure SQL server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the Azure SQL server for which this cmdlet gets the auditing policy. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel - - - - - - - - - - - - - - - Example 1: Get the auditing policy of an Azure SQL server - - - - PS C:\> Get-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -ResourceGroupName : resourcegroup01 -ServerName : server01 -StorageAccountName : -StorageKeyType : Primary -EventType : {PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure...} -AuditState : New -RetentionInDays : 0 -TableIdentifier : Server01 - - This command gets the auditing policy of the server server01 in resource group resourcegroup01. - - - - - - - - - - - - - Set-AzureRmSqlServerAuditingPolicy - - - - Use-AzureRmSqlServerAuditingPolicy - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlServerCommunicationLink - - Gets a SQL Server communication link. - - - - - Get - AzureRmSqlServerCommunicationLink - - - - The Get-AzureRmSqlServerCommunicationLink cmdlet gets a SQL Server communication link. - - - - Get-AzureRmSqlServerCommunicationLink - - ResourceGroupName - - Specifies the name of the Azure resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of the SQL Server. - - String - - - LinkName - - Specifies the name of the communication link to get. - - String - - - - - - LinkName - - Specifies the name of the communication link to get. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the Azure resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the SQL Server. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1: - - - - - - - - - - - - - - - - - - New-AzureRmSqlServerCommunicationLink - - - - Remove-AzureRmSqlServerCommunicationLink - - - - Set-AzureRmSqlServerCommunicationLink - - - - - - - Get-AzureRmSqlServerFirewallRule - - Gets firewall rules for an Azure SQL Database server. - - - - - Get - AzureRmSqlServerFirewallRule - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - 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. + Gets elastic pool recommendations. - - - Get-AzureRmSqlServerFirewallRule - - ResourceGroupName - - Specifies the name of the resource group the SQL Server is assigned to. - - String - - - ServerName - - Specifies the name of the SQL Server. - - String - - - FirewallRuleName - - Specifies the name of the firewall rule. - - String - - - - - - FirewallRuleName - - Specifies the name of the firewall rule. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group the SQL Server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the SQL Server. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel - - - - - - - - - - - - - - - Example 1: Get all rules for a server - - - - PS C:\> Get-AzureRmSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "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 - - This command gets all the firewall rules for the server named server01. - - - - - - - - - - - - - New-AzureRmSqlServerFirewallRule - - - - Remove-AzureRmSqlServerFirewallRule - - - - Set-AzureRmSqlServerFirewallRule - - - - Azure SQL Database Cmdlets - - - - - - - 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 - - ResourceGroupName - - Specifies the name of a resource group. This cmdlet gets service objectives for an Azure SQL Database server assigned to this resource. - - String - - - ServerName - - Specifies the name of an Azure SQL Database server. - - 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 - - - DatabaseName - - Specifies the name of an Azure SQL Database. - - String - - - - - - 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 assigned to this resource. - - String - - String - - - none - - - ServerName - - Specifies the name of an Azure SQL Database server. - - String - - String - - - none - - - 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 - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ServiceObjective.Model.AzureSqlServerServiceObjectiveModel - - - - - - - - - - - - - - - Example 1: Get service objectives - - - - PS C:\> Get-AzureRmSqlServerServiceObjective -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "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 - - This command gets the service objectives for the server named server01 and the database named database01. - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - - - - 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 hosted on the specified server. - - - - Get-AzureRmSqlServerUpgradeHint - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of the server for which this cmdlet gets an upgrade hint. - - String - - - ExcludeElasticPools - - Indicates whether databases that are included in elastic database pools should be returned. - - Boolean - - - - - - ExcludeElasticPools - - Indicates whether databases that are included in elastic database pools should be returned. - - Boolean - - Boolean - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server for which this cmdlet gets an upgrade hint. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Example 1: Get combined recommendations - - - - PS C:\> Get-AzureRmSqlServerUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPools Databases ------------- --------- -{} {database01, database02} - - This command gets combined recommendations for all the databases on a server named server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseExpanded - - - - Get-AzureRmSqlElasticPoolRecommendation - - - - Azure SQL Database Cmdlets - - - - - - - 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 - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of the server for which this cmdlet gets upgrade status. - - String - - - - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server for which this cmdlet gets upgrade status. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel - - - - - - - - - - - - - - - Example 1: Get the status of an upgrade - - - - PS C:\> Get-AzureRmSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server01" | Format-List -ResourceGroupName : resourcegroup01 -ServerName : server01 -Status : Queued - - This command gets the status of an upgrade from the server named server01 in resource group named resourcegroup01. - - - - - - - - - - - - - Start-AzureRmSqlServerUpgrade - - - - Stop-AzureRmSqlServerUpgrade - - - - Azure SQL Database Cmdlets - - - - - - - Get-AzureRmSqlServer - - Returns information about Azure SQL Database servers. - - - - - Get - AzureRmSqlServer - - + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Get-AzureRmSqlServer cmdlet returns information about one or more Azure SQL Database servers. Specify the name of a server to see information for only that server. + Returns information about Azure SQL Database servers. - - - Get-AzureRmSqlServer - - ResourceGroupName - - Specifies the name of the resource group that servers are assigned to. - - String - - - ServerName - - Specifies the name of the server that this cmdlet gets. - - String - - - - - - ResourceGroupName - - Specifies the name of the resource group that servers are assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that this cmdlet gets. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel - - - - - - - - - - - - - - - Example 1: Get all Azure SQL Servers assigned to a resource group - - - - PS C:\> Get-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -ResourceGroupName : resourcegroup01 + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 : adminLoginSqlAdministratorPassword : +SqlAdministratorLogin : adminLogin +SqlAdministratorPassword : ServerVersion : 12.0 Tags : @@ -4516,49 +3775,54 @@ Location : West US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 -Tags : - - This command gets information about all the Azure SQL Database servers assigned to the resource group resourcegroup01. - - - - - - - - - - - Example 2: Get information about an Azure SQL Database server - - - - PS C:\> Get-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01" -ResourceGroupName : resourcegroup01 +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 : - - This command gets information about the Azure SQL Database server named server01. - - - - - - - - - - - Example 3: Get all Azure SQL Servers in the subscription - - - - PS C:\> Get-AzureRmResourceGroup | Get-AzureRmSqlServer -ResourceGroupName : resourcegroup01 +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 @@ -4580,1182 +3844,1499 @@ Location : East US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 -Tags : - - This command gets information about all the Azure SQL Database servers in the current subscription. - - - - - - - - - - - - - New-AzureRmSqlServer - - - - Remove-AzureRmSqlServer - - - - Set-AzureRmSqlServer - - - - Azure SQL Database Cmdlets - - - - - - - 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 - - +Tags : + + + + + + + + + + + + + Azure SQL Database + + + + + New-AzureRmSqlServer + + + + + Remove-AzureRmSqlServer + + + + + Set-AzureRmSqlServer + + + + + + + + + Get-AzureRmSqlServerActiveDirectoryAdministrator - The New-AzureRmSqlDatabaseCopy cmdlet replaces the Start-AzureSqlDatabaseCopy 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. + Gets information about an Azure AD administrator for SQL Server. - - - New-AzureRmSqlDatabaseCopy - - ResourceGroupName - - Specifies the name of the Azure Resource Group that the database being copied is assigned to. - - String - - - ServerName - - Specifies the name of the Azure SQL Server that contains the database to copy. - - String - - - DatabaseName - - Specifies the name of the Azure SQL Database to copy. - - String - - - CopyResourceGroupName - - Specifies the name of the Azure Resource Group in which to assign the copy. - - String - - - CopyServerName - - Specifies the name of the Azure SQL Server which will host the copy. - - String - - - ElasticPoolName - - Specifies the name of the Elastic Pool in which to assign the copy. - - String - - - ServiceObjectiveName - - Specifies the name of the service objective to assign to the copy. - - String - - - Tags - - Specifies the tags to associate with the Azure SQL Database copy. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - CopyDatabaseName - - Specifies the name of the Azure SQL Database copy. - - String - - - - - - CopyDatabaseName - - Specifies the name of the Azure SQL Database copy. - - String - - String - - - none - - - CopyResourceGroupName - - Specifies the name of the Azure Resource Group in which to assign the copy. - - String - - String - - - none - - - CopyServerName - - Specifies the name of the Azure SQL Server which will host the copy. - - String - - String - - - none - - - DatabaseName - - Specifies the name of the Azure SQL Database to copy. - - String - - String - - - none - - - ElasticPoolName - - Specifies the name of the Elastic Pool in which to assign the copy. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the Azure Resource Group that the database being copied is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the Azure SQL Server that contains the database to copy. - - String - - String - - - none - - - ServiceObjectiveName - - Specifies the name of the service objective to assign to the copy. - - String - - String - - - none - - - Tags - - Specifies the tags to associate with the Azure SQL Database copy. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - none - - - - - - - - - - - - - The New-AzureRmSqlDatabaseCopy cmdlet accepts pipelined instances of the Database object for the source database. - - - - - - - - - - - - - - The output is object of type Database. It represents the new database created as a copy. - - - - - - - - 1: - - - - - - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - - - - New-AzureRmSqlDatabaseDataMaskingRule - - Creates a data masking rule for an Azure SQL database. - - - - - New - AzureRmSqlDatabaseDataMaskingRule - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The New-AzureRmSqlDatabaseDataMaskingRule cmdlet creates a data masking rule for 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. + Gets the auditing policy of an Azure SQL server. - - - New-AzureRmSqlDatabaseDataMaskingRule - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the database. - - String - - - DatabaseName - - Specifies the name of the database. - - String - - - 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. - - 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. - - Double] - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - PrefixSize - - Specifies the number of characters in the beginning of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. - - UInt32] - - - ReplacementString - - Specifies the number of characters in the end of the text that are 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 at the end of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. - - UInt32] - - - ColumnName - - Specifies the name of the column targeted by the masking rule. - - 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. - - - NoMasking - Default - Text - Number - SocialSecurityNumber - CreditCardNumber - Email - - - - SchemaName - - Specifies the name of a schema. - - String - - - TableName - - Specifies the name of the database table containing the masked column. - - String - - - - - - ColumnName - - Specifies the name of the column targeted by the masking rule. - - String - - String - - - none - - - DatabaseName - - Specifies the name of the database. - - 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 - - - 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. - - Double] - - 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. - - Double] - - 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 - - - PrefixSize - - Specifies the number of characters in the beginning of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. - - UInt32] - - UInt32] - - - none - - - ReplacementString - - Specifies the number of characters in the end of the text that are 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 - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - SchemaName - - Specifies the name of a schema. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the database. - - String - - String - - - none - - - SuffixSize - - Specifies the number of characters at the end of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. - - UInt32] - - UInt32] - - - none - - - TableName - - Specifies the name of the database table containing the masked column. - - String - - String - - - none - - - - - - - - - - - - - None. - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel - - - - - - - - - - - - - - - Example 1: Create a data masking rule for a number column in a database - - - - 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; all of these items are contained in the database database01. The rule is a number masking rule that uses a random number between 5 and 14 as the mask value. The rule is named rule01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseDataMaskingRule - - - - Remove-AzureRmSqlDatabaseDataMaskingRule - - - - Set-AzureRmSqlDatabaseDataMaskingRule - - - - Azure SQL Database Cmdlets - - - - - - - New-AzureRmSqlDatabaseSecondary - - Creates a new secondary database for an existing Azure SQL Database and starts data replication. - - - - - New - AzureRmSqlDatabaseSecondary - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The New-AzureRMSqlDatabaseSecondary 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. + Gets firewall rules for an Azure SQL Database server. - - - New-AzureRmSqlDatabaseSecondary - - ResourceGroupName - - Specifies the name of the Azure Resource Group the primary Azure SQL Database is assigned to. - - String - - - ServerName - - Specifies the name of the Azure SQL Server of the primary Azure SQL Database. - - String - - - DatabaseName - - Specifies the name of the Azure SQL Database to act as primary. - - String - - - AllowConnections - - Specifies the read intent of the secondary Azure SQL Database. - - - No - All - - - - SecondaryElasticPoolName - - Specifies the name of the Elastic Pool in which to put the secondary. - - String - - - SecondaryServiceObjectiveName - - Specifies the name of the service objective to assign to the secondary. - - String - - - Tags - - Specifies the tags to associate with the Azure SQL Database replication link. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - PartnerResourceGroupName - - Specifies the name of the Azure Resource Group the secondary database will be assigned to. - - String - - - PartnerServerName - - Specifies the name of the Azure SQL Server on which to create secondary. - - String - - - - - - AllowConnections - - Specifies the read intent of the secondary Azure SQL Database. - - AllowConnections - - AllowConnections - - - none - - - DatabaseName - - Specifies the name of the Azure SQL Database to act as primary. - - String - - String - - - none - - - PartnerResourceGroupName - - Specifies the name of the Azure Resource Group the secondary database will be assigned to. - - String - - String - - - none - - - PartnerServerName - - Specifies the name of the Azure SQL Server on which to create secondary. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the Azure Resource Group the primary Azure SQL Database is assigned to. - - String - - String - - - none - - - SecondaryElasticPoolName - - Specifies the name of the Elastic Pool in which to put the secondary. - - String - - String - - - none - - - SecondaryServiceObjectiveName - - Specifies the name of the service objective to assign to the secondary. - - String - - String - - - none - - - ServerName - - Specifies the name of the Azure SQL Server of the primary Azure SQL Database. - - String - - String - - - none - - - Tags - - Specifies the tags to associate with the Azure SQL Database replication link. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - none - - - - - - - - - - - - - The New-AzureRmSqlDatabaseSecondary cmdlet accepts pipelined instances of the Database object for the primary database. - - - - - - - - - - - - - - The output type is a ReplicationLink object. - - - - - - - - 1: - - - - - - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - Remove-AzureRmSqlDatabaseSecondary - - - - Set-AzureRmSqlDatabaseSecondary - - - - - - - New-AzureRmSqlDatabase - - Creates an Azure SQL database or an elastic database. - - - - - New - AzureRmSqlDatabase - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - 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. + Gets service objectives for an Azure SQL Database server. - - - New-AzureRmSqlDatabase - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of the server that will host the database. - - String - - - CatalogCollation - - Specifies the name of the Azure SQL database catalog collation. - - String - - - CollationName - - Specifies the name of the Azure SQL database collation. - - String - - - Edition - - Specifies the edition to assign to the database. Valid values are: - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + Get-AzureRmSqlServerCommunicationLink + + Gets server communication links and their property values in an Azure SQL Server. + + + + + Get + AzureRmSqlServerCommunicationLink + + + + The Get-AzureRmSqlServerCommunicationLink cmdlet gets server-to-server partnerships for Elastic transactions and their property values. Specify the name of an existing server communication link to see the property values for only that one. + + + + Get-AzureRmSqlServerCommunicationLink + + LinkName + + Specifies the name of the server communication link that this cmdlet gets. + + String + + + ServerName + + Specifies the name of the one of the servers that contain the server communication link that this cmdlet gets. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the server communication link that this cmdlet gets. + + String + + + + + + LinkName + + Specifies the name of the server communication link that this cmdlet gets. + + String + + String + + + + + + ServerName + + Specifies the name of the one of the servers that contain the server communication link that this cmdlet gets. + + String + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group that contains the server communication link that this cmdlet gets. + + String + + String + + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerCommunicationLinkModel + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- Example 1: Get all communication links for a server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" + + Gets all server-to-server partnership for Elastic transactions that the specified server is involved in. + + + + + + + + + + + + + + -------------------------- Example 2: Get a named communication link for a server -------------------------- + + PS C:\> + + PS C:\> Get-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" -LinkName "link01" + + Gets the specified server-to-server partnership for Elastic transactions. + + + + + + + + + + + + + + + + + + + + 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 - - - None - Premium - Basic - Standard - DataWarehouse - Free - - - - ElasticPoolName - - Specifies the name of the elastic pool in which to put the database. - - String - - - MaxSizeBytes - - Specifies the maximum size of the database in bytes. - - Int64 - - - RequestedServiceObjectiveName - - Specifies the name of the service objective to assign to the database. - - String - - - Tags - - Specifies a dictionary of tags that this cmdlet associates with the new database. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - DatabaseName - - Specifies the name of the database. - - String - - - - - - CatalogCollation - - Specifies the name of the Azure SQL database catalog collation. - - String - - String - - - none - - - CollationName - - Specifies the name of the Azure SQL database collation. - - String - - String - - - none - - - DatabaseName - - Specifies the name of the database. - - String - - String - - - none - - - Edition - - Specifies the edition to assign to the database. Valid values are: - + + 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 - - - ElasticPoolName - - Specifies the name of the elastic pool in which to put the database. - - String - - String - - - none - - - MaxSizeBytes - - Specifies the maximum size of the database in bytes. - - Int64 - - Int64 - - - none - - - RequestedServiceObjectiveName - - Specifies the name of the service objective to assign to the database. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that will host the database. - - String - - String - - - none - - - Tags - - Specifies a dictionary of tags that this cmdlet associates with the new database. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - - - - - - - - - - - - - - - Example 1: Create a database on a specified server - - - - PS C:\> New-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -ResourceGroupName : resourcegroup01 + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 @@ -5772,25 +5353,27 @@ RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : -Tags : - - This command creates a database named database01 on server server01. - - - - - - - - - - - Example 2: Create an elastic database on a specified server - - - - PS C:\> New-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -ElasticPoolName "elasticpool01" -ResourceGroupName : resourcegroup01 +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 @@ -5807,331 +5390,1246 @@ RequestedServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 RequestedServiceObjectiveName : ElasticPoolName : elasticpool01 EarliestRestoreDate : -Tags : - - This command creates a database named database01 in the elastic pool named elasticpool01 on server server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabase - - - - Remove-AzureRmSqlDatabase - - - - Resume-AzureRmSqlDatabase - - - - Set-AzureRmSqlDatabase - - - - Suspend-AzureRmSqlDatabase - - - - New-AzureRmSqlServer - - - - New-AzureRmSqlElasticPool - - - - Azure SQL Database Cmdlets - - - - - - - New-AzureRmSqlElasticPool - - Creates an elastic database pool for an Azure SQL Database. - - +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + + + + + + + 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 + - - New - AzureRmSqlElasticPool - - + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + + + + + + + New-AzureRmSqlElasticPool - The New-AzureRmSqlElasticPool cmdlet creates an elastic database pool for an Azure SQL Database. + Creates an elastic database pool in Azure SQL Database. - - - New-AzureRmSqlElasticPool - - ResourceGroupName - - Specifies the name of the resource group that the elastic pool will be assigned to. - - String - - - ServerName - - Specifies the name of the server that will host the elastic pool. - - String - - - DatabaseDtuMax - - Specifies the maximum number of Database Throughput Units (DTUs) that any single database in the pool can consume. The default values for the different editions are as follows: - -- Basic. 5 DTUs + + + + 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 - - - 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 - - - Dtu - - Specifies the total number of shared DTUs for the elastic pool. The default values for the different editions are as follows: - -- Basic. 100 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 - - - Edition - - Specifies the edition of the Azure SQL Database used for the elastic pool. Valid values are: - -- Premium + + 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. - - - None - Premium - Basic - Standard - DataWarehouse - Free - - - - 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 - - https://azure.microsoft.com/en-us/documentation/articles/sql-database-elastic-pool-reference/ - - - . - - - Int32 - - - Tags - - Specifies a dictionary of tags that this cmdlet associates with the elastic pool. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - ElasticPoolName - - Specifies the name of the elastic pool that this cmdlet creates. - - String - - - - - - DatabaseDtuMax - - Specifies the maximum number of Database Throughput Units (DTUs) that any single database in the pool can consume. The default values for the different editions are as follows: - -- Basic. 5 DTUs + 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 - - - 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 - - - Dtu - - Specifies the total number of shared DTUs for the elastic pool. The default values for the different editions are as follows: - -- Basic. 100 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 - - - Edition - - Specifies the edition of the Azure SQL Database used for the elastic pool. Valid values are: - -- Premium --- Basic --- Standard - For the current preview, the edition must be Standard. - - DatabaseEdition - - DatabaseEdition - - - none - - - ElasticPoolName - - Specifies the name of the elastic pool that this cmdlet creates. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the elastic pool will be assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that will host the elastic pool. - - String - - String - - - 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 - - https://azure.microsoft.com/en-us/documentation/articles/sql-database-elastic-pool-reference/ - - - . - - - Int32 - - Int32 - - - none - - - Tags - - Specifies a dictionary of tags that this cmdlet associates with the elastic pool. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel - - - - - - - - - - - - - - - Example 1: Create an elastic pool - - - - PS C:\> New-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" -Edition "Standard" -Dtu 400 -DatabaseDtuMin 10 -DatabaseDtuMax 100 -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 @@ -6143,5064 +6641,5132 @@ Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 -Tags : - - This command creates an elastic pool in the Standard service tier named elasticpool01. The server named server01, assigned to an Azure resource group named resourcegroup01, hosts the elastic pool in. The command specifies DTU property values for the pool and the databases in the pool. - - - - - - - - - - - - - Get-AzureRmSqlElasticPool - - - - Get-AzureRmSqlElasticPoolActivity - - - - Get-AzureRmSqlElasticPoolDatabase - - - - Remove-AzureRmSqlElasticPool - - - - Set-AzureRmSqlElasticPool - - - - Azure SQL Database Cmdlets - - - - - - - New-AzureRmSqlServerCommunicationLink - - Creates a SQL Server communication link. - - - - - New - AzureRmSqlServerCommunicationLink - - +Tags : + + + + + + + + + + + + + + Azure SQL Database + + + + + Get-AzureRmSqlElasticPool + + + + + Get-AzureRmSqlElasticPoolActivity + + + + + Get-AzureRmSqlElasticPoolDatabase + + + + + Remove-AzureRmSqlElasticPool + + + + + Set-AzureRmSqlElasticPool + + + + + + + + + New-AzureRmSqlServer - The New-AzureRmSqlServerCommunicationLink cmdlet creates a SQL Server communication link. + Creates an Azure SQL Database server. - - - New-AzureRmSqlServerCommunicationLink - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of a SQL Server. - - String - - - LinkName - - Specifies a name for the new communication link. - - String - - - PartnerServer - - Specifies the partner server for the new link. - - String - - - - - - LinkName - - Specifies a name for the new communication link. - - String - - String - - - none - - - PartnerServer - - Specifies the partner server for the new link. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of a SQL Server. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1: - - - - - - - - - - - - - - - - - - Get-AzureRmSqlServerCommunicationLink - - - - Remove-AzureRmSqlServerCommunicationLink - - - - Set-AzureRmSqlServerCommunicationLink - - - - - - - New-AzureRmSqlServerFirewallRule - - Creates a firewall rule for an Azure SQL Database server. - - - - - New - AzureRmSqlServerFirewallRule - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The New-AzureRmSqlServerFirewallRule cmdlet creates a firewall rule for the specified Azure SQL Database server. + Creates a firewall rule for an Azure SQL Database server. - - - New-AzureRmSqlServerFirewallRule - - ResourceGroupName - - Specifies the name of a resource group that server is assigned to. - - String - - - ServerName - - Specifies the name of a server. Specify the server name, not the fully qualified DNS name. - - String - - - AllowAllAzureIPs - - Indicates that this firewall rule allows all Azure IP addresses to access the server. - - - - - New-AzureRmSqlServerFirewallRule - - ResourceGroupName - - Specifies the name of a resource group that server is assigned to. - - String - - - ServerName - - Specifies the name of a server. Specify the server name, not the fully qualified DNS name. - - String - - - EndIpAddress - - Specifies the end value of the IP address range for this rule. - - String - - - 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 - - - - - - AllowAllAzureIPs - - Indicates that this firewall rule allows all Azure IP addresses to access the server. - - SwitchParameter - - SwitchParameter - - - none - - - EndIpAddress - - Specifies the end value of the IP address range for this rule. - - String - - String - - - none - - - FirewallRuleName - - Specifies the name of the new firewall rule. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of a resource group that server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of a server. Specify the server name, not the fully qualified DNS name. - - String - - String - - - none - - - StartIpAddress - - Specifies the start value of the IP address range for the firewall rule. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel - - - - - - - - - - - - - - - Example 1: Create a firewall rule - - - - PS C:\> New-AzureRmSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -FirewallRuleName "rule01" -StartIpAddress "192.168.0.198" -EndIpAddress "192.168.0.199" -ResourceGroupName : resourcegroup01 + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - - This command creates a firewall rule named rule01 on the server named server01. The rule includes the specified start and end IP addresses. - - - - - - - - - - - - - Get-AzureRmSqlServerFirewallRule - - - - Remove-AzureRmSqlServerFirewallRule - - - - Set-AzureRmSqlServerFirewallRule - - - - Azure SQL Database Cmdlets - - - - - - - New-AzureRmSqlServer - - Creates an Azure SQL Database server. - - - - - New - AzureRmSqlServer - - +FirewallRuleName : rule01 + + + + + + + + + + + + + Azure SQL Database + + + + + Get-AzureRmSqlServerFirewallRule + + + + + Remove-AzureRmSqlServerFirewallRule + + + + + Set-AzureRmSqlServerFirewallRule + + + + + + + + + New-AzureRmSqlServerCommunicationLink - The New-AzureRmSqlServer cmdlet creates an Azure SQL Database server. + Creates an Azure SQL Server partnership for Elastic transactions. Once established, Elastic transactions will be able to span databases in either of the servers paired. - - - New-AzureRmSqlServer - - ResourceGroupName - - Specifies the name of the resource group which the server will be assigned to. - - 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 - - - Tags - - Specifies a dictionary of tags that this cmdlet associates with the new server. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - Location - - Specifies the location of the data center where this cmdlet creates the server. - - String - - - ServerName - - Specifies the name of the new server. - - String - - - SqlAdministratorCredentials - - Specifies the SQL Database server administrator credentials 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 - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group which the server will be assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the new server. - - String - - 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 - - - SqlAdministratorCredentials - - Specifies the SQL Database server administrator credentials 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 - - - Tags - - Specifies a dictionary of tags that this cmdlet associates with the new server. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel - - - - - - - - - - - - - - - Example 1: Create a new Azure SQL Database server - - - - PS C:\> New-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -Location "Central US" -ServerName "server01" -ServerVersion "12.0" -ResourceGroupName : resourcegroup01 -ServerName : server01 -Location : Australia East -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : -ServerVersion : 12.0 -Tags : - - This command creates a version 12 Azure SQL Database server. - - - - - - - - - - - - - Get-AzureRmSqlServer - - - - Remove-AzureRmSqlServer - - - - Set-AzureRmSqlServer - - - - New-AzureRmSqlServerFirewallRule - - - - Azure SQL Database Cmdlets - - - - - - - Remove-AzureRmSqlDatabaseAuditing - - Removes the auditing of an Azure SQL database. - - - - - Remove - AzureRmSqlDatabaseAuditing - - + + + + New + AzureRmSqlServerCommunicationLink + + + + The New-AzureRmSqlServerCommunicationLink cmdlet creates an Azure SQL Server partnership for Elastic transactions. The partnership can be set up for two servers at a time and once established, Elastic transactions will be able to span databases in either of the servers paired. Users can create many server partnerships as necessary and involve a server in multiple partnerships to span Elastic transactions over a larger number of servers. + + + + New-AzureRmSqlServerCommunicationLink + + LinkName + + Specifies the name of the server communication link that this cmdlet creates. + + String + + + PartnerServer + + Specifies the name of the other server taking part in this partnership. + + String + + + ServerName + + Specifies the name of the server to set up the partnership on. + + String + + + ResourceGroupName + + Specifies the name of the resource group the server named in the 'ServerName' parameter. + + String + + + + + + LinkName + + Specifies the name of the server communication link that this cmdlet creates. + + String + + String + + + + + + PartnerServer + + Specifies the name of the other server taking part in this partnership. + + String + + String + + + + + + ServerName + + Specifies the name of the server to set up the partnership on. + + String + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group the server named in the 'ServerName' parameter. + + String + + String + + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerCommunicationLinkModel + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- Example 1: Create a new Azure SQL Server communication link -------------------------- + + PS C:\> + + PS C:\> New-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" -LinkName "link01" -PartnerServer "server02" + + + + + + + + + + + + + + + + + + + + + + Remove-AzureRmSqlDatabase - 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. - If you remove auditing of an Azure SQL database, threat detection is also removed. + Removes an Azure SQL database. - - - Remove-AzureRmSqlDatabaseAuditing - - - - - - - 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:\> Remove-AzureRmSqlDatabaseAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" - - This command removes the auditing of database named database01. That database is located on server01, which is assigned to the resource group named resourcegroup01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseAuditingPolicy - - - - Set-AzureRmSqlDatabaseAuditingPolicy - - - - Azure SQL Database Cmdlets - - - - - - - Remove-AzureRmSqlDatabaseDataMaskingRule - - Removes a data masking rule from an Azure SQL database. - - - - - Remove - AzureRmSqlDatabaseDataMaskingRule - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - 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. + Removes auditing of an Azure SQL database. - - - Remove-AzureRmSqlDatabaseDataMaskingRule - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the database. - - String - - - DatabaseName - - Specifies the name of the database. - - String - - - Force - - Forces the command to run without asking for user confirmation. - - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - ColumnName - - Specifies the name of the column targeted by the masking rule. - - System.String - - - SchemaName - - Specifies the name of a schema. - - System.String - - - TableName - - Specifies the name of an Azure SQL Table. - - System.String - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - - - 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. - - - - - - - ColumnName - - Specifies the name of the column targeted by the masking rule. - - System.String - - System.String - - - none - - - DatabaseName - - Specifies the name of the database. - - String - - String - - - none - - - Force - - Forces the command to run without asking for user confirmation. - - SwitchParameter - - SwitchParameter - - - 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 - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - SchemaName - - Specifies the name of a schema. - - System.String - - System.String - - - none - - - ServerName - - Specifies the name of the server that hosts the database. - - String - - String - - - none - - - TableName - - Specifies the name of an Azure SQL Table. - - System.String - - System.String - - - none - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - false - - - 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 - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel - - - - - - - - - - - - - - - Example 1: Remove a database data masking rule - - - - PS C:\> Remove-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -RuleId "rule01" - - This command removes rule rule01 defined for the database database01 The database is located on server01 and assigned to resource group resourcegroup01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseDataMaskingRule - - - - New-AzureRmSqlDatabaseDataMaskingRule - - - - Set-AzureRmSqlDatabaseDataMaskingRule - - - - Azure SQL Database Cmdlets - - - - - - - Remove-AzureRmSqlDatabaseSecondary - - Terminates data replication between an Azure SQL Database and the specified secondary database. - - - - - Remove - AzureRmSqlDatabaseSecondary - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Remove-AzureRmSqlDatabaseSecondary cmdlet replaces the Stop-AzureSqlDatabaseCopy cmdlet. It forces termination of a geo-replication link. There is no replication synchronization prior to termination. + Removes a data masking rule from an Azure SQL database. - - - Remove-AzureRmSqlDatabaseSecondary - - ResourceGroupName - - Specifies the name of the Azure Resource Group associated with the replication link to remove. - - String - - - ServerName - - Specifies the name of the Azure SQL Server with the replication link to remove. - - String - - - DatabaseName - - Specifies the name of the primary Azure SQL Database with the replication link to remove. - - String - - - PartnerResourceGroupName - - Specifies the name of the partner Azure Resource Group. - - String - - - PartnerServerName - - Specifies the name of the partner Azure SQL Server. - - String - - - - - - DatabaseName - - Specifies the name of the primary Azure SQL Database with the replication link to remove. - - String - - String - - - none - - - PartnerResourceGroupName - - Specifies the name of the partner Azure Resource Group. - - String - - String - - - none - - - PartnerServerName - - Specifies the name of the partner Azure SQL Server. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the Azure Resource Group associated with the replication link to remove. - - String - - String - - - none - - - ServerName - - Specifies the name of the Azure SQL Server with the replication link to remove. - - String - - String - - - none - - - - - - - - - - - - - The Remove-AzureRmSqlDatabaseSecondary cmdlet accepts pipelined instances of the Database object for the primary or secondary database. - - - - - - - - - - - - - - There is no output type for this operation. - - - - - - - - 1: - - - - - - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - New-AzureRmSqlDatabaseSecondary - - - - Set-AzureRmSqlDatabaseSecondary - - - - - - - Remove-AzureRmSqlDatabaseThreatDetectionPolicy - - Removes the threat detection policy from a database. - - - - - Remove - AzureRmSqlDatabaseThreatDetectionPolicy - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Remove-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet removes the threat detection policy from an Azure SQL database. - To use this cmdlet, specify the ResourceGroupName, ServerName and DatabaseName parameters to identify the database from which this cmdlet removes the policy. + Terminates data replication between an Azure SQL Database and the specified secondary database. - - - Remove-AzureRmSqlDatabaseThreatDetectionPolicy - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of a server. - - String - - - DatabaseName - - Specifies the name of a database where the threat detection policy should be removed. - - String - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - - - - DatabaseName - - Specifies the name of a database where the threat detection policy should be removed. - - String - - String - - - 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 - - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of a server. - - String - - String - - - none - - - - - - - - - - - - - You cannot pipe input to this cmdlet. - - - - - - - Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel - - - - - - - This cmdlet returns a DatabaseThreatDetectionPolicyModel object. - - - - - - - - Example 1: Remove a threat detection policy for a database - - - - PS C:\> Remove-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" - - This command removes the threat detection policy from a database named Database01 on the server named Server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Set-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Azure SQL Database Cmdlets - - - - - - - Remove-AzureRmSqlDatabase - - Removes an Azure SQL database. - - - - - Remove - AzureRmSqlDatabase - - + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + + + + + + + Remove-AzureRmSqlElasticPool - The Remove-AzureRmSqlDatabase cmdlet removes an Azure SQL database. + Deletes an elastic database pool. - - - Remove-AzureRmSqlDatabase - - ResourceGroupName - - Specifies the name of the resource group the database is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the. - - String - - - DatabaseName - - Specifies the name of the database that this cmdlet removes. - - String - - - Force - - Forces the command to run without asking for user confirmation. - - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - - - 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. - - - - - - - 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 - - - ResourceGroupName - - Specifies the name of the resource group the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the. - - String - - String - - - none - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - false - - - 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 - - - - - - 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:\> 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 Cmdlets - - - - - - - Remove-AzureRmSqlElasticPool - - Deletes an elastic database pool. - - - - - Remove - AzureRmSqlElasticPool - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Remove-AzureRmSqlElasticPool cmdlet deletes an Azure SQL Database elastic pool. + Removes an Azure SQL Database server. - - - Remove-AzureRmSqlElasticPool - - ResourceGroupName - - Specifies the name of the resource group that the elastic pool is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the elastic. - - String - - - ElasticPoolName - - Specifies the name of the elastic pool that this cmdlet deletes. - - String - - - Force - - Forces the command to run without asking for user confirmation. - - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - - - 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. - - - - - - - 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 - - - ResourceGroupName - - Specifies the name of the resource group that the elastic pool is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the elastic. - - String - - String - - - none - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - false - - - 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 - - - - - - Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel - - - - - - - - - - - - - - - Example 1: Delete an elastic pool - - - - PS C:\> Remove-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" - - This command deletes an elastic pool named elasticpool01. - - - - - - - - - - - - - Get-AzureRmSqlElasticPool - - - - Get-AzureRmSqlElasticPoolActivity - - - - Get-AzureRmSqlElasticPoolDatabase - - - - New-AzureRmSqlElasticPool - - - - Set-AzureRmSqlElasticPool - - - - Azure SQL Database Cmdlets - - - - - - - Remove-AzureRmSqlServerActiveDirectoryAdministrator - - Removes an Azure AD administrator for SQL Server. - - - - - Remove - AzureRmSqlServerActiveDirectoryAdministrator - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Remove-AzureRmSqlServerActiveDirectoryAdministrator cmdlet removes an Azure Active Directory (Azure AD) administrator for Azure SQL Server in the current subscription. + Removes an Azure AD administrator for SQL Server. - - - Remove-AzureRmSqlServerActiveDirectoryAdministrator - - ResourceGroupName - - Specifies the name of the resource group that the SQL Server is assigned to. - - String - - - ServerName - - Specifies the name of the SQL Server for which this cmdlet removes an administrator. - - String - - - Force - - Forces the command to run without asking for user confirmation. - - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - - - 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. - - - - - - - Force - - Forces the command to run without asking for user confirmation. - - SwitchParameter - - SwitchParameter - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the SQL Server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the SQL Server for which this cmdlet removes an administrator. - - String - - String - - - none - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - false - - - 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 - - - - - - Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel - - - - - - - - - - - - - - - Example 1: Remove an administrator - - - - PS C:\> Remove-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -Confirm + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - - Removes the Azure AD administrator for the server named server01 associated with the resource group resourcegroup01. - - - - - - - - - - - - - Get-AzureRmSqlServerActiveDirectoryAdministrator - - - - Set-AzureRmSqlServerActiveDirectoryAdministrator - - - - Azure SQL Database Cmdlets - - - - - - - Remove-AzureRmSqlServerAuditing - - Removes the auditing of an Azure SQL server. - - - - - Remove - AzureRmSqlServerAuditing - - +resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b + + + + + + + + + + + + + Get-AzureRmSqlServerActiveDirectoryAdministrator + + + + + Set-AzureRmSqlServerActiveDirectoryAdministrator + + + + + + + + + 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 on the 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. + Removes auditing of an Azure SQL server. - - - Remove-AzureRmSqlServerAuditing - - ResourceGroupName - - Specifies the name of the resource group the Azure SQL server is assigned to. - - String - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - ServerName - - Specifies the name 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 - - - ResourceGroupName - - Specifies the name of the resource group the Azure SQL server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the Azure SQL server. - - String - - String - - - 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:\> Remove-AzureRmSqlDatabaseAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01" - - This command removes the auditing of all the databases located on server01 in resource group. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseAuditingPolicy - - - - Set-AzureRmSqlDatabaseAuditingPolicy - - - - Azure SQL Database Cmdlets - - - - - - - Remove-AzureRmSqlServerCommunicationLink - - Removes a SQL Server communication link. - - - - - Remove - AzureRmSqlServerCommunicationLink - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Remove-AzureRmSqlServerCommunicationLink removes a SQL Server communication link. + Deletes a firewall rule from an Azure SQL Database server. - - - Remove-AzureRmSqlServerCommunicationLink - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of a SQL Server. - - String - - - LinkName - - Specifies the name of the link to remove. - - String - - - Force - - Forces the command to run without asking for user confirmation. - - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - - - 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. - - - - - - - Force - - Forces the command to run without asking for user confirmation. - - SwitchParameter - - SwitchParameter - - - none - - - LinkName - - Specifies the name of the link to remove. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of a SQL Server. - - String - - String - - - none - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - false - - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1: - - - - - - - - - - - - - - - - - - Get-AzureRmSqlServerCommunicationLink - - - - New-AzureRmSqlServerCommunicationLink - - - - Set-AzureRmSqlServerCommunicationLink - - - - - - - Remove-AzureRmSqlServerFirewallRule - - Deletes a firewall rule from an Azure SQL Database server. - - - - - Remove - AzureRmSqlServerFirewallRule - - + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + + + + + Remove-AzureRmSqlServerCommunicationLink - The Remove-AzureRmSqlServerFirewallRule cmdlet deletes a firewall rule from the specified Azure SQL Database server. + Deletes an Azure SQL Server communication link. - - - Remove-AzureRmSqlServerFirewallRule - - ResourceGroupName - - Specifies the name of a resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of the server. - - String - - - FirewallRuleName - - Specifies the name of the firewall rule that this cmdlet deletes. - - String - - - Force - - Forces the command to run without asking for user confirmation. - - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - - - 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. - - - - - - - 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 - - - ResourceGroupName - - Specifies the name of a resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server. - - String - - String - - - none - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - false - - - 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 - - - - - - Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Example 1: Delete a rule - - - - PS C:\> Remove-AzureRmSqlServerFirewallRule -FirewallRuleName "rule01" -ResourceGroupName "resourcegroup01" -ServerName "server01" - - This command deletes a firewall rule named rule01 on the server named server01. - - - - - - - - - - - - - Get-AzureRmSqlServerFirewallRule - - - - New-AzureRmSqlServerFirewallRule - - - - Set-AzureRmSqlServerFirewallRule - - - - Azure SQL Database Cmdlets - - - - - - - Remove-AzureRmSqlServer - - Removes an Azure SQL Database server. - - - - - Remove - AzureRmSqlServer - - + + + + Remove + AzureRmSqlServerCommunicationLink + + + + The Remove-AzureRmSqlServerCommunicationLink cmdlet deletes an existing server-to-server partnership for Elastic transactions. + + + + Remove-AzureRmSqlServerCommunicationLink + + LinkName + + Specifies the name of the server communication link 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 server communication link that this cmdlet deletes. + + String + + + ResourceGroupName + + Specifies the name of the resource group that contains the server communication link 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 + + + + + + LinkName + + Specifies the name of the server communication link that this cmdlet deletes. + + String + + String + + + + + + Force + + Forces the command to run without asking for user confirmation. + + SwitchParameter + + SwitchParameter + + + + + + ServerName + + Specifies the name of the server that contains the server communication link that this cmdlet deletes. + + String + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group that contains the server communication link that this cmdlet deletes. + + String + + 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 + + SwitchParameter + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerCommunicationLinkModel + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- Example 1: Delete a server communication link -------------------------- + + PS C:\> + + PS C:\> Remove-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" -LinkName "link01" + + Deletes an existing server-to-server partnership for Elastic transactions. + + + + + + + + + + + + + + + + + + + + Resume-AzureRmSqlDatabase - The Remove-AzureRmSqlServer cmdlet removes an Azure SQL Database server. + Resumes an Azure SQL Data Warehouse database. - - - Remove-AzureRmSqlServer - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of the server to be removed. - - String - - - Force - - Forces the command to run without asking for user confirmation. - - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - - - 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. - - - - - - - Force - - Forces the command to run without asking for user confirmation. - - SwitchParameter - - SwitchParameter - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server to be removed. - - String - - String - - - none - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - false - - - 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 - - - - - - Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel - - - - - - - - - - - - - - - Example 1: Remove a server - - - - PS C:\> Remove-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01" - - This command removes the Azure SQL Database server named server01. - - - - - - - - - - - - - Get-AzureRmSqlServer - - - - New-AzureRmSqlServer - - - - Set-AzureRmSqlServer - - - - Azure SQL Database Cmdlets - - - - - - - Resume-AzureRmSqlDatabase - - Resumes an Azure SQL Data Warehouse database. - - - - - Resume - AzureRmSqlDatabase - - + + + + 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. + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Resume-AzureRmSqlDatabase cmdlet resumes an Azure SQL Data Warehouse database. + Sets properties for an Azure SQL database, or moves an existing database into an elastic pool. - - - Resume-AzureRmSqlDatabase - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - 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 - - - - - - DatabaseName - - Specifies the name of the database that this cmdlet resumes. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the database that this cmdlet resumes. - - String - - String - - - none - - - - - - Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - - - - - - - - - - - - - - - - The 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:\> Resume-AzureRmSqlDatabase -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 - - - - Azure SQL Database Cmdlets - - - - - - - Set-AzureRmSqlDatabaseAuditingPolicy - - Sets the auditing policy for an Azure SQL database. - - - - - Set - AzureRmSqlDatabaseAuditingPolicy - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - 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 the storage keys. - 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 audit log table names. 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 that policy. 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. + Sets the auditing policy for an Azure SQL database. - - - Set-AzureRmSqlDatabaseAuditingPolicy - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the database. - - String - - - DatabaseName - - Specifies the name of the database. - - String - - - EventType - - Specifies the event types to audit. Valid values are: - -- PlainSQL_Success - + + + + 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. - - - PlainSQL_Success - PlainSQL_Failure - ParameterizedSQL_Success - ParameterizedSQL_Failure - StoredProcedure_Success - StoredProcedure_Failure - Login_Success - Login_Failure - TransactionManagement_Success - TransactionManagement_Failure - All - None - - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - 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. - - UInt32] - - - 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 - + 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. - - - Primary - Secondary - - - - 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 - - - - - - DatabaseName - - Specifies the name of the database. - - String - - String - - - none - - - EventType - - Specifies the event types to audit. Valid values are: - -- PlainSQL_Success - + 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 + + + ThreatDetectionState + + Defines if threat detection is enabled or disabled for this database. + + String + + + NotificationRecipientsEmail + + A semicolon separated list of email addresses to send the alerts to. + + String + + + EmailAdmins + + Defines whether to email service and co-administrators. + + Boolean + + + ExcludedDetectionTypes + + A semicolon separated list of detection types to filter. + + 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 - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - SwitchParameter - - SwitchParameter - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - 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. - - UInt32] - - UInt32] - - - none - - - ServerName - - Specifies the name of the server that hosts the database. - - 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 - + 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 - - - 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 - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel - - - - - - - - - - - - - - - Example 1: Set the auditing policy of a database - - - - PS C:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -StorageAccountName "Storage31" - - This command sets the auditing policy of database named database01 located on 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:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -StorageAccountKey Secondary - - This command sets the auditing policy of database named database01 located on server01 to keep using the same storage account name but to now use the secondary key. - - - - - - - - - - - Example 3: Set the auditing policy of a database to use a specific event type - - - - PS C:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -EventType Login_Failure - - This command sets the auditing policy of database named database01 located on server01; the policy will log the Login_Failure event type. The command does not change the storage settings. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseAuditingPolicy - - - - Remove-AzureRmSqlDatabaseAuditing - - - - Azure SQL Database Cmdlets - - - - - - - Set-AzureRmSqlDatabaseDataMaskingPolicy - - Sets data masking for an Azure SQL database. - - - - - Set - AzureRmSqlDatabaseDataMaskingPolicy - - + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - 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. + Sets data masking for an Azure SQL database. - - - Set-AzureRmSqlDatabaseDataMaskingPolicy - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of the server hosting the database. - - String - - - DatabaseName - - Specifies the name of the database where the policy will be set. - - String - - - DataMaskingState - - Specifies whether data masking operation is enabled or disabled. Valid values are: - + + + + 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 PrivilegedUsers 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 + + The parameter PrivilegedLogins is being deprecated and will be removed in a future release. Use the PrivilegedUsers parameter to provide SQL users excluded from masking. + + String + + + PrivilegedUsers + + 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. - - - Enabled - Disabled - - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - PrivilegedLogins - - Specifies which SQL users are excluded from masking. - This parameter is deprecated and will be removed from future releases. - - String - - - PrivilegedUsers - - Specifies a semicolon-separated list of privileged user IDs. These users are allowed to view the masking data. - - System.String - - - - - - DatabaseName - - Specifies the name of the database where the policy will be set. - - String - - String - - - none - - - DataMaskingState - - Specifies whether data masking operation is enabled or disabled. Valid values are: - + 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 + + The parameter PrivilegedLogins is being deprecated and will be removed in a future release. Use the PrivilegedUsers parameter to provide SQL users excluded from masking. + + String + + String + + + none + + + PrivilegedUsers + + 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 - - - 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 which SQL users are excluded from masking. - This parameter is deprecated and will be removed from future releases. - - String - - String - - - none - - - PrivilegedUsers - - Specifies a semicolon-separated list of privileged user IDs. These users are allowed to view the masking data. - - System.String - - System.String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server hosting the database. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingPolicyModel - - - - - - - - - - - - - - - Example 1: Set the data masking policy for a database - - - - PS C:\>Set-AzureRmSqlDatabaseDataMaskingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" - - This command sets the data masking policy for a database named database01 on the server named server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseDataMaskingPolicy - - - - Get-AzureRmSqlDatabaseDataMaskingRule - - - - New-AzureRmSqlDatabaseDataMaskingRule - - - - Remove-AzureRmSqlDatabaseDataMaskingRule - - - - Set-AzureRmSqlDatabaseDataMaskingRule - - - - Azure SQL Database Cmdlets - - - - - - - Set-AzureRmSqlDatabaseDataMaskingRule - - Sets the properties of a data masking rule for an Azure SQL database. - - - - - Set - AzureRmSqlDatabaseDataMaskingRule - - + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Set-AzureRmSqlDatabaseDataMaskingRule cmdlet is used to set a data masking rule for 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 describes the data masking rule properties and the rule identifiers. Rule identifiers include, but are not limited to, ResourceGroupName, ServerName, DatabaseName, and RuleId. + Sets the properties of a data masking rule in an Azure SQL database. - - - Set-AzureRmSqlDatabaseDataMaskingRule - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the database. - - String - - - DatabaseName - - Specifies the name of the database. - - String - - - MaskingFunction - - Specifies the masking function that the rule uses. Valid values are: - -- Default - + + + + 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. - - - NoMasking - Default - Text - Number - SocialSecurityNumber - CreditCardNumber - Email - - - - 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. - - 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. - - Double] - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - PrefixSize - - Specifies the number of characters at the beginning of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. - - UInt32] - - - ReplacementString - - Specifies the number of characters at the end of the text that are 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 at the end of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. - - UInt32] - - - ColumnName - - Specifies the name of the column targeted by the masking rule. - - String - - - SchemaName - - Specifies the name of a schema. - - String - - - TableName - - Specifies the name of the database table containing the masked column. - - String - - - - - - ColumnName - - Specifies the name of the column targeted by the masking rule. - - String - - String - - - none - - - DatabaseName - - Specifies the name of the database. - - String - - String - - - none - - - MaskingFunction - - Specifies the masking function that the rule uses. Valid values are: - -- Default - + 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 - - - 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. - - Double] - - 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. - - Double] - - 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 - - - PrefixSize - - Specifies the number of characters at the beginning of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. - - UInt32] - - UInt32] - - - none - - - ReplacementString - - Specifies the number of characters at the end of the text that are 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 - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - SchemaName - - Specifies the name of a schema. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the database. - - String - - String - - - none - - - SuffixSize - - Specifies the number of characters at the end of the text that are not masked. Specify this parameter only if you specify a value of Text for the MaskingFunction parameter. The default value is 0. - - UInt32] - - UInt32] - - - none - - - TableName - - Specifies the name of the database table containing the masked column. - - String - - String - - - none - - - - - - - - - - - - - None. - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel - - - - - - - - - - - - - - - Example 1: Change the range of a data masking rule in a database - - - - 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 Cmdlets - - - - - - - Set-AzureRmSqlDatabaseSecondary - - Switches a secondary Azure SQL Database to the primary in order to initiate failover. - - - - - Set - AzureRmSqlDatabaseSecondary - - - - The Set-AzureRmSqlDatabaseSecondary cmdlet is designed as a general configuration command, but is currently limited to initiating failover. Use it with the AllowDataLoss parameter to initiate a force failover during an outage. You do not have to this parameter 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 - - ResourceGroupName - - Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. - - String - - - ServerName - - Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. - - String - - - DatabaseName - - Specifies the name of the Azure SQL Database Secondary. - - String - - - AllowDataLoss - - Determines if this failover operation will allow data loss. - - - - Failover - - Determines if this operation is a failover. - - - - PartnerResourceGroupName - - Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. - - String - - - - Set-AzureRmSqlDatabaseSecondary - - ResourceGroupName - - Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. - - String - - - ServerName - - Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. - - String - - - DatabaseName - - Specifies the name of the Azure SQL Database Secondary. - - String - - - PartnerResourceGroupName - - Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. - - String - - - - - - AllowDataLoss - - Determines if this failover operation will allow data loss. - - SwitchParameter - - SwitchParameter - - - none - - - DatabaseName - - Specifies the name of the Azure SQL Database Secondary. - - String - - String - - - none - - - Failover - - Determines if this operation is a failover. - - SwitchParameter - - SwitchParameter - - - none - - - PartnerResourceGroupName - - Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. - - String - - String - - - none - - - - - - - - - - - - - Set-AzureRmSqlDatabaseSecondary accepts instances of the Database object for the secondary database to fail over and make the primary database. - - - - - - - - - - - - - - The output type is a ReplicationLink object. - - - - - - - - 1: - - - - - - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - New-AzureRmSqlDatabaseSecondary - - - - Remove-AzureRmSqlDatabaseSecondary - - - - - - - Set-AzureRmSqlDatabaseThreatDetectionPolicy - - Sets a threat detection policy on a database. - - - - - Set - AzureRmSqlDatabaseThreatDetectionPolicy - - + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Set-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet sets a threat detection policy on an Azure SQL database. In order to enable threat detection on a database an auditing policy must be enabled on that database. - To use this cmdlet, specify the ResourceGroupName, ServerName and DatabaseName parameters to identify the database. + Switches a secondary Azure SQL Database to the primary in order to failover. - - - Set-AzureRmSqlDatabaseThreatDetectionPolicy - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of the server. - - String - - - DatabaseName - - Specifies the name of the database where the policy will be set. - - String - - - EmailAdmins - - Specifies whether the threat detection policy contacts administrators by using email. - - Boolean] - - - ExcludedDetectionType - - Specifies an array of detection types to exclude from the policy. Valid values are: - --- Sql_Injection --- Sql_Injection_Vulnerability --- Access_Anomaly --- Usage_Anomaly --- None - - - Sql_Injection - Sql_Injection_Vulnerability - Access_Anomaly - Usage_Anomaly - None - - - - NotificationRecipientsEmails - - Specifies a semicolon-separated list of email addresses to which the policy sends alerts. - - String - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - - - - DatabaseName - - Specifies the name of the database where the policy will be set. - - String - - String - - - none - - - EmailAdmins - - Specifies whether the threat detection policy contacts administrators by using email. - - Boolean] - - Boolean] - - - none - - - ExcludedDetectionType - - Specifies an array of detection types to exclude from the policy. Valid values are: - --- Sql_Injection --- Sql_Injection_Vulnerability --- Access_Anomaly --- Usage_Anomaly --- None - - String[] - - String[] - - - none - - - NotificationRecipientsEmails - - Specifies a semicolon-separated list of email addresses to which the policy sends alerts. - - String - - String - - - 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 - - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server. - - String - - String - - - none - - - - - - - - - - - - - You cannot pipe input to this cmdlet. - - - - - - - Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel - - - - - - - This cmdlet returns a Model.DatabaseThreatDetectionPolicyModel object. - - - - - - - - Example 1: Set the threat detection policy for a database - - - - PS C:\> Set-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" - - This command sets the threat detection policy for a database named Database01 on the server named Server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Remove-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Azure SQL Database Cmdlets - - - - - - - Set-AzureRmSqlDatabaseTransparentDataEncryption - - Modifies TDE for an Azure SQL database. - - - - - Set - AzureRmSqlDatabaseTransparentDataEncryption - - + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + + + + + + + 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. - + Modifies TPE for an Azure SQL database. - - - Set-AzureRmSqlDatabaseTransparentDataEncryption - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the. - - String - - - DatabaseName - - Specifies the name of the database that this cmdlet modifies. - - String - - - State - - Specifies the value of the TDE property. Valid values are: - -- Enabled + + + + 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 - - - Enabled - Disabled - - - - - - - DatabaseName - - Specifies the name of the database that this cmdlet modifies. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the. - - String - - String - - - none - - - State - - Specifies the value of the TDE property. Valid values are: - -- Enabled + + 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 - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel - - - - - - - - - - - - - - - Example 1: Enable TDE for a database - - - - PS C:\> Set-AzureRmSqlDatabaseTransparentDataEncryption -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -State Enabled -ResourceGroupName ServerName DatabaseName State + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - - This command enables TDE for the database named database01 on the server named server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseTransparentDataEncryption - - - - Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity - - - - Azure SQL Database Cmdlets - - - - - - - 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. In addition, you can specify the ElasticPoolName parameter to move a database into an elastic pool. If a database is already in an elastic pool, you can use the RequestedServiceObjectiveName parameter to assign a performance level. - - - - Set-AzureRmSqlDatabase - - ResourceGroupName - - Specifies the name of resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the database. - - String - - - DatabaseName - - Specifies the name of the database. - - String - - - Edition - - Specifies the edition for the database. Valid values are: - --- Default --- None --- Premium --- Basic --- Standard - - - None - Premium - Basic - Standard - DataWarehouse - Free - - - - ElasticPoolName - - Specifies name of the elastic pool in which to move 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 allowed values per edition. - - Int64 - - - 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 - - - Tags - - Specifies a dictionary of tags that this cmdlet associates with the new server. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - - - - DatabaseName - - Specifies the name of the database. - - String - - String - - - none - - - Edition - - Specifies the edition for the database. Valid values are: - --- Default --- None --- Premium --- Basic --- Standard - - DatabaseEdition - - DatabaseEdition - - - none - - - ElasticPoolName - - Specifies name of the elastic pool in which to move 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 allowed values per edition. - - Int64 - - Int64 - - - 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 - - - ResourceGroupName - - Specifies the name of resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the database. - - String - - String - - - none - - - Tags - - Specifies a dictionary of tags that this cmdlet associates with the new server. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - - - - - - - - - - - - - - - Example 1: Update a database to a Standard S2 database - - - - PS C:\> Set-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ServerName "server01" -Edition "Standard" -RequestedServiceObjectiveName "S2" -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 : - - This command updates a database named database01 to a Standard S2 database on a server named server01. - - - - - - - - - - - Example 2: Add a database to an elastic pool - - - - PS C:\> Set-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ServerName "server01" -ElasticPoolName "elasticpool01" -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 : - - The following command adds a database named database01 to the elastic pool named elasticpool01 hosted on the server named server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabase - - - - New-AzureRmSqlDatabase - - - - Remove-AzureRmSqlDatabase - - - - Resume-AzureRmSqlDatabase - - - - Suspend-AzureRmSqlDatabase - - - - Azure SQL Database Cmdlets - - - - - - - Set-AzureRmSqlElasticPool - - Modifies properties of an elastic database pool in Azure SQL Database. - - - - - Set - AzureRmSqlElasticPool - - +resourcegroup01 server01 database01 Enabled + + + + + + + + + + + + + + Get-AzureRmSqlDatabaseTransparentDataEncryption + + + + + Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity + + + + + + + + + Set-AzureRmSqlElasticPool - The Set-AzureRmSqlElasticPool cmdlet modifies properties for an elastic database pool in an Azure SQL Database. This cmdlet can modify the minimum Database Throughput Units (DTUs) per database, as well as the maximum DTUs per database, the number of DTUs for the pool, and the storage limit for the pool. + Modifies properties for an elastic database pool in Azure SQL Database. - - - Set-AzureRmSqlElasticPool - - ResourceGroupName - - Specifies the name of the resource group that the elastic pool is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the elastic pool. - - String - - - ElasticPoolName - - Specifies the name of the elastic pool. - - String - - - DatabaseDtuMax - - Specifies the maximum number of DTUs that any single database in the pool can consume. The default values for different editions are: - -- Basic. 5 DTUs + + + + 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 - - - 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 - - - Dtu - - Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are: - -- Basic. 100 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 - - - Edition - - Specifies the edition of the Azure SQL Database for the elastic pool. You cannot change the edition. - - - None - Premium - Basic - Standard - DataWarehouse - Free - - - - StorageMB - - Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the New-AzureRmSqlElasticPool cmdlet. - - Int32 - - - Tags - - Specifies a dictionary of tags that this cmdlet associates with the elastic pool. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - - - - DatabaseDtuMax - - Specifies the maximum number of DTUs that any single database in the pool can consume. The default values for different editions are: - -- Basic. 5 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 - - - 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 - - - Dtu - - Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are: - -- Basic. 100 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 - - - Edition - - Specifies the edition of the Azure SQL Database for the elastic pool. You cannot change the edition. - - DatabaseEdition - - DatabaseEdition - - - none - - - ElasticPoolName - - Specifies the name of the elastic pool. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the elastic pool is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the elastic pool. - - String - - String - - - none - - - StorageMB - - Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the New-AzureRmSqlElasticPool cmdlet. - - Int32 - - Int32 - - - none - - - Tags - - Specifies a dictionary of tags that this cmdlet associates with the elastic pool. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel - - - - - - - - - - - - - - - Example 1: Modify properties for an elastic pool - - - - PS C:\>Set-AzureRmSqlDatabaseElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" -Dtu 1000 -DatabaseDtuMax 100 -DatabaseDtuMin 20 -ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 @@ -11212,2254 +11778,2327 @@ Dtu : 200 DatabaseDtuMax : 100 DatabaseDtuMin : 20 StorageMB : 204800 -Tags : - - This command modifies properties for an elastic pool named elasticpool01. The command sets the number of DTUs for the elastic pool to 1000 and sets the minimum and maximum DTUs. - - - - - - - - - - - - - Get-AzureRmSqlElasticPool - - - - Get-AzureRmSqlElasticPoolActivity - - - - Get-AzureRmSqlElasticPoolDatabase - - - - New-AzureRmSqlElasticPool - - - - Azure SQL Database Cmdlets - - - - - - - Set-AzureRmSqlServerActiveDirectoryAdministrator - - Provisions an Azure AD administrator for SQL Server. - - - - - Set - AzureRmSqlServerActiveDirectoryAdministrator - - +Tags : + + + + + + + + + + + + + + Azure SQL Database + + + + + Get-AzureRmSqlElasticPool + + + + + Get-AzureRmSqlElasticPoolActivity + + + + + Get-AzureRmSqlElasticPoolDatabase + + + + + New-AzureRmSqlElasticPool + + + + + + + + + Set-AzureRmSqlServer - 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 a SQL Server administrator: - -- Native members of Azure AD + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 ADs who are native or federated members +-- 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, either. - We recommend that you provision a dedicated Azure AD group as an administrator. - - - - Set-AzureRmSqlServerActiveDirectoryAdministrator - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of 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. - - String - - - ObjectId - - Specifies the unique ID of the Azure AD administrator that this cmdlet provisions. If the display name is not unique, you must specify a value for this parameter. - - Guid - - - - - - DisplayName - - Specifies the display name of the Azure AD administrator that this cmdlet provisions. - - String - - String - - - none - - - ObjectId - - Specifies the unique ID of the Azure AD administrator that this cmdlet provisions. If the display name is not unique, you must specify a value for this parameter. - - Guid - - Guid - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the SQL Server for which this cmdlet provisions an administrator. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel - - - - - - - - - - - - - - - Example 1: Provision an administrator group for a server - - - - PS C:\>Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "DBAs" -ResourceGroupName ServerName DisplayName ObjectId + +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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - - This command provisions an Azure AD administrator group named DBAs for the server named server01. This server is associated with resource group resourcegroup01. - - - - - - - - - - - Example 2: Provision an administrator user for a server - - - - PS C:\>Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "David Chew" -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 - - This command provisions an Azure AD user (David Chew) as an administrator for the server named server01. - - - - - - - - - - - Example 3: Provision an administrator group by specifying its ID - - - - PS C:\> Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "DBAs" -ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b" -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 - - This command provisions an Azure AD administrator group named DBAs for the server named server01. The command specifies an ID for the ObjectId parameter. This ensures that the command will succeed even if the display name of the group is not unique. - - - - - - - - - - - - - Get-AzureRmSqlServerActiveDirectoryAdministrator - - - - Remove-AzureRmSqlServerActiveDirectoryAdministrator - - - - Azure SQL Database Cmdlets - - - - - - - Set-AzureRmSqlServerAuditingPolicy - - Changes the auditing policy of an Azure SQL server. - - - - - Set - AzureRmSqlServerAuditingPolicy - - +resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b + + + + + + + + + + + + + Get-AzureRmSqlServerActiveDirectoryAdministrator + + + + + Remove-AzureRmSqlServerActiveDirectoryAdministrator + + + + + + + + + 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 the 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 audit log table names. 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 identifiers. Server identifiers include, but are not limited to, ResourceGroupName and ServerName. + Changes the auditing policy of an Azure SQL server. - - - Set-AzureRmSqlServerAuditingPolicy - - ResourceGroupName - - Specifies the name of the resource group that contains the database. - - String - - - EventType - - Specifies the event types to audit. Valid values are: - -- PlainSQL_Success - + + + + 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 command fails. - - - PlainSQL_Success - PlainSQL_Failure - ParameterizedSQL_Success - ParameterizedSQL_Failure - StoredProcedure_Success - StoredProcedure_Failure - Login_Success - Login_Failure - TransactionManagement_Success - TransactionManagement_Failure - All - None - - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - RetentionInDays - - Specifies the number of retention days for the audit logs table. A value of zero (0) means that the table is not retained; this is the . If you specify a value greater than zero you must also specify a value for the TableIdentifer parameter. - - UInt32] - - - 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 command fails. - - String - - - StorageKeyType - - Specifies which of the storage access keys to use. Valid values are: - -- Primary - + 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. - - - Primary - Secondary - - - - 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 - - - - - - EventType - - Specifies the event types to audit. Valid values are: - -- PlainSQL_Success - + 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 command fails. - - String[] - - String[] - - - 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 - - - ResourceGroupName - - Specifies the name of the resource group that contains the database. - - 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; this is the . If you specify a value greater than zero you must also specify a value for the TableIdentifer parameter. - - UInt32] - - UInt32] - - - none - - - ServerName - - Specifies the name of the server that contains the database. - - 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 command fails. - - String - - String - - - none - - - StorageKeyType - - Specifies which of the storage access keys to use. Valid values are: - -- Primary - + 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 - - - 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 - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel - - - - - - - - - - - - - - - Example 1: Set the auditing policy of an Azure SQL server - - - - PS C:\> Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -StorageAccountName "Storage22" - - This command sets the auditing policy of the server named server01 to use a storage account named Storage22. - - - - - - - - - - - Example 2: Set the storage account key of an existing auditing policy of an Azure SQL server - - - - 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:\> 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 - - - - Azure SQL Database Cmdlets - - - - - - - Set-AzureRmSqlServerCommunicationLink - - Modifies a SQL Server communication link. - - - - - Set - AzureRmSqlServerCommunicationLink - - + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Set-AzureRmSqlServerCommunicationLink cmdlet modifies a SQL Server communication link. + Modifies a firewall rule in Azure SQL Database server. - - - Set-AzureRmSqlServerCommunicationLink - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of a SQL Server. - - String - - - LinkName - - Specifies the name of the link to modify. - - String - - - PartnerServer - - Specifies a partner server. - - String - - - - - - LinkName - - Specifies the name of the link to modify. - - String - - String - - - none - - - PartnerServer - - Specifies a partner server. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of a SQL Server. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1: - - - - - - - - - - - - - - - - - - Get-AzureRmSqlServerCommunicationLink - - - - New-AzureRmSqlServerCommunicationLink - - - - Remove-AzureRmSqlServerCommunicationLink - - - - - - - Set-AzureRmSqlServerFirewallRule - - Modifies a firewall rule in Azure SQL Database server. - - - - - Set - AzureRmSqlServerFirewallRule - - - - The Set-AzureRmSqlServerFirewallRule cmdlet modifies a firewall rule in an Azure SQL Database server. - - - - Set-AzureRmSqlServerFirewallRule - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of the server. - - String - - - FirewallRuleName - - Specifies the name of the firewall rule that this cmdlet modifies. - - String - - - EndIpAddress - - Specifies the end value of the IP address range for this 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 - - String - - - none - - - FirewallRuleName - - Specifies the name of the firewall rule that this cmdlet modifies. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server. - - String - - String - - - none - - - StartIpAddress - - Specifies the start value of the IP address range for the firewall rule. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel - - - - - - - - - - - - - - - Example 1: Modify a firewall rule - - - - PS C:\> Set-AzureRmSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -FirewallRuleName "rule01" -StartIpAddress "192.168.0.197" -EndIpAddress "192.168.0.199" -ResourceGroupName : resourcegroup01 + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - - This command modifies a firewall rule named rule01 on the server named server01. The command modifies the start and end IP addresses. - - - - - - - - - - - - - Get-AzureRmSqlServerFirewallRule - - - - New-AzureRmSqlServerFirewallRule - - - - Remove-AzureRmSqlServerFirewallRule - - - - Azure SQL Database Cmdlets - - - - - - - Set-AzureRmSqlServer - - Modifies properties of an Azure SQL Database server. - - - - - Set - AzureRmSqlServer - - +FirewallRuleName : rule01 + + + + + + + + + + + + + Azure SQL Database + + + + + Get-AzureRmSqlServerFirewallRule + + + + + New-AzureRmSqlServerFirewallRule + + + + + Remove-AzureRmSqlServerFirewallRule + + + + + + + + + Start-AzureRmSqlDatabaseExecuteIndexRecommendation - The Set-AzureRmSqlServer cmdlet modifies properties of an Azure SQL Database server. + Starts the workflow that runs a recommended index operation. - - - Set-AzureRmSqlServer - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of the server that this cmdlet modifies. - - String - - - Force - - Forces the command to run without asking for user confirmation. - - - - ServerVersion - - Specifies the version to which this cmdlet changes the server. Valid values are: 2.0 and 12.0. - - String - - - SqlAdministratorPassword - - Specifies a new password (as a SecureString) for the database server administrator. To obtain a SecureString, 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. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - - - 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. - - - - - - - Force - - Forces the command to run without asking for user confirmation. - - SwitchParameter - - SwitchParameter - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that this cmdlet modifies. - - String - - String - - - none - - - ServerVersion - - Specifies the version to which this cmdlet changes the server. Valid values are: 2.0 and 12.0. - - String - - String - - - none - - - SqlAdministratorPassword - - Specifies a new password (as a SecureString) for the database server administrator. To obtain a SecureString, 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. - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - 0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - - - none - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - false - - - 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 - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel - - - - - - - - - - - - - - - Example 1: Reset the admin password on Azure SQL Server - - - - PS C:\>$serverPassword = "newpassword" -PS C:\> $secureString = ConvertTo-SecureString $serverPassword -AsPlainText -Force -PS C:\> Set-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01" -SqlAdministratorPassword $secureString -ResourceGroupName : resourcegroup01 -ServerName : server01 -Location : Australia East -SqlAdministratorLogin : adminLogin -SqlAdministratorPassword : -ServerVersion : 12.0 -Tags : - - Resets the admin password to "newpassword" on Azure SQL Server "server01". - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - - - - Start-AzureRmSqlDatabaseExecuteIndexRecommendation - - Starts the workflow that runs a recommended index operation. - - - - - Start - AzureRmSqlDatabaseExecuteIndexRecommendation - - + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Start-AzureRmSqlDatabaseExecuteIndexRecommendation cmdlet starts the workflow that runs a recommended index operation for an Azure SQL Database. + Starts the upgrade of an Azure SQL Database server. - - - Start-AzureRmSqlDatabaseExecuteIndexRecommendation - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - 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 - - - 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 - - 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 the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the server that hosts the database for which this cmdlet starts a workflow. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Example 1: Run an index recommendation - - - - PS C:\> Start-AzureRmSqlDatabaseExecuteIndexRecommendation -ResourceGroup "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -IndexRecommendationName "INDEX_NAME" - - This command runs an index recommendation. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseIndexRecommendations - - - - Stop-AzureRmSqlDatabaseExecuteIndexRecommendation - - - - Azure SQL Database Cmdlets - - - - - - - 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. You can monitor the progress of an upgrade by using the Get-AzureRmSqlServerUpgrade cmdlet. - - - - Start-AzureRmSqlServerUpgrade - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - - DatabaseCollection - - Specifies an array of RecommendedDatabaseProperties objects that this cmdlet uses for the server upgrade. - - RecommendedDatabaseProperties[] - - - ElasticPoolCollection - - Specifies a collection of UpgradeRecommendedElasticPoolProperties objects to use for the server upgrade. See the examples for information on constructing a sample object. - - UpgradeRecommendedElasticPoolProperties[] - - - ScheduleUpgradeAfterUtcDateTime - - Specifies the earliest time, using 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. - - DateTime] - - - ServerName - - Specifies the name of the server that this cmdlet upgrades. - - String - - - ServerVersion - - Specifies the version to which this cmdlet upgrades the server. The only valid value is 12.0. - - String - - - - - - DatabaseCollection - - Specifies an array of RecommendedDatabaseProperties objects that this cmdlet uses for the server upgrade. - - RecommendedDatabaseProperties[] - - RecommendedDatabaseProperties[] - - - none - - - ElasticPoolCollection - - Specifies a collection of UpgradeRecommendedElasticPoolProperties objects to use for the server upgrade. See the examples for information on constructing a sample object. - - UpgradeRecommendedElasticPoolProperties[] - - UpgradeRecommendedElasticPoolProperties[] - - - none - - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - String - - - none - - - ScheduleUpgradeAfterUtcDateTime - - Specifies the earliest time, using 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. - - DateTime] - - DateTime] - - - none - - - ServerName - - Specifies the name of the server that this cmdlet upgrades. - - String - - String - - - none - - - ServerVersion - - Specifies the version to which this cmdlet upgrades the server. The only valid value is 12.0. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel - - - - - - - - - - - - - - - Example 1: Upgrade a server - - - - PS C:\> Start-AzureRmSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server01" -ServerVersion 12.0 -ResourceGroupName : resourcegroup01 + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 : - - This command upgrades the server named server01 assigned to resource group resourcegroup01. - - - - - - - - - - - Example 2: Upgrade a server by using schedule time and database recommendation - - - - PS C:\> $ScheduleTime = (Get-Date).AddMinutes(5).ToUniversalTime() +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 cmdlet. The command stores the date in the variable $ScheduleTime. For more information, type Get-Help Get-Date. - The second command creates a RecommendedDatabaseProperties object, and then stores that object in the variable $DatabaseMap. - The next three commands assign values to properties of the object stored in $DatabaseMap. - The final command upgrades the existing server named server01 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 will be running the Standard edition and have the Service Level Objective S0. - - - - - - - - - - - - - Get-AzureRmSqlServerUpgrade - - - - Stop-AzureRmSqlServerUpgrade - - - - Azure SQL Database Cmdlets - - - - - - - Stop-AzureRmSqlDatabaseExecuteIndexRecommendation - - Stops the workflow that runs a recommended index operation. - - - - - Stop - AzureRmSqlDatabaseExecuteIndexRecommendation - - + + 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 - The Stop-AzureRmSqlDatabaseExecuteIndexRecommendation cmdlet stops the workflow that runs a recommended index operation. + Stops the workflow that runs a recommended index operation. - - - Stop-AzureRmSqlDatabaseExecuteIndexRecommendation - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - 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 - - - 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 - - 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 the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the server that hosts the database for which this cmdlet stops a workflow. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Example 1: Stop running an index recommendation - - - - PS C:\> Stop-AzureRmSqlDatabaseExecuteIndexRecommendation -ResourceGroup "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -IndexRecommendationName "INDEX_NAME" - - This command stops running an index recommendation. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseIndexRecommendations - - - - Start-AzureRmSqlDatabaseExecuteIndexRecommendation - - - - Azure SQL Database Cmdlets - - - - - - - Stop-AzureRmSqlServerUpgrade - - Stops the upgrade of an Azure SQL Database server. - - - - - Stop - AzureRmSqlServerUpgrade - - + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Stop-AzureRmSqlServerUpgrade cmdlet stops the upgrade of an Azure SQL Database server. + Stops the upgrade of an Azure SQL Database server. - - - Stop-AzureRmSqlServerUpgrade - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - - Force - - Forces the command to run without asking for user confirmation. - - - - ServerName - - Specifies the name of the server for which this cmdlet stops an upgrade. - - String - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - - - 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. - - - - - - - Force - - Forces the command to run without asking for user confirmation. - - SwitchParameter - - SwitchParameter - - - none - - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server for which this cmdlet stops an upgrade. - - String - - String - - - none - - - Confirm - - Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - false - - - 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 - - - - - - Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Example 1: Stop a server upgrade - - - - PS C:\> Stop-AzureRmSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server02" - - This command stops the request to upgrade the server named server02 assigned to the resource group named resourcegroup01. - - - - - - - - - - - - - Get-AzureRmSqlServerUpgrade - - - - Start-AzureRmSqlServerUpgrade - - - - Azure SQL Database Cmdlets - - - - - - - Suspend-AzureRmSqlDatabase - - Suspends an Azure SQL Data Warehouse database. - - - - - Suspend - AzureRmSqlDatabase - - + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - The Suspend-AzureRmSqlDatabase cmdlet suspends an Azure SQL Data Warehouse database. + Suspends an Azure SQL Data Warehouse database. - - - Suspend-AzureRmSqlDatabase - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of the server which hosts the. - - String - - - DatabaseName - - Specifies the name of the database that this cmdlet suspends. - - String - - - - - - DatabaseName - - Specifies the name of the database that this cmdlet suspends. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server which hosts the. - - String - - String - - - none - - - - - - Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel - - - - - - - - - - - - - - - - The 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:\> Suspend-AzureRmSqlDatabase -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 - - - - Azure SQL Database Cmdlets - - - - - - - Use-AzureRmSqlServerAuditingPolicy - - Specifies that a database uses the auditing policy of its hosting server. - - - - - Use - AzureRmSqlServerAuditingPolicy - - + + + + 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. + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 - 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. - If the host uses server level auditing, threat detection is removed. + Specifies that a database uses the auditing policy of its hosting server. - - - Use-AzureRmSqlServerAuditingPolicy - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of the server that hosts the database that will use the auditing policy. - - String - - - DatabaseName - - Specifies the name of the database that will 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. - - - - - - - DatabaseName - - Specifies the name of the database that will use the auditing policy. - - String - - String - - - 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 - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server that hosts the database that will use the auditing policy. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel - - - - - - - - - - - - - - - Example 1: Configure a database to use the auditing policy of its server - - - - PS C:\> Use-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server02" -DatabaseName "database01" - - This command specifies that the database named database01 on server02 will use the auditing policy of the server. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseAuditingPolicy - - - - Get-AzureRmSqlServerAuditingPolicy - - - - Set-AzureRmSqlDatabaseAuditingPolicy - - - - Set-AzureRmSqlServerAuditingPolicy - - - - Azure SQL Database Cmdlets - - - - + + + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 From fe38a5067223e1c243f09a5a99df20ae33d134cc Mon Sep 17 00:00:00 2001 From: yaakoviyun Date: Wed, 17 Feb 2016 09:38:20 +0200 Subject: [PATCH 3/5] updated Microsoft.Azure.Commands.Sql.dll-Help with threat detection cmdlets --- .../Microsoft.Azure.Commands.Sql.dll-Help.xml | 1325 ++++++++++++----- 1 file changed, 935 insertions(+), 390 deletions(-) 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 8dcd923a6f94..55e0b47db8a3 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 @@ -2212,6 +2212,157 @@ SecureConnectionState : Optional + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + Gets the threat detection policy for a database. + + + + + Get + AzureRmSqlDatabaseThreatDetectionPolicy + + + + The Get-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet gets the threat detection policy of an Azure SQL database. To use this cmdlet, specify the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database for which this cmdlet gets the policy. + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of a server. + + String + + + DatabaseName + + Specifies the name of a database. + + String + + + + + + DatabaseName + + Specifies the name of a database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a server. + + String + + String + + + none + + + + + + + + + + + + + You cannot pipe input to this cmdlet. + + + + + + + Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel + + + + + + + This cmdlet returns a Model.DatabaseThreatDetectionPolicyModel object. + + + + + + + + Example 1: Get the threat detection policy for a database + + + + PS C:\> Get-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +DatabaseName : Database01 +ResourceGroupName : ResourceGroup11 +ServerName : Server01 +ThreatDetectionState : Disabled +NotificationRecipientsEmails : +EmailAdmins : False +ExcludedDetectionTypes : {} + + This command gets the threat detection policy for a database named Database01. The database is located on the server named Server01, which is assigned to the resource group ResourceGroup11. + + + + + + + + + + + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Azure SQL Database Cmdlets + + + + @@ -5694,6 +5845,169 @@ Tags : + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + Removes the threat detection policy from a database. + + + + + Remove + AzureRmSqlDatabaseThreatDetectionPolicy + + + + The Remove-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet removes the threat detection policy from an Azure SQL database. + To use this cmdlet, specify the ResourceGroupName, ServerName and DatabaseName parameters to identify the database from which this cmdlet removes the policy. + + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of a server. + + String + + + DatabaseName + + Specifies the name of a database where the threat detection policy should be removed. + + String + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + + + + DatabaseName + + Specifies the name of a database where the threat detection policy should be removed. + + String + + String + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a server. + + String + + String + + + none + + + + + + + + + + + + + You cannot pipe input to this cmdlet. + + + + + + + Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel + + + + + + + This cmdlet returns a DatabaseThreatDetectionPolicyModel object. + + + + + + + + Example 1: Remove a threat detection policy for a database + + + + PS C:\> Remove-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" + + This command removes the threat detection policy from a database named Database01 on the server named Server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Azure SQL Database Cmdlets + + + + @@ -7606,7 +7920,8 @@ FirewallRuleName : rule01 - 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. + 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. + If you remove auditing of an Azure SQL database, threat detection is also removed. @@ -10020,397 +10335,160 @@ Tags : - - - - Set-AzureRmSqlDatabaseAuditingPolicy + + + Get-AzureRmSqlDatabaseAuditingPolicy + + Gets the auditing policy of an Azure SQL database. + + + + + Get + AzureRmSqlDatabaseAuditingPolicy + + - Sets the auditing policy for an Azure SQL database. + 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. - - - - 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 - - - ThreatDetectionState - - Defines if threat detection is enabled or disabled for this database. - - String - - - NotificationRecipientsEmail - - A semicolon separated list of email addresses to send the alerts to. - - String - - - EmailAdmins - - Defines whether to email service and co-administrators. - - Boolean - - - ExcludedDetectionTypes - - A semicolon separated list of detection types to filter. - - 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - + + + Get-AzureRmSqlDatabaseAuditingPolicy + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the server where the database is located. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server where the database is located. + + String + + String + + + none + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel + + + + + + + + + + + + + + + Example 1: Get the auditing policy of an Azure SQL database + + + + PS C:\> Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" +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 + + This command gets the auditing policy of database database01 located in server01 in resource group resourcegroup01. + + + + + + + + + + + + + Remove-AzureRmSqlDatabaseAuditing + + + + Set-AzureRmSqlDatabaseAuditingPolicy + + + + Azure SQL Database Cmdlets + + + + @@ -11304,6 +11382,473 @@ Tags : + + + Set-AzureRmSqlDatabaseSecondary + + Switches a secondary Azure SQL Database to the primary in order to initiate failover. + + + + + Set + AzureRmSqlDatabaseSecondary + + + + The Set-AzureRmSqlDatabaseSecondary cmdlet is designed as a general configuration command, but is currently limited to initiating failover. Use it with the AllowDataLoss parameter to initiate a force failover during an outage. You do not have to this parameter 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 + + ResourceGroupName + + Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. + + String + + + ServerName + + Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database Secondary. + + String + + + AllowDataLoss + + Determines if this failover operation will allow data loss. + + + + Failover + + Determines if this operation is a failover. + + + + PartnerResourceGroupName + + Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. + + String + + + + Set-AzureRmSqlDatabaseSecondary + + ResourceGroupName + + Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. + + String + + + ServerName + + Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. + + String + + + DatabaseName + + Specifies the name of the Azure SQL Database Secondary. + + String + + + PartnerResourceGroupName + + Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. + + String + + + + + + AllowDataLoss + + Determines if this failover operation will allow data loss. + + SwitchParameter + + SwitchParameter + + + none + + + DatabaseName + + Specifies the name of the Azure SQL Database Secondary. + + String + + String + + + none + + + Failover + + Determines if this operation is a failover. + + SwitchParameter + + SwitchParameter + + + none + + + PartnerResourceGroupName + + Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. + + String + + String + + + none + + + + + + + + + + + + + Set-AzureRmSqlDatabaseSecondary accepts instances of the Database object for the secondary database to fail over and make the primary database. + + + + + + + + + + + + + + The output type is a ReplicationLink object. + + + + + + + + 1: + + + + + + + + + + + + + + + + + + Azure SQL Database Cmdlets + + + + New-AzureRmSqlDatabaseSecondary + + + + Remove-AzureRmSqlDatabaseSecondary + + + + + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + Sets a threat detection policy on a database. + + + + + Set + AzureRmSqlDatabaseThreatDetectionPolicy + + + + The Set-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet sets a threat detection policy on an Azure SQL database. In order to enable threat detection on a database an auditing policy must be enabled on that database. + To use this cmdlet, specify the ResourceGroupName, ServerName and DatabaseName parameters to identify the database. + + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of the server. + + String + + + DatabaseName + + Specifies the name of the database where the policy will be set. + + String + + + EmailAdmins + + Specifies whether the threat detection policy contacts administrators by using email. + + Boolean] + + + ExcludedDetectionType + + Specifies an array of detection types to exclude from the policy. Valid values are: + +-- Sql_Injection +-- Sql_Injection_Vulnerability +-- Access_Anomaly +-- Usage_Anomaly +-- None + + + Sql_Injection + Sql_Injection_Vulnerability + Access_Anomaly + Usage_Anomaly + None + + + + NotificationRecipientsEmails + + Specifies a semicolon-separated list of email addresses to which the policy sends alerts. + + String + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + + + + DatabaseName + + Specifies the name of the database where the policy will be set. + + String + + String + + + none + + + EmailAdmins + + Specifies whether the threat detection policy contacts administrators by using email. + + Boolean] + + Boolean] + + + none + + + ExcludedDetectionType + + Specifies an array of detection types to exclude from the policy. Valid values are: + +-- Sql_Injection +-- Sql_Injection_Vulnerability +-- Access_Anomaly +-- Usage_Anomaly +-- None + + String[] + + String[] + + + none + + + NotificationRecipientsEmails + + Specifies a semicolon-separated list of email addresses to which the policy sends alerts. + + String + + String + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server. + + String + + String + + + none + + + + + + + + + + + + + You cannot pipe input to this cmdlet. + + + + + + + Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel + + + + + + + This cmdlet returns a Model.DatabaseThreatDetectionPolicyModel object. + + + + + + + + Example 1: Set the threat detection policy for a database + + + + PS C:\> Set-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" + + This command sets the threat detection policy for a database named Database01 on the server named Server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Azure SQL Database Cmdlets + + + + From a5085b87fd4e92fbfa7ca40d3d0531267f42e62b Mon Sep 17 00:00:00 2001 From: yaakoviyun Date: Thu, 18 Feb 2016 14:12:36 +0200 Subject: [PATCH 4/5] Revert "updated Microsoft.Azure.Commands.Sql.dll-Help with threat detection cmdlets" This reverts commit fe38a5067223e1c243f09a5a99df20ae33d134cc. --- .../Microsoft.Azure.Commands.Sql.dll-Help.xml | 1325 +++++------------ 1 file changed, 390 insertions(+), 935 deletions(-) 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 55e0b47db8a3..8dcd923a6f94 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 @@ -2212,157 +2212,6 @@ SecureConnectionState : Optional - - - Get-AzureRmSqlDatabaseThreatDetectionPolicy - - Gets the threat detection policy for a database. - - - - - Get - AzureRmSqlDatabaseThreatDetectionPolicy - - - - The Get-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet gets the threat detection policy of an Azure SQL database. To use this cmdlet, specify the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database for which this cmdlet gets the policy. - - - - Get-AzureRmSqlDatabaseThreatDetectionPolicy - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - - ServerName - - Specifies the name of a server. - - String - - - DatabaseName - - Specifies the name of a database. - - String - - - - - - DatabaseName - - Specifies the name of a database. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of a server. - - String - - String - - - none - - - - - - - - - - - - - You cannot pipe input to this cmdlet. - - - - - - - Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel - - - - - - - This cmdlet returns a Model.DatabaseThreatDetectionPolicyModel object. - - - - - - - - Example 1: Get the threat detection policy for a database - - - - PS C:\> Get-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -DatabaseName : Database01 -ResourceGroupName : ResourceGroup11 -ServerName : Server01 -ThreatDetectionState : Disabled -NotificationRecipientsEmails : -EmailAdmins : False -ExcludedDetectionTypes : {} - - This command gets the threat detection policy for a database named Database01. The database is located on the server named Server01, which is assigned to the resource group ResourceGroup11. - - - - - - - - - - - - - Remove-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Set-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Azure SQL Database Cmdlets - - - - @@ -5845,169 +5694,6 @@ Tags : - - - Remove-AzureRmSqlDatabaseThreatDetectionPolicy - - Removes the threat detection policy from a database. - - - - - Remove - AzureRmSqlDatabaseThreatDetectionPolicy - - - - The Remove-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet removes the threat detection policy from an Azure SQL database. - To use this cmdlet, specify the ResourceGroupName, ServerName and DatabaseName parameters to identify the database from which this cmdlet removes the policy. - - - - Remove-AzureRmSqlDatabaseThreatDetectionPolicy - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of a server. - - String - - - DatabaseName - - Specifies the name of a database where the threat detection policy should be removed. - - String - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - - - - DatabaseName - - Specifies the name of a database where the threat detection policy should be removed. - - String - - String - - - 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 - - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of a server. - - String - - String - - - none - - - - - - - - - - - - - You cannot pipe input to this cmdlet. - - - - - - - Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel - - - - - - - This cmdlet returns a DatabaseThreatDetectionPolicyModel object. - - - - - - - - Example 1: Remove a threat detection policy for a database - - - - PS C:\> Remove-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" - - This command removes the threat detection policy from a database named Database01 on the server named Server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Set-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Azure SQL Database Cmdlets - - - - @@ -7920,8 +7606,7 @@ FirewallRuleName : rule01 - 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. - If you remove auditing of an Azure SQL database, threat detection is also removed. + 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. @@ -10335,160 +10020,397 @@ Tags : - - - Get-AzureRmSqlDatabaseAuditingPolicy - - Gets the auditing policy of an Azure SQL database. - - - - - Get - AzureRmSqlDatabaseAuditingPolicy - - + + + + Set-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. + Sets the auditing policy for an Azure SQL database. - - - Get-AzureRmSqlDatabaseAuditingPolicy - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - - ServerName - - Specifies the name of the server where the database is located. - - String - - - DatabaseName - - Specifies the name of the database. - - String - - - - - - DatabaseName - - Specifies the name of the database. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the resource group that the database is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server where the database is located. - - String - - String - - - none - - - - - - - - - - - - - - - - - - - - Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel - - - - - - - - - - - - - - - Example 1: Get the auditing policy of an Azure SQL database - - - - PS C:\> Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -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 - - This command gets the auditing policy of database database01 located in server01 in resource group resourcegroup01. - - - - - - - - - - - - - Remove-AzureRmSqlDatabaseAuditing - - - - Set-AzureRmSqlDatabaseAuditingPolicy - - - - Azure SQL Database Cmdlets - - - - + + + + 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 + + + ThreatDetectionState + + Defines if threat detection is enabled or disabled for this database. + + String + + + NotificationRecipientsEmail + + A semicolon separated list of email addresses to send the alerts to. + + String + + + EmailAdmins + + Defines whether to email service and co-administrators. + + Boolean + + + ExcludedDetectionTypes + + A semicolon separated list of detection types to filter. + + 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 + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql + + + + + -------------------------- 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 + + + + + @@ -11382,473 +11304,6 @@ TableIdentifier : Server01Database01 - - - Set-AzureRmSqlDatabaseSecondary - - Switches a secondary Azure SQL Database to the primary in order to initiate failover. - - - - - Set - AzureRmSqlDatabaseSecondary - - - - The Set-AzureRmSqlDatabaseSecondary cmdlet is designed as a general configuration command, but is currently limited to initiating failover. Use it with the AllowDataLoss parameter to initiate a force failover during an outage. You do not have to this parameter 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 - - ResourceGroupName - - Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. - - String - - - ServerName - - Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. - - String - - - DatabaseName - - Specifies the name of the Azure SQL Database Secondary. - - String - - - AllowDataLoss - - Determines if this failover operation will allow data loss. - - - - Failover - - Determines if this operation is a failover. - - - - PartnerResourceGroupName - - Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. - - String - - - - Set-AzureRmSqlDatabaseSecondary - - ResourceGroupName - - Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. - - String - - - ServerName - - Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. - - String - - - DatabaseName - - Specifies the name of the Azure SQL Database Secondary. - - String - - - PartnerResourceGroupName - - Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. - - String - - - - - - AllowDataLoss - - Determines if this failover operation will allow data loss. - - SwitchParameter - - SwitchParameter - - - none - - - DatabaseName - - Specifies the name of the Azure SQL Database Secondary. - - String - - String - - - none - - - Failover - - Determines if this operation is a failover. - - SwitchParameter - - SwitchParameter - - - none - - - PartnerResourceGroupName - - Specifies the name of the Azure resource group that the partner Azure SQL Database is assigned to. - - String - - String - - - none - - - ResourceGroupName - - Specifies the name of the Azure resource group that the Azure SQL Database Secondary is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the Azure SQL Server that hosts the Azure SQL Database Secondary. - - String - - String - - - none - - - - - - - - - - - - - Set-AzureRmSqlDatabaseSecondary accepts instances of the Database object for the secondary database to fail over and make the primary database. - - - - - - - - - - - - - - The output type is a ReplicationLink object. - - - - - - - - 1: - - - - - - - - - - - - - - - - - - Azure SQL Database Cmdlets - - - - New-AzureRmSqlDatabaseSecondary - - - - Remove-AzureRmSqlDatabaseSecondary - - - - - - - Set-AzureRmSqlDatabaseThreatDetectionPolicy - - Sets a threat detection policy on a database. - - - - - Set - AzureRmSqlDatabaseThreatDetectionPolicy - - - - The Set-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet sets a threat detection policy on an Azure SQL database. In order to enable threat detection on a database an auditing policy must be enabled on that database. - To use this cmdlet, specify the ResourceGroupName, ServerName and DatabaseName parameters to identify the database. - - - - Set-AzureRmSqlDatabaseThreatDetectionPolicy - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - - ServerName - - Specifies the name of the server. - - String - - - DatabaseName - - Specifies the name of the database where the policy will be set. - - String - - - EmailAdmins - - Specifies whether the threat detection policy contacts administrators by using email. - - Boolean] - - - ExcludedDetectionType - - Specifies an array of detection types to exclude from the policy. Valid values are: - --- Sql_Injection --- Sql_Injection_Vulnerability --- Access_Anomaly --- Usage_Anomaly --- None - - - Sql_Injection - Sql_Injection_Vulnerability - Access_Anomaly - Usage_Anomaly - None - - - - NotificationRecipientsEmails - - Specifies a semicolon-separated list of email addresses to which the policy sends alerts. - - String - - - PassThru - - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. - - - - - - - DatabaseName - - Specifies the name of the database where the policy will be set. - - String - - String - - - none - - - EmailAdmins - - Specifies whether the threat detection policy contacts administrators by using email. - - Boolean] - - Boolean] - - - none - - - ExcludedDetectionType - - Specifies an array of detection types to exclude from the policy. Valid values are: - --- Sql_Injection --- Sql_Injection_Vulnerability --- Access_Anomaly --- Usage_Anomaly --- None - - String[] - - String[] - - - none - - - NotificationRecipientsEmails - - Specifies a semicolon-separated list of email addresses to which the policy sends alerts. - - String - - String - - - 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 - - - ResourceGroupName - - Specifies the name of the resource group the server is assigned to. - - String - - String - - - none - - - ServerName - - Specifies the name of the server. - - String - - String - - - none - - - - - - - - - - - - - You cannot pipe input to this cmdlet. - - - - - - - Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel - - - - - - - This cmdlet returns a Model.DatabaseThreatDetectionPolicyModel object. - - - - - - - - Example 1: Set the threat detection policy for a database - - - - PS C:\> Set-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" - - This command sets the threat detection policy for a database named Database01 on the server named Server01. - - - - - - - - - - - - - Get-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Remove-AzureRmSqlDatabaseThreatDetectionPolicy - - - - Azure SQL Database Cmdlets - - - - From 7f587a5f9339ea0cd33ca83c8ca5964ea03ad7ac Mon Sep 17 00:00:00 2001 From: yaakoviyun Date: Thu, 18 Feb 2016 14:24:05 +0200 Subject: [PATCH 5/5] updated file --- .../Microsoft.Azure.Commands.Sql.dll-Help.xml | 1264 ++++++++++++----- 1 file changed, 896 insertions(+), 368 deletions(-) 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 8dcd923a6f94..b3f3f02d841c 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 @@ -2211,7 +2211,158 @@ SecureConnectionState : Optional - + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + Gets the threat detection policy for a database. + + + + + Get + AzureRmSqlDatabaseThreatDetectionPolicy + + + + The Get-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet gets the threat detection policy of an Azure SQL database. To use this cmdlet, specify the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database for which this cmdlet gets the policy. + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + + ServerName + + Specifies the name of a server. + + String + + + DatabaseName + + Specifies the name of a database. + + String + + + + + + DatabaseName + + Specifies the name of a database. + + String + + String + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a server. + + String + + String + + + none + + + + + + + + + + + + + You cannot pipe input to this cmdlet. + + + + + + + Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel + + + + + + + This cmdlet returns a Model.DatabaseThreatDetectionPolicyModel object. + + + + + + + + Example 1: Get the threat detection policy for a database + + + + PS C:\> Get-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" +DatabaseName : Database01 +ResourceGroupName : ResourceGroup11 +ServerName : Server01 +ThreatDetectionState : Disabled +NotificationRecipientsEmails : +EmailAdmins : False +ExcludedDetectionTypes : {} + + This command gets the threat detection policy for a database named Database01. The database is located on the server named Server01, which is assigned to the resource group ResourceGroup11. + + + + + + + + + + + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Azure SQL Database Cmdlets + + + + @@ -7606,7 +7757,8 @@ FirewallRuleName : rule01 - 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. + 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. + If you remove auditing of an Azure SQL database, threat detection is also removed. @@ -8223,6 +8375,169 @@ FirewallRuleName : rule01 + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + Removes the threat detection policy from a database. + + + + + Remove + AzureRmSqlDatabaseThreatDetectionPolicy + + + + The Remove-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet removes the threat detection policy from an Azure SQL database. + To use this cmdlet, specify the ResourceGroupName, ServerName and DatabaseName parameters to identify the database from which this cmdlet removes the policy. + + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of a server. + + String + + + DatabaseName + + Specifies the name of a database where the threat detection policy should be removed. + + String + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + + + + DatabaseName + + Specifies the name of a database where the threat detection policy should be removed. + + String + + String + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of a server. + + String + + String + + + none + + + + + + + + + + + + + You cannot pipe input to this cmdlet. + + + + + + + Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel + + + + + + + This cmdlet returns a DatabaseThreatDetectionPolicyModel object. + + + + + + + + Example 1: Remove a threat detection policy for a database + + + + PS C:\> Remove-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" + + This command removes the threat detection policy from a database named Database01 on the server named Server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Azure SQL Database Cmdlets + + + + @@ -10020,397 +10335,371 @@ Tags : - - - - Set-AzureRmSqlDatabaseAuditingPolicy + + + Set-AzureRmSqlDatabaseAuditingPolicy + + Sets the auditing policy for an Azure SQL database. + + + + + Set + AzureRmSqlDatabaseAuditingPolicy + + - Sets the auditing policy for an Azure SQL database. + 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 the storage keys. + 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 audit log table names. 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 that policy. 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 - - - - 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 + + + Set-AzureRmSqlDatabaseAuditingPolicy + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + String + + + ServerName + + Specifies the name of the server that hosts the database. + + String + + + DatabaseName + + Specifies the name of the database. + + String + + + 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 + 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. + + + PlainSQL_Success + PlainSQL_Failure + ParameterizedSQL_Success + ParameterizedSQL_Failure + StoredProcedure_Success + StoredProcedure_Failure + Login_Success + Login_Failure + TransactionManagement_Success + TransactionManagement_Failure + All + None + + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + 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. + + UInt32] + + + 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 - - - ThreatDetectionState - - Defines if threat detection is enabled or disabled for this database. - - String - - - NotificationRecipientsEmail - - A semicolon separated list of email addresses to send the alerts to. - - String - - - EmailAdmins - - Defines whether to email service and co-administrators. - - Boolean - - - ExcludedDetectionTypes - - A semicolon separated list of detection types to filter. - - 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 + The default value is Primary. + + + Primary + Secondary + + + + 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 + + + + + + DatabaseName + + Specifies the name of the database. + + String + + String + + + 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 + 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 + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + SwitchParameter + + SwitchParameter + + + none + + + ResourceGroupName + + Specifies the name of the resource group that the database is assigned to. + + 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. + + UInt32] + + UInt32] + + + none + + + ServerName + + Specifies the name of the server that hosts the database. + + 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 - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql - - - - - -------------------------- 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 - - - - - + The default value is Primary. + + String + + String + + + 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 + + + + + + + + + + + + + + + + + + + + Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel + + + + + + + + + + + + + + + Example 1: Set the auditing policy of a database + + + + PS C:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -StorageAccountName "Storage31" + + This command sets the auditing policy of database named database01 located on 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:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -StorageAccountKey Secondary + + This command sets the auditing policy of database named database01 located on server01 to keep using the same storage account name but to now use the secondary key. + + + + + + + + + + + Example 3: Set the auditing policy of a database to use a specific event type + + + + PS C:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -EventType Login_Failure + + This command sets the auditing policy of database named database01 located on server01; the policy will log the Login_Failure event type. The command does not change the storage settings. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseAuditingPolicy + + + + Remove-AzureRmSqlDatabaseAuditing + + + + Azure SQL Database Cmdlets + + + + @@ -11304,6 +11593,244 @@ Tags : + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + Sets a threat detection policy on a database. + + + + + Set + AzureRmSqlDatabaseThreatDetectionPolicy + + + + The Set-AzureRmSqlDatabaseThreatDetectionPolicy cmdlet sets a threat detection policy on an Azure SQL database. In order to enable threat detection on a database an auditing policy must be enabled on that database. + To use this cmdlet, specify the ResourceGroupName, ServerName and DatabaseName parameters to identify the database. + + + + Set-AzureRmSqlDatabaseThreatDetectionPolicy + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + + ServerName + + Specifies the name of the server. + + String + + + DatabaseName + + Specifies the name of the database where the policy will be set. + + String + + + EmailAdmins + + Specifies whether the threat detection policy contacts administrators by using email. + + Boolean] + + + ExcludedDetectionType + + Specifies an array of detection types to exclude from the policy. Valid values are: + +-- Sql_Injection +-- Sql_Injection_Vulnerability +-- Access_Anomaly +-- Usage_Anomaly +-- None + + + Sql_Injection + Sql_Injection_Vulnerability + Access_Anomaly + Usage_Anomaly + None + + + + NotificationRecipientsEmails + + Specifies a semicolon-separated list of email addresses to which the policy sends alerts. + + String + + + PassThru + + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. + + + + + + + DatabaseName + + Specifies the name of the database where the policy will be set. + + String + + String + + + none + + + EmailAdmins + + Specifies whether the threat detection policy contacts administrators by using email. + + Boolean] + + Boolean] + + + none + + + ExcludedDetectionType + + Specifies an array of detection types to exclude from the policy. Valid values are: + +-- Sql_Injection +-- Sql_Injection_Vulnerability +-- Access_Anomaly +-- Usage_Anomaly +-- None + + String[] + + String[] + + + none + + + NotificationRecipientsEmails + + Specifies a semicolon-separated list of email addresses to which the policy sends alerts. + + String + + String + + + 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 + + + ResourceGroupName + + Specifies the name of the resource group the server is assigned to. + + String + + String + + + none + + + ServerName + + Specifies the name of the server. + + String + + String + + + none + + + + + + + + + + + + + You cannot pipe input to this cmdlet. + + + + + + + Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionPolicyModel + + + + + + + This cmdlet returns a Model.DatabaseThreatDetectionPolicyModel object. + + + + + + + + Example 1: Set the threat detection policy for a database + + + + PS C:\> Set-AzureRmSqlDatabaseThreatDetectionPolicy -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01" -NotificationRecipientsEmails "admin01@contoso.com;secadmin@contoso.com" -EmailAdmins $False -ExcludedDetectionType "Sql_Injection_Vulnerability", "SQL_Injection" + + This command sets the threat detection policy for a database named Database01 on the server named Server01. + + + + + + + + + + + + + Get-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Remove-AzureRmSqlDatabaseThreatDetectionPolicy + + + + Azure SQL Database Cmdlets + + + + @@ -13919,7 +14446,8 @@ The final command upgrades the existing server named server02 in the resource g - 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. + 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. + If the host uses server level auditing, threat detection is removed.