Skip to content

Commit

Permalink
Fix Az.Sql XML comments (#18576)
Browse files Browse the repository at this point in the history
* Fix Az.Sql XML comments

* Fix Az.Sql XML comments

* Update DatabaseEditions.cs
  • Loading branch information
ziyuezh576 committed Jun 22, 2022
1 parent 39e8bc6 commit e38a855
Show file tree
Hide file tree
Showing 102 changed files with 348 additions and 394 deletions.
14 changes: 7 additions & 7 deletions src/Sql/Sql.LegacySdk/Generated/Models/DatabaseEditions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,33 +35,33 @@ public static partial class DatabaseEditions
/// and workgroup or departmental applications.
/// </summary>
public const string Web = "Web";

/// <summary>
/// The Business Edition Database is best suited for independent
/// software vendors (ISVs), line-of-business (LOB) applications, and
/// enterprise applications.
/// </summary>
public const string Business = "Business";

/// <summary>
/// The Basic Edition Database is best suited for small databases with
/// few transactions (<100) per minute and only a couple users.
/// few transactions (&lt;100) per minute and only a couple users.
/// </summary>
public const string Basic = "Basic";

/// <summary>
/// The Standard Edition Database is best suited for a group of users
/// makingfewer than 1000 transactions per minute.
/// </summary>
public const string Standard = "Standard";

/// <summary>
/// The Premium Edition Database is for situations requiring a high
/// number of transactionsper second (>100). Supports more users than
/// number of transactionsper second (&gt;100). Supports more users than
/// Basic and Standard editions.
/// </summary>
public const string Premium = "Premium";

/// <summary>
/// The Free Edition Database is available for certain offers and
/// product bundles.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ protected override ManagedInstanceAdvancedDataSecurityPolicyModel GetEntity()
/// <summary>
/// Creation and initialization of the ModelAdapter object
/// </summary>
/// <param name="subscription">The AzureSubscription in which the current execution is performed</param>
/// <returns>An initialized and ready to use ModelAdapter object</returns>
protected override SqlAdvancedDataSecurityAdapter InitModelAdapter()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ public abstract class BuildAzureSqlDatabaseDataMaskingRule : SqlDatabaseDataMask
/// <summary>
/// Updates the given model element with the cmdlet specific operation
/// </summary>
/// <param name="model">A model object</param>
/// <param name="rules">A model object</param>
protected override IEnumerable<DatabaseDataMaskingRuleModel> ApplyUserInputToModel(IEnumerable<DatabaseDataMaskingRuleModel> rules)
{
string errorMessage = ValidateOperation(rules);
Expand Down Expand Up @@ -215,7 +215,7 @@ private MaskingFunction ModelizeMaskingFunction()
/// This method is responsible to call the right API in the communication layer that will eventually send the information in the
/// object to the REST endpoint
/// </summary>
/// <param name="model">The model object with the data to be sent to the REST endpoints</param>
/// <param name="rules">The model object with the data to be sent to the REST endpoints</param>
protected override IEnumerable<DatabaseDataMaskingRuleModel> PersistChanges(IEnumerable<DatabaseDataMaskingRuleModel> rules)
{
ModelAdapter.SetDatabaseDataMaskingRule(rules.First(IsModelOfRule));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ protected override IEnumerable<DatabaseDataMaskingRuleModel> GetEntity()
/// This method is responsible to call the right API in the communication layer that will eventually send the information in the
/// object to the REST endpoint
/// </summary>
/// <param name="model">The model object with the data to be sent to the REST endpoints</param>
/// <param name="rules">The model object with the data to be sent to the REST endpoints</param>
protected override IEnumerable<DatabaseDataMaskingRuleModel> PersistChanges(IEnumerable<DatabaseDataMaskingRuleModel> rules)
{
DatabaseDataMaskingRuleModel model = rules.First();
Expand Down
1 change: 1 addition & 0 deletions src/Sql/Sql/Data Sync/Model/AzureSqlSyncAgentModel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ public AzureSqlSyncAgentModel()
/// Construct AzureSqlSyncAgentModel
/// </summary>
/// <param name="resourceGroup">resource group</param>
/// <param name="serverName">server name</param>
/// <param name="syncAgent">sync agent</param>
public AzureSqlSyncAgentModel(string resourceGroup, string serverName, SyncAgent syncAgent)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ namespace Microsoft.Azure.Commands.Sql.DataSync.Model
/// </summary>
public class AzureSqlSyncGroupSchemaColumnModel
{
// <summary>
/// <summary>
/// The quoted table name
/// </summary>
public string QuotedName { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public class AzureSqlSyncGroupSchemaModel
/// </summary>
public IList<AzureSqlSyncGroupSchemaTableModel> Tables { get; set; }

// <summary>
/// <summary>
/// Master sync member name
/// </summary>
public string MasterSyncMemberName { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public class AzureSqlSyncGroupSchemaTableModel
/// </summary>
public IList<AzureSqlSyncGroupSchemaColumnModel> Columns { get; set; }

// <summary>
/// <summary>
/// The quoted table name
/// </summary>
public string QuotedName { get; set; }
Expand Down
5 changes: 3 additions & 2 deletions src/Sql/Sql/Data Sync/Model/AzureSqlSyncMemberModel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,11 @@ public AzureSqlSyncMemberModel()
/// <summary>
/// Construct AzureSqlSyncMemberModel for Management.Sql.Models.syncMember object
/// </summary>
/// <param name="resourceGroupName">Resource group name</param>
/// <param name="resourceGroup">Resource group name</param>
/// <param name="serverName">Server name</param>
/// <param name="databaseName">Databse name</param>
/// <param name="syncGroup">sync member object</param>
/// <param name="syncGroupName">The name of the sync group</param>
/// <param name="syncMember">sync member object</param>
public AzureSqlSyncMemberModel(string resourceGroup, string serverName, string databaseName, string syncGroupName, SyncMember syncMember)
{
ResourceGroupName = resourceGroup;
Expand Down
12 changes: 7 additions & 5 deletions src/Sql/Sql/Data Sync/Services/AzureSqlDataSyncAdapter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ public void InvokeSyncMemberSchemaRefresh(string resourceGroupName, string serve
/// Create a sync group
/// </summary>
/// <param name="model">AzureSqlSyncGroupModel object</param>
/// <param name="syncDatabaseId">The sync database resource id</param>
/// <returns>Created AzureSqlSyncGroupModel object</returns>
internal AzureSqlSyncGroupModel CreateSyncGroup(AzureSqlSyncGroupModel model, string syncDatabaseId)
{
Expand Down Expand Up @@ -295,8 +296,7 @@ public void RemoveSyncMember(string resourceGroupName, string serverName, string
/// Create a sync member
/// </summary>
/// <param name="model">AzureSqlSyncMemberModel object</param>
/// <param name="databaseType">The type of member database</param>
/// <param name="password">The password of member database</param>
/// <param name="syncAgentId">The sync agent resource id</param>
/// <returns>Created AzureSqlSyncGroupModel object</returns>
internal AzureSqlSyncMemberModel CreateSyncMember(AzureSqlSyncMemberModel model, string syncAgentId)
{
Expand Down Expand Up @@ -335,8 +335,6 @@ internal AzureSqlSyncMemberModel CreateSyncMember(AzureSqlSyncMemberModel model,
/// Update a sync member
/// </summary>
/// <param name="model">AzureSqlSyncMemberModel object</param>
/// <param name="databaseType">The type of member database</param>
/// <param name="password">The password of member database</param>
/// <returns>Updated AzureSqlSyncGroupModel object</returns>
internal AzureSqlSyncMemberModel UpdateSyncMember(AzureSqlSyncMemberModel model)
{
Expand Down Expand Up @@ -384,6 +382,7 @@ public AzureSqlSyncFullSchemaModel GetSyncMemberSchema(string resourceGroupName,
/// Gets a sync agent by name
/// </summary>
/// <param name="resourceGroupName">The resource group the sync agent is in</param>
/// <param name="serverName">The name of the server</param>
/// <param name="syncAgentName">The name of the sync agent</param>
/// <returns>The sync agent object</returns>
public AzureSqlSyncAgentModel GetSyncAgent(string resourceGroupName, string serverName, string syncAgentName)
Expand Down Expand Up @@ -412,6 +411,7 @@ internal ICollection<AzureSqlSyncAgentModel> ListSyncAgents(string resourceGroup
/// Create a sync agent
/// </summary>
/// <param name="model">AzureSqlSyncAgentModel object</param>
/// <param name="syncDatabaseId">The sync database resource id</param>
/// <returns>Created AzureSqlSyncAgentModel object</returns>
internal AzureSqlSyncAgentModel CreateSyncAgent(AzureSqlSyncAgentModel model, string syncDatabaseId)
{
Expand Down Expand Up @@ -458,6 +458,7 @@ internal AzureSqlSyncAgentKeyModel CreateSyncAgentKey(string resourceGroupName,
/// Get all linked databases connected by a specified sync agent
/// </summary>
/// <param name="resourceGroupName">The resource group the sync agent is in</param>
/// <param name="serverName">The name of the server</param>
/// <param name="syncAgentName">The name of the sync agent</param>
internal ICollection<AzureSqlSyncAgentLinkedDatabaseModel> ListSyncAgentLinkedDatabases(string resourceGroupName, string serverName, string syncAgentName)
{
Expand Down Expand Up @@ -497,6 +498,7 @@ public static AzureSqlSyncGroupLogModel CreateSyncGroupLogModelFromResponse(Sync
/// <param name="resourceGroupName">The resource group the sync member is in</param>
/// <param name="serverName">The name of the server</param>
/// <param name="databaseName">The name of the database</param>
/// <param name="syncGroupName">The name of the sync group</param>
/// <param name="syncMember">The sync member object from the response</param>
/// <returns>The converted model</returns>
public static AzureSqlSyncMemberModel CreateSyncMemberModelFromResponse(string resourceGroupName, string serverName, string databaseName, string syncGroupName, Management.Sql.Models.SyncMember syncMember)
Expand All @@ -508,7 +510,7 @@ public static AzureSqlSyncMemberModel CreateSyncMemberModelFromResponse(string r
/// Converts the response from the service to a powershell sync agent object
/// </summary>
/// <param name="resourceGroupName">The resource group the agent is in</param>
/// <param name="server">The server name</param>
/// <param name="serverName">The server name</param>
/// <param name="syncAgent">The sync agent object from the response</param>
/// <returns>The converted model</returns>
public static AzureSqlSyncAgentModel CreateSyncAgentModelFromResponse(string resourceGroupName, string serverName, SyncAgent syncAgent)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ public class AzureSqlDatabaseActivationAdapter
/// <summary>
/// Constructs a database activation adapter
/// </summary>
/// <param name="profile">The current azure profile</param>
/// <param name="subscription">The current azure subscription</param>
/// <param name="context">The current azure context</param>
public AzureSqlDatabaseActivationAdapter(IAzureContext context)
{
Context = context;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ public class AzureSqlDatabaseActivationCommunicator
/// <summary>
/// Creates a communicator for Azure Sql Databases
/// </summary>
/// <param name="profile"></param>
/// <param name="subscription"></param>
/// <param name="context">The current azure context</param>
public AzureSqlDatabaseActivationCommunicator(IAzureContext context)
{
Context = context;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public class CopyAzureSqlDatabaseLongTermRetentionBackup : AzureSqlDatabaseLongT
public string TargetServerFullyQualifiedDomainName { get; set; }

/// <summary>
/// Gets or sets the resource ID of the target server (target subscription ID & target resource group name can be derived).
/// Gets or sets the resource ID of the target server (target subscription ID &amp; target resource group name can be derived).
/// </summary>
[Parameter(Mandatory = false,
HelpMessage = "The name of the target server.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ protected override AzureSqlDatabaseModel GetEntity()
model.Edition = Edition;
}

/// get auth headers for cross-sub and cross-tenant restore operations
// get auth headers for cross-sub and cross-tenant restore operations
string targetSubscriptionId = ModelAdapter.Context?.Subscription?.Id;
string sourceSubscriptionId = ParseSubscriptionIdFromResourceId(ResourceId);
bool isCrossSubscriptionRestore = false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ public class AzureSqlDatabaseBackupShortTermRetentionPolicyModel
/// </summary>
/// <param name="resourceGroup"></param>
/// <param name="serverName"></param>
/// <param name="databaseName"></param>
/// <param name="policy"></param>
public AzureSqlDatabaseBackupShortTermRetentionPolicyModel(string resourceGroup, string serverName, string databaseName, Management.Sql.Models.BackupShortTermRetentionPolicy policy)
{
Expand Down
Loading

0 comments on commit e38a855

Please sign in to comment.