Skip to content

Add facet sortBy and filter to ResourceGraph swagger #4390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
praries880 merged 1 commit into from
Nov 5, 2018
Merged

Add facet sortBy and filter to ResourceGraph swagger #4390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 90 additions & 6 deletions ...ager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourcesFacetQuery.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
],
"query": "where type =~ 'Microsoft.Compute/virtualMachines' | project id, name, location, properties.storageProfile.osDisk.osType | limit 5",
"query": "where type =~ 'Microsoft.Compute/virtualMachines' | project id, name, location, resourceGroup, properties.storageProfile.osDisk.osType | limit 5",
"facets": [
{
"expression": "location",
Expand All @@ -29,6 +29,21 @@
"sortOrder": "desc",
"$top": 3
}
},
{
"expression": "resourceGroup",
"options": {
"sortBy": "tolower(resourceGroup)",
"sortOrder": "asc",
"$top": 3
}
},
{
"expression": "resourceGroup",
"options": {
"filter": "resourceGroup contains 'test'",
"$top": 3
}
}
]
}
Expand All @@ -53,40 +68,49 @@
"name": "location",
"type": "string"
},
{
"name": "resourceGroup",
"type": "string"
},
{
"name": "properties_storageProfile_osDisk_osType",
"type": "object"
}
],
"rows": [
[
"/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/virtualMachines/myTestVm",
"/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/B-TEST-RG/providers/Microsoft.Compute/virtualMachines/myTestVm",
"myTestVm",
"eastus",
"B-TEST-RG",
"Windows"
],
[
"/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/virtualMachines/myTestAccountVm",
"/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/c-rg/providers/Microsoft.Compute/virtualMachines/myTestAccountVm",
"myTestAccountVm",
"westcentralus",
"c-rg",
"Windows"
],
[
"/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/virtualMachines/yetanothertest",
"/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/I-RG/providers/Microsoft.Compute/virtualMachines/yetanothertest",
"yetanothertest",
"eastus",
"I-RG",
"Linux"
],
[
"/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Compute/virtualMachines/drafttest1bux4cv7a7q3aw",
"/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/x-test-rg/providers/Microsoft.Compute/virtualMachines/drafttest1bux4cv7a7q3aw",
"drafttest1bux4cv7a7q3aw",
"southcentralus",
"x-test-rg",
"Linux"
],
[
"/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Compute/virtualMachines/testvmntp25370",
"/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/y-rg/providers/Microsoft.Compute/virtualMachines/testvmntp25370",
"testvmntp25370",
"eastus",
"y-rg",
"Windows"
]
]
Expand Down Expand Up @@ -165,6 +189,66 @@
"message": "Invalid column names: [nonExistingColumn]."
}
]
},
{
"expression": "resourceGroup",
"resultType": "FacetResult",
"totalRecords": 5,
"count": 3,
"data": {
"columns": [
{
"name": "resourceGroup",
"type": "string"
},
{
"name": "count",
"type": "integer"
}
],
"rows": [
[
"B-TEST-RG",
1
],
[
"c-rg",
1
],
[
"I-RG",
1
]
]
}
},
{
"expression": "resourceGroup",
"resultType": "FacetResult",
"totalRecords": 2,
"count": 2,
"data": {
"columns": [
{
"name": "resourceGroup",
"type": "string"
},
{
"name": "count",
"type": "integer"
}
],
"rows": [
[
"B-TEST-RG",
1
],
[
"x-test-rg",
1
]
]
}
}
]
}
Expand Down
10 changes: 9 additions & 1 deletion ...ph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,12 @@
"FacetRequestOptions": {
"description": "The options for facet evaluation",
"properties": {
"sortBy": {
"description": "The column name or query expression to sort on. Defaults to count if not present.",
"type": "string"
},
"sortOrder": {
"description": "The sorting order by the hit count",
"description": "The sorting order by the selected column (count by default).",
"type": "string",
"default": "desc",
"enum": [
Expand All @@ -206,6 +210,10 @@
"modelAsString": false
}
},
"filter": {
"description": "Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.",
"type": "string"
},
"$top": {
"description": "The maximum number of facet rows that should be returned.",
"type": "integer",
Expand Down
2 changes: 1 addition & 1 deletion specification/resourcegraph/resource-manager/readme.python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ python:
payload-flattening-threshold: 2
namespace: azure.mgmt.resourcegraph
package-name: azure-mgmt-resourcegraph
package-version: 0.6.0
package-version: 0.7.0
clear-output-folder: true
```
``` yaml $(python) && $(python-mode) == 'update'
Expand Down