Merge pull request #9421 from OlhaTkachenko/SubscriptionFixes

Resource Graph: improving logic of getting subscriptions for query to ARG

Author: markcowl

src/ResourceGraph/ResourceGraph.Test/ScenarioTests/ResourceGraphQueryTests.cs

@@ -57,5 +57,12 @@ public void QueryError()
         {
             TestController.NewInstance.RunPowerShellTest(_logger, "Search-AzureRmGraph-QueryError");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void SubscriptionQueryError()
+        {
+            TestController.NewInstance.RunPowerShellTest(_logger, "Search-AzureRmGraph-SubscriptionQueryError");
+        }
     }
 }

src/ResourceGraph/ResourceGraph.Test/ScenarioTests/ResourceGraphQueryTests.ps1

@@ -151,3 +151,27 @@ function Search-AzureRmGraph-QueryError
 		Assert-AreEqual $PSItem.Exception.Body.Error.Details[0].AdditionalProperties.Count 4
 	}
 }
+
+<#
+.SYNOPSIS
+Run query with no subscriptions
+#>
+function Search-AzureRmGraph-SubscriptionQueryError
+{
+	$expectedErrorId = '400,' + [Microsoft.Azure.Commands.ResourceGraph.Cmdlets.SearchAzureRmGraph].FullName
+	$expectedErrorMessage = 
+	'No subscriptions were found to run query. Please try to add them implicitly as param to your request (e.g. Search-AzGraph -Query '''' -Subscription ''11111111-1111-1111-1111-111111111111'')'
+
+ 	try
+	{
+		Search-AzGraph "project id, type" -Subscription @()
+		Assert-True $false  # Expecting an error
+	}
+	catch [Exception]
+	{
+	    Assert-AreEqual $expectedErrorId $PSItem.FullyQualifiedErrorId
+		Assert-AreEqual $expectedErrorMessage $PSItem.Exception.Message
+
+		Assert-IsInstance $PSItem.Exception System.ArgumentException
+	}
+}

src/ResourceGraph/ResourceGraph.Test/SessionRecords/Microsoft.Azure.Commands.ResourceGraph.Test.ScenarioTests.ResourceGraphQueryTests/SubscriptionQueryError.json

@@ -0,0 +1,68 @@
+{
+  "Entries": [
+    {
+      "RequestUri": "/subscriptions?api-version=2016-06-01",
+      "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnM/YXBpLXZlcnNpb249MjAxNi0wNi0wMQ==",
+      "RequestMethod": "GET",
+      "RequestBody": "",
+      "RequestHeaders": {
+        "x-ms-client-request-id": [
+          "31537677-7032-4654-becb-372f2eeebf21"
+        ],
+        "accept-language": [
+          "en-US"
+        ],
+        "User-Agent": [
+          "FxVersion/4.7.3163.0",
+          "OSName/Windows10Enterprise",
+          "OSVersion/6.3.17134",
+          "Microsoft.Azure.Internal.Subscriptions.SubscriptionClient/4.1.0"
+        ]
+      },
+      "ResponseBody": "{\"value\": [{\"id\": \"/subscriptions/00000000-0000-0000-0000-000000000000\", \"subscriptionId\": \"00000000-0000-0000-0000-000000000000\", \"displayName\": \"Test Subscription\", \"state\": \"Enabled\", \"authorizationSource\": \"RoleBased\"}]}",
+      "ResponseHeaders": {
+        "Content-Length": [
+          "987"
+        ],
+        "Content-Type": [
+          "application/json; charset=utf-8"
+        ],
+        "Expires": [
+          "-1"
+        ],
+        "Pragma": [
+          "no-cache"
+        ],
+        "x-ms-ratelimit-remaining-tenant-reads": [
+          "11999"
+        ],
+        "x-ms-request-id": [
+          "dc5b4ea5-4059-44fa-9d49-5c48f46224f4"
+        ],
+        "x-ms-correlation-request-id": [
+          "dc5b4ea5-4059-44fa-9d49-5c48f46224f4"
+        ],
+        "x-ms-routing-request-id": [
+          "WESTUS2:20180926T232942Z:dc5b4ea5-4059-44fa-9d49-5c48f46224f4"
+        ],
+        "Strict-Transport-Security": [
+          "max-age=31536000; includeSubDomains"
+        ],
+        "X-Content-Type-Options": [
+          "nosniff"
+        ],
+        "Cache-Control": [
+          "no-cache"
+        ],
+        "Date": [
+          "Wed, 26 Sep 2018 23:29:41 GMT"
+        ]
+      },
+      "StatusCode": 200
+    }
+  ],
+  "Names": {},
+  "Variables": {
+    "SubscriptionId": "00000000-0000-0000-0000-000000000000"
+  }
+}

src/ResourceGraph/ResourceGraph/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Improving logic of getting subscriptions for query to ARG
 
 ## Version 0.7.2
 * Fix conversion to PSCustomObject[] for top-level arrays

src/ResourceGraph/ResourceGraph/Cmdlets/SearchAzureRmGraph.cs

@@ -33,7 +33,7 @@ public class SearchAzureRmGraph : ResourceGraphBaseCmdlet
         /// The rows per page
         /// </summary>
         private const int RowsPerPage = 1000;
-        
+
         /// <summary>
         /// Gets or sets the query.
         /// </summary>s
@@ -80,13 +80,25 @@ public int Skip
             get;
             set;
         }
-        
+
         /// <summary>
         /// Executes the cmdlet.
         /// </summary>
         public override void ExecuteCmdlet()
         {
             var subscriptions = this.GetSubscriptions().ToList();
+            if(subscriptions == null || subscriptions.Count == 0)
+            {
+                var exception = new ArgumentException("No subscriptions were found to run query. " +
+                    "Please try to add them implicitly as param to your request (e.g. Search-AzGraph -Query '' -Subscription '11111111-1111-1111-1111-111111111111')");
+
+                var errorRecord = new ErrorRecord(
+                            exception, "400",
+                            ErrorCategory.InvalidArgument, null);
+                this.WriteError(errorRecord);
+                return;
+            }
+
             var first = this.MyInvocation.BoundParameters.ContainsKey("First") ? this.First : 100;
             var skip = this.MyInvocation.BoundParameters.ContainsKey("Skip") ? this.Skip : 0;
 
@@ -107,12 +119,10 @@ public override void ExecuteCmdlet()
                         skip: requestSkip,
                         skipToken: requestSkipToken);
 
-                    var request = new QueryRequest(subscriptions, this.Query, requestOptions);
-
+                    var request = new QueryRequest(subscriptions, this.Query, options: requestOptions);
                     response = this.ResourceGraphClient.ResourcesWithHttpMessagesAsync(request)
                         .Result
                         .Body;
-
                     var requestResults = response.Data.ToPsObjects().ToList();
                     results.AddRange(requestResults);
                     this.WriteVerbose($"Received results: {requestResults.Count}");
@@ -158,6 +168,16 @@ private IEnumerable<string> GetSubscriptions()
                 return this.Subscription;
             }
 
+            // Use selected subscription (for example, by command "Select-AzSubscription {subscriptionId}") 
+            if (this.TryGetDefaultContext(out var context))
+            {
+                var subscriptionId = context.Subscription?.Id;
+                if(subscriptionId != null)
+                {
+                    return new List<string> { subscriptionId };
+                }
+            }
+
             var accountSubscriptions = this.DefaultContext.Account.GetSubscriptions();
             if (accountSubscriptions.Length > 0)
             {