Merge pull request #279404 from davidsmatlak/ds-updates-arg-shared-cli-20240626

ttorble · web-flow · commit e925e9b08ca6 · 2024-06-27T09:31:25.000+01:00
Updates ARG Az CLI shared query
diff --git a/articles/governance/resource-graph/first-query-azurecli.md b/articles/governance/resource-graph/first-query-azurecli.md
@@ -1,20 +1,20 @@
 ---
 title: "Quickstart: Run Resource Graph query using Azure CLI"
-description: In this quickstart, you run an Azure Resource Graph query using the extension for Azure CLI.
-ms.date: 04/22/2024
+description: In this quickstart, you run a Resource Graph query using Azure CLI and the resource-graph extension.
+ms.date: 06/26/2024
 ms.topic: quickstart
 ms.custom: devx-track-azurecli
 ---
 
 # Quickstart: Run Resource Graph query using Azure CLI
 
-This quickstart describes how to run an Azure Resource Graph query using the extension for Azure CLI. The article also shows how to order (sort) and limit the query's results. You can run a query for resources in your tenant, management groups, or subscriptions. When you're finished, you can remove the extension.
+This quickstart describes how to run an Azure Resource Graph query using the Azure CLI and the Resource Graph extension. The article also shows how to order (sort) and limit the query's results. You can run a query for resources in your tenant, management groups, or subscriptions. When you finish, you can remove the extension.
 
 ## Prerequisites
 
 - If you don't have an Azure account, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
 - [Azure CLI](/cli/azure/install-azure-cli) must be version 2.22.0 or higher for the Resource Graph extension.
