From 4b7bbbbba9656ce07b90cdb9008022eb8b2b7bdf Mon Sep 17 00:00:00 2001 From: v-yuzhichen <96757176+v-yuzhichen@users.noreply.github.com> Date: Wed, 22 Jun 2022 14:20:21 +0800 Subject: [PATCH] Fix Az.ServiceBus XML Comments (#18500) * Fix Az.ServiceBus XML Comments * Fix Az.ServiceBus XML Comments Co-authored-by: Ziyue Zheng --- .../Models/PSCorrelationFilterAttributes.cs | 13 ++----------- .../Models/PSNWRuleSetIpRulesAttributes.cs | 6 ++---- .../PSNWRuleSetVirtualNetworkRulesAttributes.cs | 8 +++----- .../ServiceBus/Models/PSNetworkRuleSetAttributes.cs | 10 ++-------- .../ServiceBus/Models/PSRulesAttributes.cs | 13 +------------ .../PSServiceBusMigrationConfigurationAttributes.cs | 1 + .../Models/PSSharedAccessSignatureAttributes.cs | 2 +- .../ServiceBus/Models/PSSubnetAttributes.cs | 5 ++--- 8 files changed, 14 insertions(+), 44 deletions(-) diff --git a/src/ServiceBus/ServiceBus/Models/PSCorrelationFilterAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSCorrelationFilterAttributes.cs index 30c49dacb14e..1db6f341e756 100644 --- a/src/ServiceBus/ServiceBus/Models/PSCorrelationFilterAttributes.cs +++ b/src/ServiceBus/ServiceBus/Models/PSCorrelationFilterAttributes.cs @@ -32,17 +32,8 @@ public PSCorrelationFilterAttributes() /// /// Initializes a new instance of the CorrelationFilter class. /// - /// Identifier of the correlation. - /// Identifier of the message. - /// Address to send to. - /// Address of the queue to reply to. - /// Application specific label. - /// Session identifier. - /// Session identifier to reply - /// to. - /// Content type of the message. - /// Value that indicates whether - /// the rule action requires preprocessing. + /// Properties of + /// correlationFilter public PSCorrelationFilterAttributes(Management.ServiceBus.Models.CorrelationFilter correlationFilter) { if (correlationFilter != null) diff --git a/src/ServiceBus/ServiceBus/Models/PSNWRuleSetIpRulesAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSNWRuleSetIpRulesAttributes.cs index 552722b1529d..e28bc87fff20 100644 --- a/src/ServiceBus/ServiceBus/Models/PSNWRuleSetIpRulesAttributes.cs +++ b/src/ServiceBus/ServiceBus/Models/PSNWRuleSetIpRulesAttributes.cs @@ -43,9 +43,7 @@ public static IList PSNWRuleSetIpRulesAttributesCo /// /// Initializes a new instance of the NWRuleSetIpRules class. /// - /// IP Mask - /// The IP Filter Action. Possible values include: - /// 'Allow' + /// public PSNWRuleSetIpRulesAttributes(NWRuleSetIpRules nwiprules) { IpMask = nwiprules.IpMask; @@ -59,7 +57,7 @@ public PSNWRuleSetIpRulesAttributes(NWRuleSetIpRules nwiprules) /// /// Gets or sets the IP Filter Action. Possible values include: 'Allow' - /// + /// public string Action { get; set; } } diff --git a/src/ServiceBus/ServiceBus/Models/PSNWRuleSetVirtualNetworkRulesAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSNWRuleSetVirtualNetworkRulesAttributes.cs index 2d072cd36d34..11d780f1007f 100644 --- a/src/ServiceBus/ServiceBus/Models/PSNWRuleSetVirtualNetworkRulesAttributes.cs +++ b/src/ServiceBus/ServiceBus/Models/PSNWRuleSetVirtualNetworkRulesAttributes.cs @@ -32,16 +32,14 @@ public PSNWRuleSetVirtualNetworkRulesAttributes() /// Initializes a new instance of the NWRuleSetVirtualNetworkRules /// class. /// - /// Subnet properties - /// Value that indicates - /// whether to ignore missing VNet Service Endpoint + /// public static IList PSNWRuleSetVirtualNetworkRulesAttributesCollection(IList nwVirtualNetworkRules) { List VNetRules = new List(); foreach (NWRuleSetVirtualNetworkRules nwRuleSetVirtualNetworkRules in nwVirtualNetworkRules) { - VNetRules.Add(new PSNWRuleSetVirtualNetworkRulesAttributes(nwRuleSetVirtualNetworkRules)); + VNetRules.Add(new PSNWRuleSetVirtualNetworkRulesAttributes(nwRuleSetVirtualNetworkRules)); } return VNetRules; @@ -65,6 +63,6 @@ public PSNWRuleSetVirtualNetworkRulesAttributes(NWRuleSetVirtualNetworkRules nwV /// Service Endpoint /// public bool? IgnoreMissingVnetServiceEndpoint { get; set; } - + } } diff --git a/src/ServiceBus/ServiceBus/Models/PSNetworkRuleSetAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSNetworkRuleSetAttributes.cs index c0a246eb6bab..e0fa042e96ed 100644 --- a/src/ServiceBus/ServiceBus/Models/PSNetworkRuleSetAttributes.cs +++ b/src/ServiceBus/ServiceBus/Models/PSNetworkRuleSetAttributes.cs @@ -35,14 +35,8 @@ public PSNetworkRuleSetAttributes() /// /// Initializes a new instance of the NetworkRuleSet class. /// - /// Resource Id - /// Resource name - /// Resource type - /// Default Action for Network Rule Set. - /// Possible values include: 'Allow', 'Deny' - /// List VirtualNetwork Rules - /// List of IpRules - public PSNetworkRuleSetAttributes(NetworkRuleSet networkRuleSet) + /// + public PSNetworkRuleSetAttributes(NetworkRuleSet networkRuleSet) { DefaultAction = networkRuleSet.DefaultAction; VirtualNetworkRules = PSNWRuleSetVirtualNetworkRulesAttributes.PSNWRuleSetVirtualNetworkRulesAttributesCollection(networkRuleSet.VirtualNetworkRules); diff --git a/src/ServiceBus/ServiceBus/Models/PSRulesAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSRulesAttributes.cs index 33b664593a61..529e45703378 100644 --- a/src/ServiceBus/ServiceBus/Models/PSRulesAttributes.cs +++ b/src/ServiceBus/ServiceBus/Models/PSRulesAttributes.cs @@ -40,18 +40,7 @@ public PSRulesAttributes() /// /// Initializes a new instance of the Rule class. /// - /// Resource Id - /// Resource name - /// Resource type - /// Represents the filter actions which are - /// allowed for the transformation of a message that have been matched - /// by a filter expression. - /// Filter type that is evaluated against a - /// BrokeredMessage. Possible values include: 'SqlFilter', - /// 'CorrelationFilter' - /// Properties of sqlFilter - /// Properties of - /// correlationFilter + /// public PSRulesAttributes(Rule rule) { Name = rule.Name; diff --git a/src/ServiceBus/ServiceBus/Models/PSServiceBusMigrationConfigurationAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSServiceBusMigrationConfigurationAttributes.cs index 6d87d244f356..9b65c3660e7d 100644 --- a/src/ServiceBus/ServiceBus/Models/PSServiceBusMigrationConfigurationAttributes.cs +++ b/src/ServiceBus/ServiceBus/Models/PSServiceBusMigrationConfigurationAttributes.cs @@ -71,6 +71,7 @@ public PSServiceBusMigrationConfigurationAttributes(MigrationConfigProperties mc /// Gets state in which Standard to Premium Migration is, possible /// values : Unknown, Reverting, Completing, Initiating, Syncing, /// Active + /// public string MigrationState { get; set; } } diff --git a/src/ServiceBus/ServiceBus/Models/PSSharedAccessSignatureAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSSharedAccessSignatureAttributes.cs index 32948281000c..9e541c94f680 100644 --- a/src/ServiceBus/ServiceBus/Models/PSSharedAccessSignatureAttributes.cs +++ b/src/ServiceBus/ServiceBus/Models/PSSharedAccessSignatureAttributes.cs @@ -30,7 +30,7 @@ public PSSharedAccessSignatureAttributes() /// /// Initializes a new instance of the SharedAccessSignature class. /// - /// SharedAccess Signature + /// SharedAccess Signature public PSSharedAccessSignatureAttributes(string sharedAccessSignature) { SharedAccessSignature = sharedAccessSignature.Replace("SharedAccessSignature",""); diff --git a/src/ServiceBus/ServiceBus/Models/PSSubnetAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSSubnetAttributes.cs index 580037da3659..75ad02e5a8c4 100644 --- a/src/ServiceBus/ServiceBus/Models/PSSubnetAttributes.cs +++ b/src/ServiceBus/ServiceBus/Models/PSSubnetAttributes.cs @@ -30,17 +30,16 @@ public PSSubnetAttributes() /// /// Initializes a new instance of the Subnet class. /// - /// Resource ID of Virtual Network Subnet + /// Subnet properties public PSSubnetAttributes(Subnet subnet) { Id = subnet.Id; } - /// /// Gets or sets resource ID of Virtual Network Subnet /// public string Id { get; set; } - + } }