Update help files.

bashahee · bashahee · commit d4fd33af3753 · 2018-06-13T19:51:39.000+03:00
Update help files.
diff --git a/src/ResourceManager/Sql/Commands.Sql/Auditing/AuditingHelpMessages.cs b/src/ResourceManager/Sql/Commands.Sql/Auditing/AuditingHelpMessages.cs
@@ -10,7 +10,7 @@ This parameter is not required.
 If you do not specify this parameter, the cmdlet uses the storage account that was defined previously as part of the auditing policy.  
 If this is the first time an auditing policy is defined and you do not specify this parameter, the cmdlet fails.";
 
-        public const string AuditStorageAccountSubscriptionIdHelpMessage = "Specifies the id of the storage account subscription";
+        public const string AuditStorageAccountSubscriptionIdHelpMessage = "Specifies storage account subscription id";
 
         public const string StorageKeyTypeHelpMessage = "Specifies which of the storage access keys to use.";
 
diff --git a/src/ResourceManager/Sql/Commands.Sql/Auditing/Cmdlet/AuditingSettings/SetAzureSqlDatabaseAuditing.cs b/src/ResourceManager/Sql/Commands.Sql/Auditing/Cmdlet/AuditingSettings/SetAzureSqlDatabaseAuditing.cs
@@ -61,7 +61,7 @@ public class SetAzureSqlDatabaseAuditing : SqlDatabaseAuditingSettingsCmdletBase
         public string StorageAccountName { get; set; }
 
         /// <summary>
-        /// Gets or sets the id of the storage account subscription to use.
+        /// Gets or sets storage account subscription id.
         /// </summary>
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = AuditingHelpMessages.AuditStorageAccountSubscriptionIdHelpMessage)]
         [ValidateNotNullOrEmpty]
diff --git a/src/ResourceManager/Sql/Commands.Sql/Auditing/Cmdlet/AuditingSettings/SetAzureSqlServerAuditing.cs b/src/ResourceManager/Sql/Commands.Sql/Auditing/Cmdlet/AuditingSettings/SetAzureSqlServerAuditing.cs
@@ -55,7 +55,7 @@ public class SetAzureSqlServerAuditing : SqlServerAuditingSettingsCmdletBase
         public string StorageAccountName { get; set; }
 
         /// <summary>
-        /// Gets or sets the id of the storage account subscription to use.
+        /// Gets or sets storage account subscription id.
         /// </summary>
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = AuditingHelpMessages.AuditStorageAccountSubscriptionIdHelpMessage)]
         [ValidateNotNullOrEmpty]
diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditing.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditing.md
@@ -27,16 +27,17 @@ To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName*
 ### Example 1: Get the auditing settings of an Azure SQL database
 ```
 PS C:\>Get-AzureRmSqlDatabaseAuditing -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"
-DatabaseName           : database01
-AuditAction            : {}
-AuditActionGroup       : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP,
-                          BATCH_COMPLETED_GROUP, ...}
-ResourceGroupName      : resourcegroup01
-ServerName             : server01
-AuditState             : Enabled
-StorageAccountName     : mystorage
-StorageKeyType         : Primary
-RetentionInDays        : 0
+DatabaseName                 : database01
+AuditAction                  : {}
+AuditActionGroup             : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP,
+                                BATCH_COMPLETED_GROUP, ...}
+ResourceGroupName            : resourcegroup01
+ServerName                   : server01
+AuditState                   : Enabled
+StorageAccountName           : mystorage
+StorageKeyType               : Primary
+RetentionInDays              : 0
+StorageAccountSubscriptionId : 7fe3301d-31d3-4668-af5e-211a890ba6e3
 ```
 
 ## PARAMETERS
diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditing.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditing.md
@@ -28,14 +28,15 @@ This cmdlet returns a policy that is used by the Azure SQL databases that are de
 ### Example 1: Get the auditing settings of an Azure SQL server
 ```
 PS C:\>Get-AzureRmSqlServerAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01"
-AuditActionGroup       : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP,
-                          BATCH_COMPLETED_GROUP, ...}
-ResourceGroupName      : resourcegroup01
-ServerName             : server01
-AuditState             : Enabled
-StorageAccountName     : mystorage
-StorageKeyType         : Primary
-RetentionInDays        : 0
+AuditActionGroup             : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP,
+                                BATCH_COMPLETED_GROUP, ...}
+ResourceGroupName            : resourcegroup01
+ServerName                   : server01
+AuditState                   : Enabled
+StorageAccountName           : mystorage
+StorageKeyType               : Primary
+RetentionInDays              : 0
+StorageAccountSubscriptionId : 7fe3301d-31d3-4668-af5e-211a890ba6e3
 ```
 
 ## PARAMETERS
diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditing.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditing.md
@@ -1,4 +1,4 @@
-﻿---
+---
 external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml
 Module Name: AzureRM.Sql
 ms.assetid: F7EF35E3-BC53-43D9-A71E-0B4316260A08
@@ -15,9 +15,10 @@ Changes the auditing settings for an Azure SQL database.
 
 ```
 Set-AzureRmSqlDatabaseAuditing -State <String> [-PassThru] [-AuditActionGroup <AuditActionGroups[]>]
- [-AuditAction <String[]>] [-StorageAccountName <String>] [-StorageKeyType <String>]
- [-RetentionInDays <UInt32>] [-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String>
- [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-AuditAction <String[]>] [-StorageAccountName <String>] [-StorageAccountSubscriptionId <Guid>]
+ [-StorageKeyType <String>] [-RetentionInDays <UInt32>] [-ServerName] <String> [-DatabaseName] <String>
+ [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -44,33 +45,33 @@ PS C:\>Set-AzureRmSqlDatabaseAuditing -State Enabled -ResourceGroupName "Resourc
 PS C:\>Set-AzureRmSqlDatabaseAuditing -State Disabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"
 ```
 
