Add "Tag" parameter to FindAzureResourceCmdlet.

Change parameter sets.

Change Parameter Set.

Add comments.

Disallow combining other filters with tag filters as the service does not
support it.

Address code review comments.

Address code review comments.

Record Scenario Test for find resource by tag.

Update command help.

Update help.

Add new file to csproj.

Correct output settings for the json file for the new test.

Add Change Log.

Fix indentation in ChangeLog.md

Author: maphad

src/ResourceManager/Resources/ChangeLog.md

@@ -22,6 +22,9 @@
 ## Version 3.4.0
 * Support ResourceNameEquals and ResourceGroupNameEquals as parameters for Find-AzureRmResource
     - Users can now use ResourceNameEquals and ResourceGroupNameEquals with Find-AzureRmResource
+* Support Tag as parameters for Find-AzureRmResource
+    - Users can now use Tag parameter with Find-AzureRmResource
+    - Fixed the issue where illegal combinations of TagName, TagValue with other search parameters was allowed in Find-AzureRmResource and would result in users getting exception from the service by disallowing such combinations. 
 
 ## Version 3.3.0
 * Lookup of AAD group by Id now uses GetObjectsByObjectId AAD Graph call instead of Groups/<id>

src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Components/TagsHelper.cs

@@ -21,6 +21,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Components
     using System.Collections;
     using System.Collections.Generic;
     using System.Linq;
+    using ProjectResources = Microsoft.Azure.Commands.ResourceManager.Cmdlets.Properties.Resources;
 
     /// <summary>
     /// Helper class for tags.
@@ -52,5 +53,57 @@ internal static Hashtable GetTagsHashtable(InsensitiveDictionary<string> tags)
                 ? null
                 : TagsConversionHelper.CreateTagHashtable(tags);
         }
+
+        /// <summary>
+        /// Resolves the tag name given the tagObj and tagName parameters. If both are specified then tagObj takes precedence.
+        /// </summary>
+        /// <param name="tagObjParameter">Parameter containing the tag name-value specified as a hashset.</param>
+        /// <param name="tagNameParameter">Parameter containing the tag name specified individually.</param>
+        /// <returns>The resolved tag name.</returns>
+        internal static string GetTagNameFromParameters(Hashtable tagObjParameter, string tagNameParameter)
+        {
+            PSTagValuePair tagValuePair = null;
+            if (tagObjParameter != null)
+            {
+                tagValuePair = TagsConversionHelper.Create(tagObjParameter);
+
+                if (tagValuePair == null)
+                {
+                    throw new ArgumentException(ProjectResources.InvalidTagFormat);
+                }
+            }
+
+            if (tagValuePair != null)
+            {
+                return tagValuePair.Name;
+            }
+            return tagNameParameter;
+        }
+
+        /// <summary>
+        /// Resolves the tag value given the tagObj and tagValue parameters. If both are specified then tagObj takes precedence.
+        /// </summary>
+        /// <param name="tagObjParameter">Parameter containing the tag name-value specified as a hashset.</param>
+        /// <param name="tagValueParameter">Parameter containing the tag value specified individually.</param>
+        /// <returns>The resolved tag value.</returns>
+        internal static string GetTagValueFromParameters(Hashtable tagObjParameter, string tagValueParameter)
+        {
+            PSTagValuePair tagValuePair = null;
+            if (tagObjParameter != null)
+            {
+                tagValuePair = TagsConversionHelper.Create(tagObjParameter);
+
+                if (tagValuePair == null)
+                {
+                    throw new ArgumentException(ProjectResources.InvalidTagFormat);
+                }
+            }
+
+            if (tagValuePair != null)
+            {
+                return tagValuePair.Value;
+            }
+            return tagValueParameter;
+        }
     }
 }

src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Implementation/Resource/FindAzureResourceCmdlet.cs