-- [Visual Studio Code](https://code.visualstudio.com/).
+- A Bash shell environment where you can run Azure CLI commands. For example, Git Bash in a [Visual Studio Code](https://code.visualstudio.com/) terminal session.
 
 ## Connect to Azure
 
@@ -30,7 +30,7 @@ az account set --subscription <subscriptionID>
 
 ## Install the extension
 
-To enable Azure CLI to query resources using Azure Resource Graph, the Resource Graph extension must be installed. You can manually install the extension with the following steps. Otherwise, the first time you run a query with `az graph` you're prompted to install the extension.
+To enable Azure CLI to query resources using Azure Resource Graph, the Resource Graph extension must be installed. The first time you run a query with `az graph` a prompt is displayed to install the extension. Otherwise, use the following steps to do a manual installation.
 
 1. List the available extensions and versions:
 
diff --git a/articles/governance/resource-graph/shared-query-azure-cli.md b/articles/governance/resource-graph/shared-query-azure-cli.md
@@ -1,152 +1,163 @@
 ---
-title: "Quickstart: Create a shared query with Azure CLI"
-description: In this quickstart, you follow the steps to enable the Resource Graph extension for Azure CLI and create a shared query.
-ms.date: 08/17/2021
+title: "Quickstart: Create Resource Graph shared query using Azure CLI"
+description: In this quickstart, you create an Azure Resource Graph shared query using Azure CLI and the resource-graph extension.
+ms.date: 06/26/2024
 ms.topic: quickstart
 ms.custom: devx-track-azurecli
 ---
-# Quickstart: Create a Resource Graph shared query using Azure CLI
 
-The first step to using Azure Resource Graph with [Azure CLI](/cli/azure/) is to check that the
-extension is installed. This quickstart walks you through the process of adding the extension to
-your Azure CLI installation. You can use the extension with Azure CLI installed locally or through
-the [Azure Cloud Shell](https://shell.azure.com).
+# Quickstart: Create Resource Graph shared query using Azure CLI
 
-At the end of this process, you'll have added the extension to your Azure CLI installation of choice
-and create a Resource Graph shared query.
+This quickstart describes how to create an Azure Resource Graph shared query with Azure CLI and the Resource Graph extension. The [az graph shared-query](/cli/azure/graph/shared-query) commands are an _experimental_ feature of [az graph query](/cli/azure/graph#az-graph-query).
+
+A shared query can be run from Azure CLI with the _experimental_ feature's commands, or you can run the shared query from the Azure portal. A shared query is an Azure Resource Manager object that you can grant permission to or run in Azure Resource Graph Explorer. When you finish, you can remove the Resource Graph extension.
 
 ## Prerequisites
 
-If you don't have an Azure subscription, create a [free](https://azure.microsoft.com/free/) account
-before you begin.
+- If you don't have an Azure account, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
+- [Azure CLI](/cli/azure/install-azure-cli) must be version 2.22.0 or higher for the Resource Graph extension.
+- A Bash shell environment where you can run Azure CLI commands. For example, Git Bash in a [Visual Studio Code](https://code.visualstudio.com/) terminal session.
+
+## Connect to Azure
 
-<!-- [!INCLUDE [cloud-shell-try-it.md](../../../includes/cloud-shell-try-it.md)] -->
+From a Visual Studio Code terminal session, connect to Azure. If you have more than one subscription, run the commands to set context to your subscription. Replace `<subscriptionID>` with your Azure subscription ID.
 
-## Add the Resource Graph extension
+```azurecli
+az login
+
+# Run these commands if you have multiple subscriptions
+az account list --output table
+az account set --subscription <subscriptionID>
+```
 
-To enable Azure CLI to work with Azure Resource Graph, the extension must be added. This extension
-works wherever Azure CLI can be used, including [bash on Windows 10](/windows/wsl/install-win10),
-[Cloud Shell](https://shell.azure.com) (both standalone and inside the portal), the [Azure CLI
-Docker image](https://hub.docker.com/_/microsoft-azure-cli), or locally installed.
+## Install the extension
 
-1. Check that the latest Azure CLI is installed (at least **2.8.0**). If it isn't yet installed,
-   follow [these instructions](/cli/azure/install-azure-cli-windows).
+To enable Azure CLI to query resources using Azure Resource Graph, the Resource Graph extension must be installed. The first time you run a query with `az graph` a prompt is displayed to install the extension. Otherwise, use the following steps to do a manual installation.
 
-1. In your Azure CLI environment of choice, use
-   [az extension add](/cli/azure/extension#az-extension-add) to import the Resource Graph extension
-   with the following command:
+1. List the available extensions and versions:
 
    ```azurecli
-   # Add the Resource Graph extension to the Azure CLI environment
-   az extension add --name resource-graph
+   az extension list-available --output table
    ```
 
-1. Validate that the extension has been installed and is the expected version (at least **1.1.0**)
-   with [az extension list](/cli/azure/extension#az-extension-list):
+1. Install the extension:
 
    ```azurecli
-   # Check the extension list (note that you may have other extensions installed)
-   az extension list
-
-   # Run help for graph query options
-   az graph query -h
+   az extension add --name resource-graph
    ```
 
-## Create a Resource Graph shared query
+1. Verify the extension was installed:
 
-With the Azure CLI extension added to your environment of choice, it's time to a Resource Graph
-shared query. The shared query is an Azure Resource Manager object that you can grant permission to
-or run in Azure Resource Graph Explorer. The query summarizes the count of all resources grouped by
-_location_.
+   ```azurecli
+   az extension list --output table
+   ```
 
-1. Create a resource group with [az group create](/cli/azure/group#az-group-create) to store the
-   Azure Resource Graph shared query. This resource group is named `resource-graph-queries` and the
-   location is `westus2`.
+1. Display the extension's syntax:
 
    ```azurecli
-   # Login first with az login if not using Cloud Shell
-
-   # Create the resource group
-   az group create --name 'resource-graph-queries' --location 'westus2'
+   az graph query --help
    ```
 
-1. Create the Azure Resource Graph shared query using the `graph` extension and
-   [az graph shared-query create](/cli/azure/graph/shared-query#az-graph-shared-query-create)
-   command:
+  For more information about Azure CLI extensions, go to [Use and manage extensions with the Azure CLI](/cli/azure/azure-cli-extensions-overview).
+
+## Create a shared query
+
+Create a resource group and a shared that summarizes the count of all resources grouped by location.
+
+1. Create a resource group to store the Azure Resource Graph shared query. 
 
    ```azurecli
-   # Create the Azure Resource Graph shared query
-   az graph shared-query create --name 'Summarize resources by location' \
-      --description 'This shared query summarizes resources by location for a pinnable map graphic.' \
-      --graph-query 'Resources | summarize count() by location' \
-      --resource-group 'resource-graph-queries'
+   az group create --name "demoSharedQuery" --location westus2
    ```
 
-1. List the shared queries in the new resource group. The
-   [az graph shared-query list](/cli/azure/graph/shared-query#az-graph-shared-query-list)
-   command returns an array of values.
+1. Create the shared query.
 
    ```azurecli
-   # List all the Azure Resource Graph shared queries in a resource group
-   az graph shared-query list --resource-group 'resource-graph-queries'
+   az graph shared-query create --name "Summarize resources by location" \
+     --description "This shared query summarizes resources by location for a pinnable map graphic." \
+     --graph-query "Resources | summarize count() by location" \
+     --resource-group demoSharedQuery
    ```
 
-1. To get just a single shared query result, use the
-   [az graph shared-query show](/cli/azure/graph/shared-query#az-graph-shared-query-show)
-   command.
+1. List all shared queries in the resource group. 
 
    ```azurecli
-   # Show a specific Azure Resource Graph shared query
-   az graph shared-query show --resource-group 'resource-graph-queries' \
-      --name 'Summarize resources by location'
+   az graph shared-query list --resource-group demoSharedQuery
    ```
 
-1. Run the shared query in Azure CLI with the `{{shared-query-uri}}` syntax in an
-   [az graph query](/cli/azure/graph#az-graph-query) command.
-   First, copy the `id` field from the result of the previous `show` command. Replace
-   `shared-query-uri` text in the example with the value from the `id` field, but leave the
-   surrounding `{{` and `}}` characters.
+1. Limit the results to a specific shared query.
 
    ```azurecli
-   # Run a Azure Resource Graph shared query
-   az graph query --graph-query "{{shared-query-uri}}"
+   az graph shared-query show --resource-group "demoSharedQuery" \
+     --name "Summarize resources by location"
    ```
 
-   > [!NOTE]
-   > The `{{shared-query-uri}}` syntax is a **Preview** feature.
+## Run the shared query
+
+You can use the Azure CLI experimental feature syntax or the Azure portal to run the shared query. 
+
+### Use experimental feature to run shared query
+
+Run the shared query in Azure CLI with the `{{shared-query-uri}}` syntax in an `az graph query` command. You get the resource ID of your shared query and store it in a variable. The variable is used when you run the shared query.
 
-Another way to find Resource Graph shared queries is through the Azure portal. In the portal, use
-the search bar to search for "Resource Graph queries". Select the shared query. On the **Overview**
-page, the **Query** tab displays the saved query. The **Edit** button opens it in
-[Resource Graph Explorer](./first-query-portal.md).
+```azurecli
+sharedqueryid=$(az graph shared-query show --resource-group "demoSharedQuery" \
+  --name "Summarize resources by location" \
+  --query id \
+  --output tsv)
+
+az graph query --graph-query "{{$sharedqueryid}}"
+```
+
+You can use the `subscriptions` parameter to limit the results. 
+
+```azurecli
+az graph query --graph-query "{{$sharedqueryid}}" --subscriptions 11111111-1111-1111-1111-111111111111
+```
+
+### Run the shared query from portal
+
+You can verify the shared query works using Azure Resource Graph Explorer. To change the scope, use the **Scope** menu on the left side of the page. 
+
+1. Sign in to [Azure portal](https://portal.azure.com).
+1. Enter _resource graph_ into the search field at the top of the page.
+1. Select **Resource Graph Explorer**.
+1. Select **Open query**.
+1. Change **Type** to _Shared queries_.
+1. Select the query _Count VMs by OS_.
+1. Select **Run query** and the view output in the **Results** tab.
+
+You can also run the query from your resource group. 
+
+1. In Azure, go to the resource group, _demoSharedQuery_.
+1. From the **Overview** tab, select the query _Count VMs by OS_.
+1. Select the **Results** tab.
 
 ## Clean up resources
 
-If you wish to remove the Resource Graph shared query, resource group, and extension from your Azure
-CLI environment, you can do so by using the following commands:
+To remove the resource group and shared query:
+
+```azurecli
+az group delete --name demoSharedQuery
+```
 
-- [az graph shared-query delete](/cli/azure/graph/shared-query#az-graph-shared-query-delete)
-- [az group delete](/cli/azure/group#az-group-delete)
-- [az extension remove](/cli/azure/extension#az-extension-remove)
+To remove the Resource Graph extension, run the following command:
 
 ```azurecli
-# Delete the Azure Resource Graph shared query
-az graph shared-query delete --resource-group 'resource-graph-queries' \
-   --name 'Summarize resources by location'
+az extension remove --name resource-graph
+```
 
-# Remove the resource group
-# WARNING: This command deletes ALL resources you've added to this resource group without prompting for confirmation
-az group delete --resource-group 'resource-graph-queries' --yes
+To sign out of your Azure CLI session:
 
-# Remove the Azure Resource Graph extension from the Azure CLI environment
-az extension remove -n resource-graph
+```azurecli
+az logout
 ```
 
 ## Next steps
 
-In this quickstart, you've added the Resource Graph extension to your Azure CLI environment and
+In this quickstart, you added the Resource Graph extension to your Azure CLI environment and
 created a shared query. To learn more about the Resource Graph language, continue to the query
 language details page.
 
 > [!div class="nextstepaction"]
-> [Get more information about the query language](./concepts/query-language.md)
+> [Understanding the Azure Resource Graph query language](./concepts/query-language.md)