+### Example 3: Enable the auditing policy of an Azure SQL database using a storage account from a different subscription
+```
+PS C:\>Set-AzureRmSqlDatabaseAuditing -State Enabled -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountName "Storage22" -StorageAccountSubscriptionId "7fe3301d-31d3-4668-af5e-211a890ba6e3"
+
 ## PARAMETERS
 
 ### -AuditAction
-The set of audit actions.  
-The supported actions to audit are:  
-SELECT  
-UPDATE  
-INSERT  
-DELETE  
-EXECUTE  
-RECEIVE  
-REFERENCES  
-
+The set of audit actions.
+The supported actions to audit are:
+SELECT
+UPDATE
+INSERT
+DELETE
+EXECUTE
+RECEIVE
+REFERENCES
 The general form for defining an action to be audited is:
 
 [action] ON [object] BY [principal]
 
 Note that [object] in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::[dbname] and SCHEMA::[schemaname] are used, respectively.
 
-For example:  
-SELECT on dbo.myTable by public  
-SELECT on DATABASE::myDatabase by public  
-SELECT on SCHEMA::mySchema by public  
-
-For more information, see https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions.
-
-```yaml
+For example:
+SELECT on dbo.myTable by public
+SELECT on DATABASE::myDatabase by public
+SELECT on SCHEMA::mySchema by public
+For more information, see https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions.```yaml
 Type: String[]
 Parameter Sets: (All)
 Aliases:
@@ -83,16 +84,12 @@ Accept wildcard characters: False
 ```
 
 ### -AuditActionGroup
-The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:  
-  
-"BATCH_COMPLETED_GROUP",  
-"SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP",  
-"FAILED_DATABASE_AUTHENTICATION_GROUP"  
+The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:
 
-This above combination is also the set that is configured by default. These groups cover all SQL statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.
-For more information, see https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups.
-
-```yaml
+"BATCH_COMPLETED_GROUP",
+"SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP",
+"FAILED_DATABASE_AUTHENTICATION_GROUP"
+This above combination is also the set that is configured by default. These groups cover all SQL statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups.```yaml
 Type: AuditActionGroups[]
 Parameter Sets: (All)
 Aliases:
@@ -106,9 +103,7 @@ Accept wildcard characters: False
 ```
 
 ### -DatabaseName
-SQL Database name.
-
-```yaml
+SQL Database name.```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
@@ -121,9 +116,7 @@ Accept wildcard characters: False
 ```
 
 ### -DefaultProfile
-The credentials, account, tenant, and subscription used for communication with azure.
-
-```yaml
+The credentials, account, tenant, and subscription used for communication with azure.```yaml
 Type: IAzureContextContainer
 Parameter Sets: (All)
 Aliases: AzureRmContext, AzureCredential
@@ -136,24 +129,20 @@ Accept wildcard characters: False
 ```
 
 ### -PassThru
-{{Fill PassThru Description}}
-
-```yaml
+{{Fill PassThru Description}}```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
 Aliases:
 
 Required: False
 Position: Named
-Default value: None
+Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -ResourceGroupName
-The name of the resource group.
-
-```yaml
+The name of the resource group.```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
@@ -166,9 +155,7 @@ Accept wildcard characters: False
 ```
 
 ### -RetentionInDays
-The number of retention days for the audit logs.
-
-```yaml
+The number of retention days for the audit logs.```yaml
 Type: UInt32
 Parameter Sets: (All)
 Aliases:
@@ -181,9 +168,7 @@ Accept wildcard characters: False
 ```
 
 ### -ServerName
-SQL Database server name.
-
-```yaml
+SQL Database server name.```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
@@ -196,9 +181,7 @@ Accept wildcard characters: False
 ```
 
 ### -State
-The state of the policy.
-
-```yaml
+The state of the policy.```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
@@ -212,12 +195,10 @@ Accept wildcard characters: False
 ```
 
 ### -StorageAccountName
-The name of the storage account. Wildcard characters are not permitted.  
-This parameter is not required.  
-If you do not specify this parameter, the cmdlet uses the storage account that was defined previously as part of the auditing policy.  
-If this is the first time an auditing policy is defined and you do not specify this parameter, the cmdlet fails.
-
-```yaml
+The name of the storage account. Wildcard characters are not permitted.
+This parameter is not required.
+If you do not specify this parameter, the cmdlet uses the storage account that was defined previously as part of the auditing policy.
+If this is the first time an auditing policy is defined and you do not specify this parameter, the cmdlet fails.```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
@@ -229,10 +210,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -StorageKeyType
-Specifies which of the storage access keys to use.
+### -StorageAccountSubscriptionId
+Specifies storage account subscription id```yaml
+Type: Guid
+Parameter Sets: (All)
+Aliases:
 
-```yaml
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -StorageKeyType
+Specifies which of the storage access keys to use.```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
@@ -246,31 +238,27 @@ Accept wildcard characters: False
 ```
 
 ### -Confirm
-Prompts you for confirmation before running the cmdlet.
-
-```yaml
+Prompts you for confirmation before running the cmdlet.```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
 Aliases: cf
 
 Required: False
 Position: Named
-Default value: None
+Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -WhatIf
-Shows what would happen if the cmdlet runs. The cmdlet is not run.
-
-```yaml
+Shows what would happen if the cmdlet runs. The cmdlet is not run.```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
 Aliases: wi
 
 Required: False
 Position: Named
-Default value: None
+Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditing.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditing.md