@@ -14,17 +14,20 @@
 
 namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
 {
+    using Common.Tags;
     using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Components;
     using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Resources;
     using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
     using Microsoft.Azure.Commands.ResourceManager.Common;
     using Newtonsoft.Json.Linq;
     using System;
+    using System.Collections;
     using System.Collections.Concurrent;
     using System.Collections.Generic;
     using System.Linq;
     using System.Management.Automation;
     using System.Threading.Tasks;
+    using ProjectResources = Microsoft.Azure.Commands.ResourceManager.Cmdlets.Properties.Resources;
 
     /// <summary>
     /// Cmdlet to get existing resources from ARM cache.
@@ -52,6 +55,16 @@ public sealed class FindAzureResourceCmdlet : ResourceManagerCmdletBase
         /// </summary>
         internal const string MultiSubscriptionListResourcesParameterSet = "Get a resources using a multi-subscription query.";
 
+        /// <summary>
+        /// The list resources by tag object parameter set.
+        /// </summary>
+        internal const string ListResourcesByTagObjectParameterSet = "Lists resources by a tag object specified as a hashset.";
+
+        /// <summary>
+        /// The list resources by tag name-value parameter set.
+        /// </summary>
+        internal const string ListResourcesByTagNameValueParameterSet = "Lists resources by a tag specified as a individual name and value parameters.";
+
         /// <summary>
         /// Caches the current subscription ids to get all subscription ids in the pipeline.
         /// </summary>
@@ -100,6 +113,8 @@ public sealed class FindAzureResourceCmdlet : ResourceManagerCmdletBase
         [Parameter(ParameterSetName = FindAzureResourceCmdlet.ListResourcesParameterSet, Mandatory = false, HelpMessage = "The number of resources to retrieve.")]
         [Parameter(ParameterSetName = FindAzureResourceCmdlet.ListTenantResourcesParameterSet, Mandatory = false, HelpMessage = "The number of resources to retrieve.")]
         [Parameter(ParameterSetName = FindAzureResourceCmdlet.MultiSubscriptionListResourcesParameterSet, Mandatory = false, HelpMessage = "The number of resources to retrieve.")]
+        [Parameter(ParameterSetName = FindAzureResourceCmdlet.ListResourcesByTagObjectParameterSet, Mandatory = false, HelpMessage = "The number of resources to retrieve.")]
+        [Parameter(ParameterSetName = FindAzureResourceCmdlet.ListResourcesByTagNameValueParameterSet, Mandatory = false, HelpMessage = "The number of resources to retrieve.")]
         [ValidateNotNullOrEmpty]
         public int? Top { get; set; }
 
@@ -110,19 +125,20 @@ public sealed class FindAzureResourceCmdlet : ResourceManagerCmdletBase
         [ValidateNotNullOrEmpty]
         public string ODataQuery { get; set; }
 
+        [Parameter(ParameterSetName = FindAzureResourceCmdlet.ListResourcesByTagObjectParameterSet, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The tag filter for the OData query. The expected format is @{tagName=$null} or @{tagName = 'tagValue'}.")]
+        public Hashtable Tag { get; set; }
+
         /// <summary>
         /// Gets or sets the tag name.
         /// </summary>
-        [Parameter(ParameterSetName = FindAzureResourceCmdlet.ListResourcesParameterSet, Mandatory = false, HelpMessage = "The name of the tag to query by.")]
-        [Parameter(ParameterSetName = FindAzureResourceCmdlet.MultiSubscriptionListResourcesParameterSet, Mandatory = false, HelpMessage = "The name of the tag to query by.")]
+        [Parameter(ParameterSetName = FindAzureResourceCmdlet.ListResourcesByTagNameValueParameterSet, Mandatory = false, HelpMessage = "The name of the tag to query by.")]
         [ValidateNotNullOrEmpty]
         public string TagName { get; set; }
 
         /// <summary>
         /// Gets or sets the tag value.
         /// </summary>
-        [Parameter(ParameterSetName = FindAzureResourceCmdlet.ListResourcesParameterSet, Mandatory = false, HelpMessage = "The value of the tag to query by.")]
-        [Parameter(ParameterSetName = FindAzureResourceCmdlet.MultiSubscriptionListResourcesParameterSet, Mandatory = false, HelpMessage = "The value of the tag to query by.")]
+        [Parameter(ParameterSetName = FindAzureResourceCmdlet.ListResourcesByTagNameValueParameterSet, Mandatory = false, HelpMessage = "The value of the tag to query by.")]
         [ValidateNotNullOrEmpty]
         public string TagValue { get; set; }
 
@@ -275,8 +291,8 @@ private async Task<ResponseWithContinuation<JObject[]>> ListResourcesTypeCollect
                 resourceGroup: this.ResourceGroupNameEquals,
                 resourceType: null,
                 resourceName: this.ResourceNameEquals,
-                tagName: this.TagName,
-                tagValue: this.TagValue,
+                tagName: TagsHelper.GetTagNameFromParameters(this.Tag, this.TagName),
+                tagValue: TagsHelper.GetTagValueFromParameters(this.Tag, this.TagValue),
                 filter: this.ODataQuery,
                 resourceGroupNameContains: this.ResourceGroupNameContains,
                 nameContains: this.ResourceNameContains);
@@ -302,8 +318,8 @@ private async Task<ResponseWithContinuation<JObject[]>> ListResourcesInTenant()
                     resourceGroup: this.ResourceGroupNameEquals,
                     resourceType: this.ResourceType,
                     resourceName: this.ResourceNameEquals,
-                    tagName: this.TagName,
-                    tagValue: this.TagValue,
+                    tagName: TagsHelper.GetTagNameFromParameters(this.Tag, this.TagName),
+                    tagValue: TagsHelper.GetTagValueFromParameters(this.Tag, this.TagValue),
                     filter: this.ODataQuery,
                     resourceGroupNameContains: this.ResourceGroupNameContains,
                     nameContains: this.ResourceNameContains);
@@ -329,8 +345,8 @@ private async Task<ResponseWithContinuation<JObject[]>> ListResourcesInResourceG
                     resourceGroup: this.ResourceGroupNameEquals,
                     resourceType: this.ResourceType,
                     resourceName: this.ResourceNameEquals,
-                    tagName: this.TagName,
-                    tagValue: this.TagValue,
+                    tagName: TagsHelper.GetTagNameFromParameters(this.Tag, this.TagName),
+                    tagValue: TagsHelper.GetTagValueFromParameters(this.Tag, this.TagValue),
                     filter: this.ODataQuery,
                     resourceGroupNameContains: this.ResourceGroupNameContains,
                     nameContains: this.ResourceNameContains);
@@ -358,8 +374,8 @@ private async Task<ResponseWithContinuation<JObject[]>> ListResourcesInSubscript
                     resourceGroup: null,
                     resourceType: this.ResourceType,
                     resourceName: this.ResourceNameEquals,
-                    tagName: this.TagName,
-                    tagValue: this.TagValue,
+                    tagName: TagsHelper.GetTagNameFromParameters(this.Tag, this.TagName),
+                    tagValue: TagsHelper.GetTagValueFromParameters(this.Tag, this.TagValue),
                     filter: this.ODataQuery,
                     nameContains: this.ResourceNameContains);
 
@@ -493,8 +509,8 @@ private bool IsResourceGroupLevelQuery()
         {
             return this.SubscriptionId.HasValue &&
                 this.ResourceGroupNameAvailable() &&
-                (this.TagName != null ||
-                this.TagValue != null ||
+                (TagsHelper.GetTagNameFromParameters(this.Tag, this.TagName) != null ||
+                TagsHelper.GetTagValueFromParameters(this.Tag, this.TagValue) != null ||
                 this.ResourceType != null ||
                 this.ExtensionResourceType != null);
         }