Microsoft.Azure.Commands.Sql.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlCapability</command:name> <maml:description> <maml:para>Gets SQL Database capabilities for the current subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlCapability</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlCapability</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>LocationName</maml:name> <maml:description> <maml:para>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/).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Defaults</maml:name> <maml:description> <maml:para>Indicates that this cmdlet gets only defaults.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmSqlCapability</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>LocationName</maml:name> <maml:description> <maml:para>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/).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerVersionName</maml:name> <maml:description> <maml:para>Specifies the name of the server version for which this cmdlet gets capabilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>EditionName</maml:name> <maml:description> <maml:para>Specifies the name of the database edition for which this cmdlet gets capabilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceObjectiveName</maml:name> <maml:description> <maml:para>Specifies the name of the service objective for which this cmdlet gets capabilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>LocationName</maml:name> <maml:description> <maml:para>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/).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerVersionName</maml:name> <maml:description> <maml:para>Specifies the name of the server version for which this cmdlet gets capabilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>EditionName</maml:name> <maml:description> <maml:para>Specifies the name of the database edition for which this cmdlet gets capabilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceObjectiveName</maml:name> <maml:description> <maml:para>Specifies the name of the service objective for which this cmdlet gets capabilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Defaults</maml:name> <maml:description> <maml:para>Indicates that this cmdlet gets only defaults.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Location_Capabilities.Model.LocationCapabilityModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get capabilities for the current subscription for a region --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlCapability -LocationName "Central US"</dev:code> <dev:remarks> <maml:para>This command returns the capabilities for SQL Database on the current subscription for the Central US region.</maml:para> <maml:para /> <maml:para /> <maml:para>Location : Central US Status : Available SupportedServerVersions : {12.0, 2.0}</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get default capabilities for the current subscription for a region --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlCapability -LocationName "Central US" -Defaults</dev:code> <dev:remarks> <maml:para>This command returns the default capabilities for SQL Database on the current subscription in the Central US region.</maml:para> <maml:para /> <maml:para /> <maml:para>Location : Central US Status : Available ExpandedDetails : Version: 2.0 (Default) -> Edition: Standard (Default) -> Service Objective: S0 (Default)</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Get details for a service objective --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlCapability -LocationName "Central US" -ServiceObjectiveName "S1"</dev:code> <dev:remarks> <maml:para>This command gets default capabilities for SQL Database for the specified service objective on the current subscription.</maml:para> <maml:para /> <maml:para /> <maml:para>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)</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database Cmdlets</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabase</command:name> <maml:description> <maml:para>Gets one or more Azure SQL databases.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmSqlDatabase cmdlet gets one or more Azure SQL databases from an Azure SQL Database Server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabase</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server the database is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server the database is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get all databases on a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command gets all databases on the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : master Location : Central US DatabaseId : a2a7f2db-7526-4d86-a7b2-36276ee10dc6 Edition : None CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 5368709120 Status : Online CreationDate : 7/3/2015 7:32:44 AM CurrentServiceObjectiveId : c99ac918-dbea-463f-a475-16ec020fdc12 CurrentServiceObjectiveName : System1 RequestedServiceObjectiveId : c99ac918-dbea-463f-a475-16ec020fdc12 RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : Tags : ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 Edition : Standard CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 268435456000 Status : Online CreationDate : 7/3/2015 7:33:37 AM CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b CurrentServiceObjectiveName : S0 RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : Tags :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get a database by name on a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command gets a database named Database02 from a server named Server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 Edition : Standard CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 268435456000 Status : Online CreationDate : 7/3/2015 7:33:37 AM CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b CurrentServiceObjectiveName : S0 RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : Tags :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseActivity</command:name> <maml:description> <maml:para>Gets the status of moving elastic databases.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseActivity</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmSqlDatabaseActivity cmdlet gets the status of moving elastic databases into or out of an elastic database pool in Azure SQL Database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseActivity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the SQL Server that hosts the elastic database pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic database pool for which this cmdlet gets status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet gets status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Specifies the ID of the operation that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Guid]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database for which this cmdlet gets status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the SQL Server that hosts the elastic database pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic database pool for which this cmdlet gets status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet gets status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Specifies the ID of the operation that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Guid]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Guid]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database for which this cmdlet gets status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseActivityModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get status for all SQL Database instances --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseActivity -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticPool01"</dev:code> <dev:remarks> <maml:para>This command returns the operation status of all SQL Database instances in an elastic pool named elasticPool01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseAuditingPolicy</command:name> <maml:description> <maml:para>Gets the auditing policy of an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseAuditingPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseAuditingPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get the auditing policy of an Azure SQL database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command gets the auditing policy of database database01 located in server01 in resource group resourcegroup01.</maml:para> <maml:para /> <maml:para /> <maml:para>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</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabaseAuditing</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseDataMaskingPolicy</command:name> <maml:description> <maml:para>Gets the data masking policy for an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseDataMaskingPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseDataMaskingPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get the data masking policy for an Azure SQL database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseDataMaskingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command gets the data masking policy from database database01 in resource group resourcegroup01 contained in server server01.</maml:para> <maml:para /> <maml:para /> <maml:para>DatabaseName : database01 ResourceGroupName : resourcegroup01 ServerName : server01 DataMaskingState : Uninitialized PrivilegedUsers :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseDataMaskingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseDataMaskingRule</command:name> <maml:description> <maml:para>Gets the data masking rules from an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseDataMaskingRule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseDataMaskingRule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RuleId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RuleId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get all data masking rules from a database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command gets all data masking rules from database01 in resource group resourcegroup01 contained in server server01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseDataMaskingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseDataMaskingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseExpanded</command:name> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseExpanded</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseExpanded</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseIndexRecommendations</command:name> <maml:description> <maml:para>Gets the recommended index operations for a server or database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseIndexRecommendations</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmSqlDatabaseIndexRecommendations cmdlet gets the recommended index operations for a server or database in Azure SQL Database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseIndexRecommendations</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the server that hosts the database for which this cmdlet gets index recommendations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet gets the index recommendations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure SQL Table.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IndexRecommendationName</maml:name> <maml:description> <maml:para>Specifies the name of the index recommendation that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server. This cmdlet gets index recommendations for a database that this server hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the server that hosts the database for which this cmdlet gets index recommendations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet gets the index recommendations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure SQL Table.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IndexRecommendationName</maml:name> <maml:description> <maml:para>Specifies the name of the index recommendation that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server. This cmdlet gets index recommendations for a database that this server hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get index recommendations for all databases on server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseIndexRecommendations -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command returns index recommendations for all databases on server.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get index recommendations for a specific database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseIndexRecommendations -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command returns index recommendations for specific database.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Get a single index recommendation by name --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseIndexRecommendations -ResourceGroupName "resourcegroup01" -ServerName "server01" -DtabaseName "database01" -IndexRecommendationName "INDEX_NAME"</dev:code> <dev:remarks> <maml:para>This command returns single index recommendation by name.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AzureRmSqlDatabaseExecuteIndexRecommendation</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureRmSqlDatabaseExecuteIndexRecommendation</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseReplicationLink</command:name> <maml:description> <maml:para>Gets the geo-replication links between an Azure SQL Database and the specified Azure Resource Group or Azure SQL Server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseReplicationLink</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet replaces the Get-AzureSqlDatabaseCopy cmdlet. It will return all geo-replication links between the specified Azure Resource Group or Azure SQL Server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseReplicationLink</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database to retrieve links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PartnerResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group for the partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server for the database to retrieve links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group for the database to retrieve links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseReplicationLink</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database to retrieve links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PartnerResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group for the partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PartnerServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server for the partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server for the database to retrieve links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group for the database to retrieve links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database to retrieve links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PartnerResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group for the partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server for the database to retrieve links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group for the database to retrieve links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PartnerServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server for the partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseRestorePoints</command:name> <maml:description> <maml:para /> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseRestorePoints</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseRestorePoints</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL Server holding the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group of the Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL Server holding the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group of the Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseRestorePoints -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>Returns all available restore points for Azure SQL Database "database01".</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US RestorePointType : CONTINUOUS RestorePointCreationDate : EarliestRestoreDate : 8/12/2015 12:00:00 AM </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseSecureConnectionPolicy</command:name> <maml:description> <maml:para>Gets the secure connection policy of an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseSecureConnectionPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseSecureConnectionPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseSecureConnectionPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get the secure connection policy of an azure_2 SQL database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseSecureConnectionPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command gets the secure connection policy of an Azure SQL database named database01 located in server server01.</maml:para> <maml:para /> <maml:para /> <maml:para>DatabaseName : database01 ConnectionStrings : Microsoft.Azure.Commands.Sql.SecureConnection.Model.ConnectionStrings ResourceGroupName : resourcegroup01 ServerName : server01 ProxyDnsName : server01.database.secure.windows.net ProxyPort : 1433 SecureConnectionState : Optional</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseTransparentDataEncryption</command:name> <maml:description> <maml:para>Gets the TPE state for an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseTransparentDataEncryption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseTransparentDataEncryption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database for which this cmdlet gets TDE status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet gets TDE status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database for which this cmdlet gets TDE status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database for which this cmdlet gets TDE status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet gets TDE status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database for which this cmdlet gets TDE status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get TPE status for a database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseTransparentDataEncryption -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command gets the status of TPE for the database named Database01 on the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName ServerName DatabaseName State ----------------- ---------- ------------ ----- resourcegroup01 server01 database01 Disabled </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseTransparentDataEncryption</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity</command:name> <maml:description> <maml:para>Gets the progress of a TDE scan of an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseTransparentDataEncryptionActivity</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database for which this cmdlet gets TDE encryption activity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet gets TDE encryption activity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database for which this cmdlet gets TDE encryption activity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database for which this cmdlet gets TDE encryption activity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet gets TDE encryption activity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database for which this cmdlet gets TDE encryption activity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionActivityModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get TPE activity for a database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity -ServerName "server01" -ResourceGroupName "resourcegroup01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command gets the TPE activity for the database named database01 on the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Status : Encrypting PercentComplete : 3.662109 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseTransparentDataEncryption</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseTransparentDataEncryption</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlDatabaseUpgradeHint</command:name> <maml:description> <maml:para>Gets pricing tier hints for a database for upgrading SQL Database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlDatabaseUpgradeHint</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlDatabaseUpgradeHint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database for which this cmdlet gets an upgrade hint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExcludeElasticPoolCandidates</maml:name> <maml:description> <maml:para>Indicates whether to exclude databases that are included in elastic database pool recommendations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database for which this cmdlet gets an upgrade hint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database for which this cmdlet gets an upgrade hint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExcludeElasticPoolCandidates</maml:name> <maml:description> <maml:para>Indicates whether to exclude databases that are included in elastic database pool recommendations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database for which this cmdlet gets an upgrade hint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get recommendations for all databases on a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command returns upgrade hints for all databases on server.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get recommendations for specific database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command returns upgrade hint for specific database.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Get recommendation for all databases that are not recommended for an elastic database pool --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlDatabaseUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01" -ExcludeElasticPoolCandidates $True</dev:code> <dev:remarks> <maml:para>This command returns upgrade hints for database that are not included in elastic database pool recommendations.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseExpanded</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPoolRecommendation</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlElasticPool</command:name> <maml:description> <maml:para>Gets elastic pools and their property values in an Azure SQL Database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlElasticPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlElasticPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic pool that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the elastic pool that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the elastic pool that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic pool that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the elastic pool that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the elastic pool that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get all elastic pools --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command gets all elastic pools on the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 Location : Central US CreationDate : 8/26/2015 10:00:17 PM State : Ready Edition : Standard Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 Tags : ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool02 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool02 Location : Central US CreationDate : 8/26/2015 11:00:17 PM State : Ready Edition : Standard Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 Tags : </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get a specific elastic pool --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticPool27"</dev:code> <dev:remarks> <maml:para>This command gets the elastic pool named elasticPool01 on the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 Location : Central US CreationDate : 8/26/2015 10:00:17 PM State : Ready Edition : Standard Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 Tags : </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Get metrics for a Azure SQL Elastic Database Pool --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" | Get-Metrics -TimeGrain 0:5:0</dev:code> <dev:remarks> <maml:para>Returns metrics for an Azure SQL Elastic Database Pool named "elasticpool01".</maml:para> <maml:para /> <maml:para /> <maml:para>DimensionName : DimensionValue : Name : cpu_percent EndTime : 8/27/2015 5:22:25 PM MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} Properties : {} ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 StartTime : 8/27/2015 4:20:00 PM TimeGrain : 00:05:00 Unit : Percent DimensionName : DimensionValue : Name : physical_data_read_percent EndTime : 8/27/2015 5:22:25 PM MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} Properties : {} ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 StartTime : 8/27/2015 4:20:00 PM TimeGrain : 00:05:00 Unit : Percent DimensionName : DimensionValue : Name : log_write_percent EndTime : 8/27/2015 5:22:25 PM MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} Properties : {} ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 StartTime : 8/27/2015 4:20:00 PM TimeGrain : 00:05:00 Unit : Percent DimensionName : DimensionValue : Name : dtu_consumption_percent EndTime : 8/27/2015 5:22:25 PM MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} Properties : {} ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 StartTime : 8/27/2015 4:20:00 PM TimeGrain : 00:05:00 Unit : Percent DimensionName : DimensionValue : Name : storage_percent EndTime : 8/27/2015 5:22:25 PM MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} Properties : {} ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 StartTime : 8/27/2015 4:20:00 PM TimeGrain : 00:05:00 Unit : Percent</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlElasticPoolActivity</command:name> <maml:description> <maml:para>Gets the status of operations on an elastic pool.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlElasticPoolActivity</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlElasticPoolActivity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of an elastic pool. This cmdlet gets status for the pool that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of an elastic pool. This cmdlet gets status for the pool that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolActivityModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get the status of operations for an elastic pool --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlElasticPoolActivity -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01"</dev:code> <dev:remarks> <maml:para>This command gets the status of the operations for the elastic pool named elasticPool01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPoolDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlElasticPoolDatabase</command:name> <maml:description> <maml:para>Gets elastic databases in an elastic pool and their property values.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlElasticPoolDatabase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlElasticPoolDatabase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of an elastic pool. This cmdlet gets databases in the pool that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL Database that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of an elastic pool. This cmdlet gets databases in the pool that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL Database that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get all databases in an elastic pool --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlElasticPoolDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticPool01"</dev:code> <dev:remarks> <maml:para>This command gets all databases in an elastic pool named elasticPool01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPoolActivity</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlElasticPoolRecommendation</command:name> <maml:description> <maml:para>Gets elastic pool recommendations.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlElasticPoolRecommendation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmSqlElasticPoolRecommendation cmdlet gets elastic pool recommendations for a server. These recommendations include the following values: </maml:para> <maml:para>-- 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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlElasticPoolRecommendation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server for which this cmdlet gets recommendations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies name of the resource group that contains the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server for which this cmdlet gets recommendations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies name of the resource group that contains the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get recommendations for a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlElasticPoolRecommendation -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command gets the elastic pool recommendations for the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlServer</command:name> <maml:description> <maml:para>Returns information about Azure SQL Database servers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the servers that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the servers that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get all Azure SQL Servers in a resource group --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlServer –ResourceGroupName "resourcegroup01"</dev:code> <dev:remarks> <maml:para>This command gets information about all the Azure SQL Database servers in the resource group resourcegroup01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 Location : Central US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : ResourceGroupName : resourcegroup01 ServerName : server02 Location : West US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get information about an Azure SQL Database server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command gets information about the Azure SQL Database server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 Location : Central US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Get all Azure SQL Servers in the subscription --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmResourceGroup | Get-AzureRmSqlServer</dev:code> <dev:remarks> <maml:para>This command gets information about all the Azure SQL Database servers in the current subscription.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 Location : Central US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : ResourceGroupName : resourcegroup01 ServerName : server02 Location : West US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : ResourceGroupName : resourcegroup02 ServerName : server03 Location : East US SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlServerActiveDirectoryAdministrator</command:name> <maml:description> <maml:para>Gets information about an Azure AD administrator for SQL Server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlServerActiveDirectoryAdministrator</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmSqlServerActiveDirectoryAdministrator cmdlet gets information about an Azure Active Directory (Azure AD) administrator for an Azure SQL Server in the current subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlServerActiveDirectoryAdministrator</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the SQL Server for which this cmdlet gets information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the SQL Server for which this cmdlet gets information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the SQL Server for which this cmdlet gets information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the SQL Server for which this cmdlet gets information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Gets information about an administrator for a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" </dev:code> <dev:remarks> <maml:para>This command gets information about an Azure AD administrator for a server named Server06 that is associated with resource group named Resourcegroup01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName ServerName DisplayName ObjectId ----------------- ---------- ----------- -------- resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlServerActiveDirectoryAdministrator</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlServerActiveDirectoryAdministrator</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlServerAuditingPolicy</command:name> <maml:description> <maml:para>Gets the auditing policy of an Azure SQL server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlServerAuditingPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlServerAuditingPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL server for which this cmdlet gets an auditing policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the Azure SQL server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL server for which this cmdlet gets an auditing policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the Azure SQL server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get the auditing policy of an Azure SQL server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command gets the auditing policy of the server server02 in resource group resourcegroup01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 StorageAccountName : StorageKeyType : Primary EventType : {PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure...} AuditState : New RetentionInDays : 0 TableIdentifier : Server01 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlServerAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Use-AzureRmSqlServerAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlServerFirewallRule</command:name> <maml:description> <maml:para>Gets firewall rules for an Azure SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlServerFirewallRule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlServerFirewallRule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>FirewallRuleName</maml:name> <maml:description> <maml:para>Specifies the name of the firewall rule that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of a server. This cmdlet gets firewall rules from the server that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of a resource group. This cmdlet gets firewall rules on a server in the resource group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>FirewallRuleName</maml:name> <maml:description> <maml:para>Specifies the name of the firewall rule that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of a server. This cmdlet gets firewall rules from the server that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of a resource group. This cmdlet gets firewall rules on a server in the resource group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get all rules for a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command gets all the firewall rules for the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>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 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlServerServiceObjective</command:name> <maml:description> <maml:para>Gets service objectives for an Azure SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlServerServiceObjective</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmSqlServerServiceObjective cmdlet gets the available service objectives for an Azure SQL Database server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlServerServiceObjective</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ServiceObjectiveName</maml:name> <maml:description> <maml:para>Specifies the name of a service objective for an Azure SQL Database server. Valid values are: Basic, S0, S1, S2, P1, P2, and P3.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure SQL Database server. This cmdlet gets service objectives for the server that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ServiceObjectiveName</maml:name> <maml:description> <maml:para>Specifies the name of a service objective for an Azure SQL Database server. Valid values are: Basic, S0, S1, S2, P1, P2, and P3.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure SQL Database server. This cmdlet gets service objectives for the server that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ServiceObjective.Model.AzureSqlServerServiceObjectiveModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get a service objective --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlServerServiceObjective -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command gets the service objective for the server named server01. The command specifies the database named database01.</maml:para> <maml:para /> <maml:para /> <maml:para> 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</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlServerUpgrade</command:name> <maml:description> <maml:para>Gets the status of an Azure SQL Database server upgrade.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlServerUpgrade</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmSqlServerUpgrade cmdlet gets the status of an Azure SQL Database server upgrade.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlServerUpgrade</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server about which this cmdlet gets upgrade status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server about which this cmdlet gets upgrade status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server about which this cmdlet gets upgrade status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server about which this cmdlet gets upgrade status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get the status of an upgrade --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server01" | Format-List </dev:code> <dev:remarks> <maml:para>This command gets the status of an upgrade request from the server named server01 in resource group named resourcegroup01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 Status : Queued</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AzureRmSqlServerUpgrade</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureRmSqlServerUpgrade</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlServerUpgradeHint</command:name> <maml:description> <maml:para>Gets pricing tier hints for upgrading a SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMSqlServerUpgradeHint</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlServerUpgradeHint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server for which this cmdlet gets an upgrade hint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExcludeElasticPools</maml:name> <maml:description> <maml:para>Indicates whether to exclude databases that are included in elastic database pool recommendations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server for which this cmdlet gets an upgrade hint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server for which this cmdlet gets an upgrade hint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExcludeElasticPools</maml:name> <maml:description> <maml:para>Indicates whether to exclude databases that are included in elastic database pool recommendations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server for which this cmdlet gets an upgrade hint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get combined recommendations --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlServerUpgradeHint -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command gets combined recommendations for all the databases on server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ElasticPools Databases ------------ --------- {} {database01, database02}</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseExpanded</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPoolRecommendation</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSqlServerCommunicationLink</command:name> <maml:description> <maml:para>Gets server communication links and their property values in an Azure SQL Server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmSqlServerCommunicationLink</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSqlServerCommunicationLink</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>LinkName</maml:name> <maml:description> <maml:para>Specifies the name of the server communication link that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the one of the servers that contain the server communication link that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server communication link that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>LinkName</maml:name> <maml:description> <maml:para>Specifies the name of the server communication link that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the one of the servers that contain the server communication link that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server communication link that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerCommunicationLinkModel</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para> Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get all communication links for a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>Gets all server-to-server partnership for Elastic transactions that the specified server is involved in.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get a named communication link for a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" -LinkName "link01"</dev:code> <dev:remarks> <maml:para>Gets the specified server-to-server partnership for Elastic transactions.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmSqlDatabase</command:name> <maml:description> <maml:para>Creates an Azure SQL database or an elastic database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRMSqlDatabase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmSqlDatabase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CollationName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL database collation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CatalogCollation</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL database catalog collation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxSizeBytes</maml:name> <maml:description> <maml:para>Specifies the maximum size of the database in bytes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edition</maml:name> <maml:description> <maml:para>Specifies the edition to assign to the database. Valid values are: -- Default -- None -- Premium -- Basis -- Standard</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DatabaseEdition</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedServiceObjectiveName</maml:name> <maml:description> <maml:para>Specifies the name of the service objective to assign to the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic pool in which to put the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the new server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server to create the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that the server is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CollationName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL database collation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CatalogCollation</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL database catalog collation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxSizeBytes</maml:name> <maml:description> <maml:para>Specifies the maximum size of the database in bytes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edition</maml:name> <maml:description> <maml:para>Specifies the edition to assign to the database. Valid values are: -- Default -- None -- Premium -- Basis -- Standard</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DatabaseEdition</command:parameterValue> <dev:type> <maml:name>DatabaseEdition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedServiceObjectiveName</maml:name> <maml:description> <maml:para>Specifies the name of the service objective to assign to the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic pool in which to put the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the new server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> <dev:type> <maml:name>Dictionary`2[String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server to create the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that the server is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Create an database in a specified server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> New-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command creates a database named database01 in server server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database01 Location : Central US DatabaseId : a1e6bd1a-735a-4d48-8b98-afead5ef1218 Edition : Standard CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 268435456000 Status : Online CreationDate : 7/3/2015 7:33:37 AM CurrentServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b CurrentServiceObjectiveName : S0 RequestedServiceObjectiveId : f1173c43-91bd-4aaa-973c-54e79e15235b RequestedServiceObjectiveName : ElasticPoolName : EarliestRestoreDate : Tags :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Create an elastic database in a specified server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> New-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -ElasticPoolName "elasticpool01"</dev:code> <dev:remarks> <maml:para>This command creates a database named database01 in the elastic pool named elasticpool01 in server server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 DatabaseName : database02 Location : Central US DatabaseId : 7bd9d561-42a7-484e-bf05-62ddef8015ab Edition : Standard CollationName : SQL_Latin1_General_CP1_CI_AS CatalogCollation : MaxSizeBytes : 268435456000 Status : Online CreationDate : 8/26/2015 10:04:29 PM CurrentServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 CurrentServiceObjectiveName : ElasticPool RequestedServiceObjectiveId : d1737d22-a8ea-4de7-9bd0-33395d2a7419 RequestedServiceObjectiveName : ElasticPoolName : elasticpool01 EarliestRestoreDate : Tags :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmSqlDatabaseCopy</command:name> <maml:description> <maml:para>Creates a copy of an existing Azure SQL Database using the snapshot of the data at the time of the call.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRMSqlDatabaseCopy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet replaces the Start-AzureRqlDatabaseCopy cmdlet when used to create a one-time database copy. It returns the database object of the copy.</maml:para> <maml:para>Note: Use New-AzureRmSqlDatabaseSecondary for setting up geo-replication for a database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmSqlDatabaseCopy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database to be copied.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceObjectiveName</maml:name> <maml:description> <maml:para>The name of the service objective to assign to the copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>The name of the Elastic Pool to put the copy in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The tags to associate with the Azure SQL Database copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group to create copy in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server to create copy in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyDatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server the database to be copied is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group the database to be copied is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database to be copied.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceObjectiveName</maml:name> <maml:description> <maml:para>The name of the service objective to assign to the copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>The name of the Elastic Pool to put the copy in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The tags to associate with the Azure SQL Database copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> <dev:type> <maml:name>Dictionary`2[String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group to create copy in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server to create copy in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopyDatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server the database to be copied is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group the database to be copied is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmSqlDatabaseDataMaskingRule</command:name> <maml:description> <maml:para>Creates a data masking rule for an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRMSqlDatabaseDataMaskingRule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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. </maml:para> <maml:para>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. </maml:para> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmSqlDatabaseDataMaskingRule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Specifies the name of the column that is the target of this masking rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SchemaName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table in the database of which the masked column is part.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskingFunction</maml:name> <maml:description> <maml:para>Specifies the masking function that the rule uses. Valid values are: </maml:para> <maml:para>-- Default -- NoMasking -- Text -- Number -- SocialSecurityNumber -- CreditCardNumber -- Email</maml:para> <maml:para>The default value is Default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrefixSize</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReplacementString</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SuffixSize</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NumberFrom</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Double]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NumberTo</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Double]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RuleId</maml:name> <maml:description> <maml:para>Specifies the identifier for the data masking rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Specifies the name of the column that is the target of this masking rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SchemaName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table in the database of which the masked column is part.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskingFunction</maml:name> <maml:description> <maml:para>Specifies the masking function that the rule uses. Valid values are: </maml:para> <maml:para>-- Default -- NoMasking -- Text -- Number -- SocialSecurityNumber -- CreditCardNumber -- Email</maml:para> <maml:para>The default value is Default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrefixSize</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[UInt32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReplacementString</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SuffixSize</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[UInt32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NumberFrom</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Double]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NumberTo</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Double]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RuleId</maml:name> <maml:description> <maml:para>Specifies the identifier for the data masking rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Create a data masking rule for a number column in a database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -RuleId "rule01" -SchemaName "schema01" -TableName "table01" -ColumnName "column01" -MaskingFunction Number -NumberFrom 5 -NumberTo 14</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmSqlDatabaseSecondary</command:name> <maml:description> <maml:para>Creates a new secondary database for an existing Azure SQL Database and starts data replication.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRMSqlDatabaseSecondary</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmSqlDatabaseSecondary</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database to act as primary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryServiceObjectiveName</maml:name> <maml:description> <maml:para>The name of the service objective to assign to the secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryElasticPoolName</maml:name> <maml:description> <maml:para>The name of the Elastic Pool to put the secondary in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The tags to associate with the Azure SQL Database replication link.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PartnerResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group to create secondary in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PartnerServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server to create secondary in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowConnections</maml:name> <maml:description> <maml:para>The read intent of the secondary Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AllowConnections</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server of the primary Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group of the primary Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database to act as primary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryServiceObjectiveName</maml:name> <maml:description> <maml:para>The name of the service objective to assign to the secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SecondaryElasticPoolName</maml:name> <maml:description> <maml:para>The name of the Elastic Pool to put the secondary in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The tags to associate with the Azure SQL Database replication link.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> <dev:type> <maml:name>Dictionary`2[String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PartnerResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group to create secondary in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PartnerServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server to create secondary in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowConnections</maml:name> <maml:description> <maml:para>The read intent of the secondary Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AllowConnections</command:parameterValue> <dev:type> <maml:name>AllowConnections</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server of the primary Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group of the primary Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmSqlElasticPool</command:name> <maml:description> <maml:para>Creates an elastic database pool in Azure SQL Database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRMSqlElasticPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmSqlElasticPool cmdlet creates an elastic database pool in Azure SQL Database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmSqlElasticPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic pool that this cmdlet creates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edition</maml:name> <maml:description> <maml:para>Specifies the edition of Azure SQL Database for the elastic pool. Valid values are: </maml:para> <maml:para>-- Premium -- Basic -- Standard</maml:para> <maml:para>For the current preview, the edition must be Standard.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DatabaseEdition</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Dtu</maml:name> <maml:description> <maml:para>Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are as follows: </maml:para> <maml:para>-- Basic. 100 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageMB</maml:name> <maml:description> <maml:para>Specifies the storage limit, in megabytes, for the elastic pool. You cannot specify a value for this parameter for the Premium edition. </maml:para> <maml:para>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.</maml:para> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseDtuMin</maml:name> <maml:description> <maml:para>Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. The default value is zero (0).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseDtuMax</maml:name> <maml:description> <maml:para>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: </maml:para> <maml:para>-- Basic. 5 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the elastic pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server in which this cmdlet creates the elastic pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the elastic pool that this cmdlet creates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic pool that this cmdlet creates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edition</maml:name> <maml:description> <maml:para>Specifies the edition of Azure SQL Database for the elastic pool. Valid values are: </maml:para> <maml:para>-- Premium -- Basic -- Standard</maml:para> <maml:para>For the current preview, the edition must be Standard.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DatabaseEdition</command:parameterValue> <dev:type> <maml:name>DatabaseEdition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Dtu</maml:name> <maml:description> <maml:para>Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are as follows: </maml:para> <maml:para>-- Basic. 100 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageMB</maml:name> <maml:description> <maml:para>Specifies the storage limit, in megabytes, for the elastic pool. You cannot specify a value for this parameter for the Premium edition. </maml:para> <maml:para>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.</maml:para> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseDtuMin</maml:name> <maml:description> <maml:para>Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. The default value is zero (0).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseDtuMax</maml:name> <maml:description> <maml:para>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: </maml:para> <maml:para>-- Basic. 5 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the elastic pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> <dev:type> <maml:name>Dictionary`2[String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server in which this cmdlet creates the elastic pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the elastic pool that this cmdlet creates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Create an elastic pool --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> New-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" -Edition "Standard" -Dtu 400 -DatabaseDtuMin 10 -DatabaseDtuMax 100</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 Location : Central US CreationDate : 8/26/2015 10:00:17 PM State : Ready Edition : Standard Dtu : 400 DatabaseDtuMax : 100 DatabaseDtuMin : 10 StorageMB : 409600 Tags : </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPoolActivity</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPoolDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmSqlServer</command:name> <maml:description> <maml:para>Creates an Azure SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRMSqlServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmSqlServer cmdlet creates an Azure SQL Database server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmSqlServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the new server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SqlAdministratorCredentials</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location of the data center where this cmdlet creates the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the new server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerVersion</maml:name> <maml:description> <maml:para>Specifies the version of the new server. Valid values are: 2.0 and 12.0.</maml:para> <maml:para>Specify 2.0 to create a version 11 server, or 12.0 to create a version 12 server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group in which this cmdlet creates the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the new server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SqlAdministratorCredentials</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location of the data center where this cmdlet creates the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the new server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> <dev:type> <maml:name>Dictionary`2[String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerVersion</maml:name> <maml:description> <maml:para>Specifies the version of the new server. Valid values are: 2.0 and 12.0.</maml:para> <maml:para>Specify 2.0 to create a version 11 server, or 12.0 to create a version 12 server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group in which this cmdlet creates the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Create a new Azure SQL Database server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> New-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -Location "Central US" -ServerName "server01" -ServerVersion "12.0"</dev:code> <dev:remarks> <maml:para>This command creates a version 12 Azure SQL Database server.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 Location : Australia East SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags : </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmSqlServerFirewallRule</command:name> <maml:description> <maml:para>Creates a firewall rule for an Azure SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRMSqlServerFirewallRule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmSqlServerFirewallRule cmdlet creates a firewall rule for the specified Azure SQL Database server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmSqlServerFirewallRule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowAllAzureIPs</maml:name> <maml:description> <maml:para>Indicates that this firewall rule enables all Azure IP addresses to access the server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmSqlServerFirewallRule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirewallRuleName</maml:name> <maml:description> <maml:para>Specifies the name of the new firewall rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartIpAddress</maml:name> <maml:description> <maml:para>Specifies the start value of the IP address range for the firewall rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndIpAddress</maml:name> <maml:description> <maml:para>Specifies the end value of the IP address range for this rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirewallRuleName</maml:name> <maml:description> <maml:para>Specifies the name of the new firewall rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartIpAddress</maml:name> <maml:description> <maml:para>Specifies the start value of the IP address range for the firewall rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndIpAddress</maml:name> <maml:description> <maml:para>Specifies the end value of the IP address range for this rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowAllAzureIPs</maml:name> <maml:description> <maml:para>Indicates that this firewall rule enables all Azure IP addresses to access the server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Create a firewall rule --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> New-AzureRmSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -FirewallRuleName "rule01" -StartIpAddress "192.168.0.198" -EndIpAddress "192.168.0.199"</dev:code> <dev:remarks> <maml:para>This command creates a firewall rule named rule01 on the server named server01. The rule includes the specified start and end IP addresses.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 StartIpAddress : 192.168.0.198 EndIpAddress : 192.168.0.199 FirewallRuleName : rule01</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmSqlServerCommunicationLink</command:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRmSqlServerCommunicationLink</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmSqlServerCommunicationLink</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LinkName</maml:name> <maml:description> <maml:para>Specifies the name of the server communication link that this cmdlet creates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PartnerServer</maml:name> <maml:description> <maml:para>Specifies the name of the other server taking part in this partnership.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server to set up the partnership on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group the server named in the 'ServerName' parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LinkName</maml:name> <maml:description> <maml:para>Specifies the name of the server communication link that this cmdlet creates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PartnerServer</maml:name> <maml:description> <maml:para>Specifies the name of the other server taking part in this partnership.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server to set up the partnership on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group the server named in the 'ServerName' parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerCommunicationLinkModel</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para> Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Create a new Azure SQL Server communication link --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> New-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" -LinkName "link01" -PartnerServer "server02"</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmSqlDatabase</command:name> <maml:description> <maml:para>Removes an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRMSqlDatabase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmSqlDatabase cmdlet removes an Azure SQL database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmSqlDatabase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that this cmdlet removes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server the database is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that this cmdlet removes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server the database is in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Remove a database from an Azure SQL server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Remove-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command removes the database named database01 from server server01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmSqlDatabaseAuditing</command:name> <maml:description> <maml:para>Removes auditing of an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRMSqlDatabaseAuditing</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmSqlDatabaseAuditing</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Remove the auditing of an Azure SQL database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Remove-AzureRmSqlDatabaseAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command removes the auditing of database named database01. That database is located on server01 in the resource group named resourcegroup01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmSqlDatabaseDataMaskingRule</command:name> <maml:description> <maml:para>Removes a data masking rule from an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRMSqlDatabaseDataMaskingRule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmSqlDatabaseDataMaskingRule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RuleId</maml:name> <maml:description> <maml:para>Specifies the identifier for the data masking rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RuleId</maml:name> <maml:description> <maml:para>Specifies the identifier for the data masking rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Remove a database data masking rule --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Remove-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -RuleId "rule01"</dev:code> <dev:remarks> <maml:para>This command removes the rule that has the ID rule01, that was defined for the database database01 located in server01 in resource group resourcegroup01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmSqlDatabaseSecondary</command:name> <maml:description> <maml:para>Terminates data replication between an Azure SQL Database and the specified secondary database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRMSqlDatabaseSecondary</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet replaces the Stop-AzureSqlDatabaseCopy cmdlet. It will force terminates the geo-replication link. There is no replication synchronization prior to termination.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmSqlDatabaseSecondary</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the primary Azure SQL Database with the replication link to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PartnerResourceGroupName</maml:name> <maml:description> <maml:para>The name of the partner Azure Resource Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PartnerServerName</maml:name> <maml:description> <maml:para>The name of the partner Azure SQL Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server with the replication link to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group with the replication link to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the primary Azure SQL Database with the replication link to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PartnerResourceGroupName</maml:name> <maml:description> <maml:para>The name of the partner Azure Resource Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PartnerServerName</maml:name> <maml:description> <maml:para>The name of the partner Azure SQL Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server with the replication link to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group with the replication link to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmSqlElasticPool</command:name> <maml:description> <maml:para>Deletes an elastic database pool.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRMSqlElasticPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmSqlElasticPool cmdlet deletes an elastic pool in Azure SQL Database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmSqlElasticPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic pool that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the elastic pool that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the elastic pool that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic pool that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the elastic pool that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the elastic pool that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Delete an elastic pool --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Remove-AzureRmSqlElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01"</dev:code> <dev:remarks> <maml:para>This command deletes an elastic pool named elasticpool01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPoolActivity</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPoolDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmSqlServer</command:name> <maml:description> <maml:para>Removes an Azure SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRMSqlServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmSqlServer cmdlet removes an Azure SQL Database server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmSqlServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that this cmdlet removes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server that this cmdlet removes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that this cmdlet removes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server that this cmdlet removes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Remove a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Remove-AzureRmSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command removes the Azure SQL Database server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlServer</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmSqlServerActiveDirectoryAdministrator</command:name> <maml:description> <maml:para>Removes an Azure AD administrator for SQL Server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRMSqlServerActiveDirectoryAdministrator</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmSqlServerActiveDirectoryAdministrator cmdlet removes an Azure Active Directory (Azure AD) administrator for Azure SQL Server in the current subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmSqlServerActiveDirectoryAdministrator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the SQL Server for which this cmdlet removes an administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the SQL Server for which this cmdlet removes an administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the SQL Server for which this cmdlet removes an administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the SQL Server for which this cmdlet removes an administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Remove an administrator --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Remove-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" </dev:code> <dev:remarks> <maml:para>Removes the Azure AD administrator for the server named server01 that is associated with resource group resourcegroup01.</maml:para> <maml:para /> <maml:para /> <maml:para>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</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServerActiveDirectoryAdministrator</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlServerActiveDirectoryAdministrator</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmSqlServerAuditing</command:name> <maml:description> <maml:para>Removes auditing of an Azure SQL server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRMSqlServerAuditing</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmSqlServerAuditing</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group of the Azure SQL server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure SQL server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group of the Azure SQL server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Remove the auditing of an Azure SQL server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Remove-AzureRmSqlDatabaseAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command removes the auditing of all the databases located in server01 in resource group resourcegroup01 that use the policy of that server.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmSqlServerFirewallRule</command:name> <maml:description> <maml:para>Deletes a firewall rule from an Azure SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRMSqlServerFirewallRule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmSqlServerFirewallRule cmdlet deletes a firewall rule from the specified Azure SQL Database server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmSqlServerFirewallRule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>FirewallRuleName</maml:name> <maml:description> <maml:para>Specifies the name of the firewall rule that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of a server. This cmdlet deletes a firewall rule from the server that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of a resource group. This cmdlet deletes a firewall rule on a server in the resource group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>FirewallRuleName</maml:name> <maml:description> <maml:para>Specifies the name of the firewall rule that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of a server. This cmdlet deletes a firewall rule from the server that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of a resource group. This cmdlet deletes a firewall rule on a server in the resource group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Delete a rule --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Remove-AzureRmSqlServerFirewallRule -FirewallRuleName "rule01" -ResourceGroupName "resourcegroup01" -ServerName "server01"</dev:code> <dev:remarks> <maml:para>This command deletes a firewall rule named rule01 on the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmSqlServerCommunicationLink</command:name> <maml:description> <maml:para>Deletes an Azure SQL Server communication link.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRmSqlServerCommunicationLink</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmSqlServerCommunicationLink cmdlet deletes an existing server-to-server partnership for Elastic transactions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmSqlServerCommunicationLink</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>LinkName</maml:name> <maml:description> <maml:para>Specifies the name of the server communication link that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the server communication link that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server communication link that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>LinkName</maml:name> <maml:description> <maml:para>Specifies the name of the server communication link that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the server communication link that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server communication link that this cmdlet deletes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerCommunicationLinkModel</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para> Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Delete a server communication link --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Remove-AzureRmSqlServerCommunicationLink -ResourceGroupName "resourcegroup01" -ServerName "server01" -LinkName "link01"</dev:code> <dev:remarks> <maml:para>Deletes an existing server-to-server partnership for Elastic transactions.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Resume-AzureRmSqlDatabase</command:name> <maml:description> <maml:para>Resumes an Azure SQL Data Warehouse database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resume</command:verb> <command:noun>AzureRMSqlDatabase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Resume-AzureRmSqlDatabase cmdlet resumes an Azure SQL Data Warehouse database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-AzureRmSqlDatabase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database that this cmdlet resumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that this cmdlet resumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database that this cmdlet resumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database that this cmdlet resumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that this cmdlet resumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database that this cmdlet resumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>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.</maml:para> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Resumes an Azure SQL Data Warehouse database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Resume-AzureSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command resumes a suspended Azure SQL Data Warehouse database.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlDatabase</command:name> <maml:description> <maml:para>Sets properties for an Azure SQL database, or moves an existing database into an elastic pool.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlDatabase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlDatabase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxSizeBytes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edition</maml:name> <maml:description> <maml:para>Specifies the edition for the database. Valid values are: -- Default -- None -- Premium -- Basic -- Standard</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DatabaseEdition</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedServiceObjectiveName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies name of the elastic pool in which to put the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the new server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of resource group of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxSizeBytes</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edition</maml:name> <maml:description> <maml:para>Specifies the edition for the database. Valid values are: -- Default -- None -- Premium -- Basic -- Standard</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DatabaseEdition</command:parameterValue> <dev:type> <maml:name>DatabaseEdition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedServiceObjectiveName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies name of the elastic pool in which to put the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the new server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> <dev:type> <maml:name>Dictionary`2[String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of resource group of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Update a database to a Standard S2 database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ServerName "server01" -Edition "Standard" -RequestedServiceObjectiveName "S2"</dev:code> <dev:remarks> <maml:para>This command updates a database named database01 to a Standard S2 database in a server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>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 : </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Add a database to an elastic pool --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlDatabase -ResourceGroupName "resourcegroup01" -DatabaseName "database01" -ServerName "server01" -ElasticPoolName "elasticpool01"</dev:code> <dev:remarks> <maml:para>The following command adds a database named database01 to the elastic pool named elasticpool01 in the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>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 :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlDatabaseAuditingPolicy</command:name> <maml:description> <maml:para>Sets the auditing policy for an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlDatabaseAuditingPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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. </maml:para> <maml:para>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. </maml:para> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlDatabaseAuditingPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>EventType</maml:name> <maml:description> <maml:para>Specifies the event types to audit. Valid values are: </maml:para> <maml:para>-- PlainSQL_Success -- PlainSQL_Failure -- ParameterizedSQL_Success -- ParameterizedSQL_Failure -- StoredProcedure_Success -- StoredProcedure_Failure -- Login_Success -- Login_Failure -- TransactionManagement_Success -- TransactionManagement_Failure -- All -- None</maml:para> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageKeyType</maml:name> <maml:description> <maml:para>Specifies which of the storage access keys to use. Valid values are: </maml:para> <maml:para>-- Primary -- Secondary</maml:para> <maml:para>The default value is Primary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RetentionInDays</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TableIdentifier</maml:name> <maml:description> <maml:para>Specifies the name of the audit logs table. Specify this value if you specify a value greater than zero for the RetentionInDays parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ThreatDetectionState</maml:name> <maml:description> <maml:para>Defines if threat detection is enabled or disabled for this database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NotificationRecipientsEmail</maml:name> <maml:description> <maml:para>A semicolon separated list of email addresses to send the alerts to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>EmailAdmins</maml:name> <maml:description> <maml:para>Defines whether to email service and co-administrators.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExcludedDetectionTypes</maml:name> <maml:description> <maml:para>A semicolon separated list of detection types to filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>EventType</maml:name> <maml:description> <maml:para>Specifies the event types to audit. Valid values are: </maml:para> <maml:para>-- PlainSQL_Success -- PlainSQL_Failure -- ParameterizedSQL_Success -- ParameterizedSQL_Failure -- StoredProcedure_Success -- StoredProcedure_Failure -- Login_Success -- Login_Failure -- TransactionManagement_Success -- TransactionManagement_Failure -- All -- None</maml:para> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageKeyType</maml:name> <maml:description> <maml:para>Specifies which of the storage access keys to use. Valid values are: </maml:para> <maml:para>-- Primary -- Secondary</maml:para> <maml:para>The default value is Primary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RetentionInDays</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[UInt32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TableIdentifier</maml:name> <maml:description> <maml:para>Specifies the name of the audit logs table. Specify this value if you specify a value greater than zero for the RetentionInDays parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Set the auditing policy of a database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -StorageAccountName "Storage31"</dev:code> <dev:remarks> <maml:para>This command sets the auditing policy of database named database01 located in server01 to use the storage account named Storage31.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Set the storage account key of an existing auditing policy of a database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -StorageAccountKey Secondary</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Set the auditing policy of a database to use a specific event type --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -EventType Login_Failure</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabaseAuditing</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlDatabaseDataMaskingPolicy</command:name> <maml:description> <maml:para>Sets data masking for an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlDatabaseDataMaskingPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlDatabaseDataMaskingPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrivilegedLogins</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrivilegedUsers</maml:name> <maml:description> <maml:para>Specifies a semicolon separated list of privileged user ids that can view the masking data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DataMaskingState</maml:name> <maml:description> <maml:para>Specifies whether data masking operation is enabled or disabled. Valid values are: -- Enabled -- Disabled</maml:para> <maml:para>The default value is Enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrivilegedLogins</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrivilegedUsers</maml:name> <maml:description> <maml:para>Specifies a semicolon separated list of privileged user ids that can view the masking data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DataMaskingState</maml:name> <maml:description> <maml:para>Specifies whether data masking operation is enabled or disabled. Valid values are: -- Enabled -- Disabled</maml:para> <maml:para>The default value is Enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group containing the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Set the data masking policy for a database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlDatabaseDataMaskingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command sets the data masking policy from database named database01 on the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseDataMaskingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlDatabaseDataMaskingRule</command:name> <maml:description> <maml:para>Sets the properties of a data masking rule in an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlDatabaseDataMaskingRule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlDatabaseDataMaskingRule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Specifies the name of the column that is the target of this masking rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table in the database of which the masked column is part.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SchemaName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskingFunction</maml:name> <maml:description> <maml:para>Specifies the masking function that the rule uses. Valid values are: </maml:para> <maml:para>-- Default -- NoMasking -- Text -- Number -- SocialSecurityNumber -- CreditCardNumber -- Email</maml:para> <maml:para>The default value is Default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrefixSize</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReplacementString</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SuffixSize</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NumberFrom</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Double]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NumberTo</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Double]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RuleId</maml:name> <maml:description> <maml:para>Specifies the identifier for the data masking rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Specifies the name of the column that is the target of this masking rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table in the database of which the masked column is part.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SchemaName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskingFunction</maml:name> <maml:description> <maml:para>Specifies the masking function that the rule uses. Valid values are: </maml:para> <maml:para>-- Default -- NoMasking -- Text -- Number -- SocialSecurityNumber -- CreditCardNumber -- Email</maml:para> <maml:para>The default value is Default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrefixSize</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[UInt32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReplacementString</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SuffixSize</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[UInt32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NumberFrom</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Double]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NumberTo</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Double]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RuleId</maml:name> <maml:description> <maml:para>Specifies the identifier for the data masking rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Change the range of a data masking rule in a database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -RuleId "Rule17" -NumberFrom 23 -NumberTo 42</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabaseDataMaskingRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlDatabaseSecondary</command:name> <maml:description> <maml:para>Switches a secondary Azure SQL Database to the primary in order to failover.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlDatabaseSecondary</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlDatabaseSecondary</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database Secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PartnerResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group of the partner Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Failover</maml:name> <maml:description> <maml:para>Determines if this operation is a failover.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowDataLoss</maml:name> <maml:description> <maml:para>Determines if this failover operation will allow data loss.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server of the Azure SQL Database Secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group of the Azure SQL Database Secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRmSqlDatabaseSecondary</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database Secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PartnerResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group of the partner Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server of the Azure SQL Database Secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group of the Azure SQL Database Secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Database Secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PartnerResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group of the partner Azure SQL Database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>The name of the Azure SQL Server of the Azure SQL Database Secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group of the Azure SQL Database Secondary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Failover</maml:name> <maml:description> <maml:para>Determines if this operation is a failover.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowDataLoss</maml:name> <maml:description> <maml:para>Determines if this failover operation will allow data loss.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlDatabaseTransparentDataEncryption</command:name> <maml:description> <maml:para>Modifies TPE for an Azure SQL database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlDatabaseTransparentDataEncryption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlDatabaseTransparentDataEncryption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the value of the TDE property. Valid values are: </maml:para> <maml:para>-- Enabled -- Disabled</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">TransparentDataEncryptionStateType</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the value of the TDE property. Valid values are: </maml:para> <maml:para>-- Enabled -- Disabled</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">TransparentDataEncryptionStateType</command:parameterValue> <dev:type> <maml:name>TransparentDataEncryptionStateType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.TransparentDataEncryption.Model.AzureSqlDatabaseTransparentDataEncryptionModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Enable TPE for a database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlDatabaseTransparentDataEncryption -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -State Enabled</dev:code> <dev:remarks> <maml:para>This command enables TPE for the database named database01 on the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName ServerName DatabaseName State ----------------- ---------- ------------ ----- resourcegroup01 server01 database01 Enabled </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseTransparentDataEncryption</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlElasticPool</command:name> <maml:description> <maml:para>Modifies properties for an elastic database pool in Azure SQL Database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlElasticPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlElasticPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic pool that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edition</maml:name> <maml:description> <maml:para>Specifies the edition of Azure SQL Database for the elastic pool. You cannot change the edition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DatabaseEdition</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Dtu</maml:name> <maml:description> <maml:para>Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are as follows: </maml:para> <maml:para>-- Basic. 100 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageMB</maml:name> <maml:description> <maml:para>Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the New-AzureRmSqlElasticPool cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseDtuMin</maml:name> <maml:description> <maml:para>Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. The default value is zero (0).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseDtuMax</maml:name> <maml:description> <maml:para>Specifies the maximum number of DTUs that any single database in the pool can consume. The default values for different editions are as follows: </maml:para> <maml:para>-- Basic. 5 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the elastic pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the elastic pool that this cmdlet updates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the elastic pool that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ElasticPoolName</maml:name> <maml:description> <maml:para>Specifies the name of the elastic pool that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edition</maml:name> <maml:description> <maml:para>Specifies the edition of Azure SQL Database for the elastic pool. You cannot change the edition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DatabaseEdition</command:parameterValue> <dev:type> <maml:name>DatabaseEdition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Dtu</maml:name> <maml:description> <maml:para>Specifies the total number of shared DTUs for the elastic pool. The default values for different editions are as follows: </maml:para> <maml:para>-- Basic. 100 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageMB</maml:name> <maml:description> <maml:para>Specifies the storage limit, in megabytes, for the elastic pool. For more information, see the New-AzureRmSqlElasticPool cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseDtuMin</maml:name> <maml:description> <maml:para>Specifies the minimum number of DTUs that the elastic pool guarantees to all the databases in the pool. The default value is zero (0).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseDtuMax</maml:name> <maml:description> <maml:para>Specifies the maximum number of DTUs that any single database in the pool can consume. The default values for different editions are as follows: </maml:para> <maml:para>-- Basic. 5 DTUs -- Standard. 100 DTUs -- Premium. 125 DTUs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the elastic pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> <dev:type> <maml:name>Dictionary`2[String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the elastic pool that this cmdlet updates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the elastic pool that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ElasticPool.Model.AzureSqlElasticPoolModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Modify properties for an elastic pool --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlDatabaseElasticPool -ResourceGroupName "resourcegroup01" -ServerName "server01" -ElasticPoolName "elasticpool01" -Dtu 1000 -DatabaseDtuMax 100 -DatabaseDtuMin 20</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceId : /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/resourcegroup01/providers/Microsoft.Sql/servers/server01/elasticPools/elasticpool01 ResourceGroupName : resourcegroup01 ServerName : server01 ElasticPoolName : elasticpool01 Location : Central US CreationDate : 8/26/2015 10:00:17 PM State : Ready Edition : Standard Dtu : 200 DatabaseDtuMax : 100 DatabaseDtuMin : 20 StorageMB : 204800 Tags : </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPoolActivity</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlElasticPoolDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlElasticPool</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlServer</command:name> <maml:description> <maml:para>Modifies properties of an Azure SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureRmSqlServer cmdlet modifies properties of an Azure SQL Database server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SqlAdministratorPassword</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerVersion</maml:name> <maml:description> <maml:para>Specifies the version to which this cmdlet changes the server. Valid values are: 2.0 and 12.0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SqlAdministratorPassword</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies a dictionary of tags that this cmdlet associates with the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Dictionary`2[String]</command:parameterValue> <dev:type> <maml:name>Dictionary`2[String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerVersion</maml:name> <maml:description> <maml:para>Specifies the version to which this cmdlet changes the server. Valid values are: 2.0 and 12.0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Reset admin password on Azure SQL Server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> $serverPassword = "newpassword" PS C:\> $secureString = ConvertTo-SecureString $serverPassword -AsPlainText -Force PS C:\> Set-AzureSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01" -SqlAdministratorPassword $secureString</dev:code> <dev:remarks> <maml:para>Resets the admin password to "newpassword" on Azure SQL Server "server01".</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 Location : Australia East SqlAdministratorLogin : adminLogin SqlAdministratorPassword : ServerVersion : 12.0 Tags :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlServerActiveDirectoryAdministrator</command:name> <maml:description> <maml:para>Provisions an Azure AD administrator for SQL Server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlServerActiveDirectoryAdministrator</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureRmSqlServerActiveDirectoryAdministrator cmdlet provisions an Azure Active Directory (Azure AD) administrator for Azure SQL Server in the current subscription.</maml:para> <maml:para>Only one administrator can be provisioned at a time.</maml:para> <maml:para>The following members of Azure AD can be provisioned as an administrator for SQL Server: </maml:para> <maml:para>-- Native members of Azure AD -- Federated members of Azure AD -- Imported members from other Azure AD who are native or federated members -- Azure AD groups created as security groups</maml:para> <maml:para> 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.</maml:para> <maml:para>We recommend that you provision a dedicated Azure AD group as an administrator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlServerActiveDirectoryAdministrator</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the Azure AD administrator that this cmdlet provisions for SQL Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the SQL Server for which this cmdlet provisions an administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the SQL Server for which this cmdlet provisions an administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the Azure AD administrator that this cmdlet provisions for SQL Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the SQL Server for which this cmdlet provisions an administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the SQL Server for which this cmdlet provisions an administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ServerActiveDirectoryAdministrator.Model.AzureSqlServerActiveDirectoryAdministratorModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Provision an administrator group for a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "DBAs" </dev:code> <dev:remarks> <maml:para>This command provisions an Azure AD administrator group DBAs for the server named server01 that is associated with resource group resourcegroup01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName ServerName DisplayName ObjectId ----------------- ---------- ----------- -------- resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Provision an administrator user for a server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "David Chew" </dev:code> <dev:remarks> <maml:para>This command provisions an Azure AD user David Chew as an administrator for the server named server01.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName ServerName DisplayName ObjectId ----------------- ---------- ----------- -------- resourcegroup01 server01 David Chew 11E95548-B179-4FE1-9AF4-ACA49D13ABB9</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Provision an administrator group by specifying its ID --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>Set-AzureRmSqlServerActiveDirectoryAdministrator -ResourceGroupName "resourcegroup01" -ServerName "server01" -DisplayName "DBAs" -ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b" </dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName ServerName DisplayName ObjectId ----------------- ---------- ----------- -------- resourcegroup01 server01 DBAs 40b79501-b343-44ed-9ce7-da4c8cc7353b</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServerActiveDirectoryAdministrator</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlServerActiveDirectoryAdministrator</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlServerAuditingPolicy</command:name> <maml:description> <maml:para>Changes the auditing policy of an Azure SQL server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlServerAuditingPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlServerAuditingPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>EventType</maml:name> <maml:description> <maml:para>Specifies the event types to audit. Valid values are: </maml:para> <maml:para>-- PlainSQL_Success -- PlainSQL_Failure -- ParameterizedSQL_Success -- ParameterizedSQL_Failure -- StoredProcedure_Success -- StoredProcedure_Failure -- Login_Success -- Login_Failure -- TransactionManagement_Success -- TransactionManagement_Failure -- All -- None</maml:para> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageKeyType</maml:name> <maml:description> <maml:para>Specifies which of the storage access keys to use. Valid values are: </maml:para> <maml:para>-- Primary -- Secondary</maml:para> <maml:para>The default value is Primary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RetentionInDays</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TableIdentifier</maml:name> <maml:description> <maml:para>Specifies the name of the audit logs table. Specify this value if you specify a value greater than zero for the RetentionInDays parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>EventType</maml:name> <maml:description> <maml:para>Specifies the event types to audit. Valid values are: </maml:para> <maml:para>-- PlainSQL_Success -- PlainSQL_Failure -- ParameterizedSQL_Success -- ParameterizedSQL_Failure -- StoredProcedure_Success -- StoredProcedure_Failure -- Login_Success -- Login_Failure -- TransactionManagement_Success -- TransactionManagement_Failure -- All -- None</maml:para> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageKeyType</maml:name> <maml:description> <maml:para>Specifies which of the storage access keys to use. Valid values are: </maml:para> <maml:para>-- Primary -- Secondary</maml:para> <maml:para>The default value is Primary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RetentionInDays</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[UInt32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[UInt32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TableIdentifier</maml:name> <maml:description> <maml:para>Specifies the name of the audit logs table. Specify this value if you specify a value greater than zero for the RetentionInDays parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Set the auditing policy of an Azure SQL server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -StorageAccountName "Storage22"</dev:code> <dev:remarks> <maml:para>This command sets the auditing policy of the server named server01 to use storage account named Storage22.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Set the storage account key of an already existing auditing policy of an Azure SQL server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -StorageAccountKey Secondary</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Set the auditing policy of an Azure SQL server to use a specific event type --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01" -EventType Login_Failure</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServerAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Use-AzureRmSqlServerAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmSqlServerFirewallRule</command:name> <maml:description> <maml:para>Modifies a firewall rule in Azure SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMSqlServerFirewallRule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureRmSqlServerFirewallRule cmdlet modifies a firewall rule in Azure SQL Database server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmSqlServerFirewallRule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>FirewallRuleName</maml:name> <maml:description> <maml:para>Specifies the name of the firewall rule that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartIpAddress</maml:name> <maml:description> <maml:para>Specifies the start value of the IP address range for the firewall rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndIpAddress</maml:name> <maml:description> <maml:para>Specifies the end value of the IP address range for this rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of a server. This cmdlet modifies a firewall rule on the server that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of a resource group. This cmdlet modifies a firewall rule on a server in the resource group that this cmdlet specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>FirewallRuleName</maml:name> <maml:description> <maml:para>Specifies the name of the firewall rule that this cmdlet modifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartIpAddress</maml:name> <maml:description> <maml:para>Specifies the start value of the IP address range for the firewall rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndIpAddress</maml:name> <maml:description> <maml:para>Specifies the end value of the IP address range for this rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of a server. This cmdlet modifies a firewall rule on the server that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of a resource group. This cmdlet modifies a firewall rule on a server in the resource group that this cmdlet specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.FirewallRule.Model.AzureSqlServerFirewallRuleModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Modify a firewall rule --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Set-AzureRmSqlServerFirewallRule -ResourceGroupName "resourcegroup01" -ServerName "server01" -FirewallRuleName "rule01" -StartIpAddress "192.168.0.197" -EndIpAddress "192.168.0.199"</dev:code> <dev:remarks> <maml:para>This command modifies a firewall rule named rule01 on the server named server01. The command modifies the start and end IP addresses.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 StartIpAddress : 192.168.0.199 EndIpAddress : 192.168.0.200 FirewallRuleName : rule01</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Azure SQL Database</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlServerFirewallRule</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Start-AzureRmSqlDatabaseExecuteIndexRecommendation</command:name> <maml:description> <maml:para>Starts the workflow that runs a recommended index operation.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>AzureRMSqlDatabaseExecuteIndexRecommendation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-AzureRmSqlDatabaseExecuteIndexRecommendation cmdlet starts the workflow that runs a recommended index operation in Azure SQL Database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AzureRmSqlDatabaseExecuteIndexRecommendation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the server that hosts the database for which this cmdlet starts a workflow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet starts the workflow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IndexRecommendationName</maml:name> <maml:description> <maml:para>Specifies the name of the index recommendation that this cmdlet runs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server. This cmdlet starts a workflow on a database that this server hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the server that hosts the database for which this cmdlet starts a workflow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet starts the workflow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IndexRecommendationName</maml:name> <maml:description> <maml:para>Specifies the name of the index recommendation that this cmdlet runs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server. This cmdlet starts a workflow on a database that this server hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Run an index recommendation --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Start-AzureRmSqlDatabaseExecuteIndexRecommendation -ResourceGroup "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -IndexRecommendationName "INDEX_NAME"</dev:code> <dev:remarks> <maml:para>This command runs index recommendation.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseIndexRecommendations</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureRmSqlDatabaseExecuteIndexRecommendation</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Start-AzureRmSqlServerUpgrade</command:name> <maml:description> <maml:para>Starts the upgrade of an Azure SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>AzureRMSqlServerUpgrade</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AzureRmSqlServerUpgrade</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerVersion</maml:name> <maml:description> <maml:para>Specifies the version to which this cmdlet upgrades the server. Currently, the only valid value is 12.0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleUpgradeAfterUtcDateTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[DateTime]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseCollection</maml:name> <maml:description> <maml:para>Specifies an array of RecommendedDatabaseProperties objects that this cmdlet uses for the server upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RecommendedDatabaseProperties[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ElasticPoolCollection</maml:name> <maml:description> <maml:para>Collection of UpgradeRecommendedElasticPoolProperties objects to be used for the server upgrade. Check the examples on how to construct a sample object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UpgradeRecommendedElasticPoolProperties[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that this cmdlet upgrades.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group in which this cmdlet upgrades a server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerVersion</maml:name> <maml:description> <maml:para>Specifies the version to which this cmdlet upgrades the server. Currently, the only valid value is 12.0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleUpgradeAfterUtcDateTime</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[DateTime]</command:parameterValue> <dev:type> <maml:name>Nullable`1[DateTime]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseCollection</maml:name> <maml:description> <maml:para>Specifies an array of RecommendedDatabaseProperties objects that this cmdlet uses for the server upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">RecommendedDatabaseProperties[]</command:parameterValue> <dev:type> <maml:name>RecommendedDatabaseProperties[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ElasticPoolCollection</maml:name> <maml:description> <maml:para>Collection of UpgradeRecommendedElasticPoolProperties objects to be used for the server upgrade. Check the examples on how to construct a sample object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UpgradeRecommendedElasticPoolProperties[]</command:parameterValue> <dev:type> <maml:name>UpgradeRecommendedElasticPoolProperties[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that this cmdlet upgrades.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group in which this cmdlet upgrades a server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Upgrade a Simple server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Start-AzureRmSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server01" -ServerVersion 12.0</dev:code> <dev:remarks> <maml:para>This command upgrades the server named server01 in resource group named resourcegroup01 to version 12.0. server01 must currently be version 2.0.</maml:para> <maml:para /> <maml:para /> <maml:para>ResourceGroupName : resourcegroup01 ServerName : server01 ServerVersion : 12.0 ScheduleUpgradeAfterUtcDateTime : DatabaseCollection :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Upgrade server by using schedule time and database recommendation --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>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)</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServerUpgrade</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureRmSqlServerUpgrade</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Stop-AzureRmSqlDatabaseExecuteIndexRecommendation</command:name> <maml:description> <maml:para>Stops the workflow that runs a recommended index operation.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureRMSqlDatabaseExecuteIndexRecommendation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Stop-AzureRmSqlDatabaseExecuteIndexRecommendation cmdlet stops the workflow that runs a recommended index operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureRmSqlDatabaseExecuteIndexRecommendation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the server that hosts the database for which this cmdlet stops a workflow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet stops the workflow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IndexRecommendationName</maml:name> <maml:description> <maml:para>Specifies the name of the index recommendation that this cmdlet stops.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server. This cmdlet stops a workflow on a database that this server hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the server that hosts the database for which this cmdlet stops a workflow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database for which this cmdlet stops the workflow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IndexRecommendationName</maml:name> <maml:description> <maml:para>Specifies the name of the index recommendation that this cmdlet stops.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the server. This cmdlet stops a workflow on a database that this server hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Stop running an index recommendation --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Stop-AzureRmSqlDatabaseExecuteIndexRecommendation -ResourceGroup "resourcegroup01" -ServerName "server01" -DatabaseName "database01" -IndexRecommendationName "INDEX_NAME"</dev:code> <dev:remarks> <maml:para>This command stops running the index recommendation.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseIndexRecommendations</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureRmSqlDatabaseExecuteIndexRecommendation</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Stop-AzureRmSqlServerUpgrade</command:name> <maml:description> <maml:para>Stops the upgrade of an Azure SQL Database server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureRMSqlServerUpgrade</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Stop-AzureRmSqlServerUpgrade cmdlet stops the upgrade of an Azure SQL Database server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureRmSqlServerUpgrade</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server for which this cmdlet stops an upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group in which this cmdlet stops the upgrade of a server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server for which this cmdlet stops an upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group in which this cmdlet stops the upgrade of a server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.ServerUpgrade.Model.AzureSqlServerUpgradeModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Stop a server upgrade --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Stop-AzureRmSqlServerUpgrade -ResourceGroupName "resourcegroup01" -ServerName "server02"</dev:code> <dev:remarks> <maml:para>This command stops the request to upgrade the server named server02 in the resource group named resourcegroup01.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServerUpgrade</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureRmSqlServerUpgrade</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Suspend-AzureRmSqlDatabase</command:name> <maml:description> <maml:para>Suspends an Azure SQL Data Warehouse database.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Suspend</command:verb> <command:noun>AzureRMSqlDatabase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Suspend-AzureRmSqlDatabase cmdlet suspends an Azure SQL Data Warehouse database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Suspend-AzureRmSqlDatabase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server which hosts the database that this cmdlet suspends.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that this cmdlet suspends.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server which hosts the database that this cmdlet suspends.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database that this cmdlet suspends.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>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.</maml:para> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Suspends an Azure SQL Data Warehouse database --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Suspend-AzureSqlDatabase -ResourceGroupName "resourcegroup01" -ServerName "server01" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command suspends an active Azure SQL Data Warehouse database.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabase</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Use-AzureRmSqlServerAuditingPolicy</command:name> <maml:description> <maml:para>Specifies that a database uses the auditing policy of its hosting server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Use</command:verb> <command:noun>AzureRMSqlServerAuditingPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Use-AzureRmSqlServerAuditingPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database to use the auditing policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database to use the auditing policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database to use the auditing policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the name of the server that hosts the database to use the auditing policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Specifies the name of the database to use the auditing policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the database to use the auditing policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">azureprofile</command:parameterValue> <dev:type> <maml:name>azureprofile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Sql.Security.Model.DatabaseAuditingPolicyModel</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Define for a database to use the auditing policy of its server --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Use-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server02" -DatabaseName "database01"</dev:code> <dev:remarks> <maml:para>This command specifies that the database named database01 on server01 uses the auditing policy of its server.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlDatabaseAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSqlServerAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlDatabaseAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmSqlServerAuditingPolicy</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |