你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

快速入门:使用 Azure CLI 创建 Resource Graph 共享查询

使用 Azure Resource Graph 的第一步是确保为 Azure CLI 安装了该扩展。 本快速入门将指导你完成将该扩展添加到 Azure CLI 安装的过程。 可以通过安装在本地的 Azure CLI 或通过 Azure Cloud Shell 使用该扩展。

在此过程结束时,你应已将该扩展添加到所选的 Azure CLI 安装中,并可创建一个 Resource Graph 共享查询。

先决条件

如果没有 Azure 订阅,请在开始之前创建一个免费帐户。

添加 Resource Graph 扩展

若要使 Azure CLI 能够用于 Azure Resource Graph,则必须添加该扩展。 此扩展适用于可以使用 Azure CLI 的任何位置,包括 Windows 10 上的 bashCloud Shell(独立的或位于门户内的)、Azure CLI Docker 映像,也适用于在本地安装了 Azure CLI 的任何位置。

  1. 请确保安装最新的 Azure CLI(至少为 2.8.0)。 若尚未安装,请遵循这些说明

  2. 在所选的 Azure CLI 环境中,使用 az extension add,通过以下命令导入 Resource Graph 扩展:

    # Add the Resource Graph extension to the Azure CLI environment
    az extension add --name resource-graph
    
  3. 使用 az extension list 验证该扩展是否已安装以及是否为预期版本(至少为 1.1.0):

    # 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
    

创建 Resource Graph 共享查询

将 Azure CLI 扩展添加到所选环境中后,即可使用 Resource Graph 查询。 共享查询是一个 Azure 资源管理器对象,你可授予该对象权限或在 Azure Resource Graph Explorer 中运行该对象。 该查询汇总了按“位置”分组的所有资源。

  1. 使用 az group create 创建资源组,以存储 Azure Resource Graph 共享查询。 此资源组名为 resource-graph-queries,并位于 westus2

    # Login first with az login if not using Cloud Shell
    
    # Create the resource group
    az group create --name 'resource-graph-queries' --location 'westus2'
    
  2. 使用 graph 扩展和 az graph shared-query create 命令创建 Azure Resource Graph 共享查询:

    # 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'
    
  3. 列出新资源组中的共享查询。 az graph shared-query list 命令返回值数组。

    # List all the Azure Resource Graph shared queries in a resource group
    az graph shared-query list --resource-group 'resource-graph-queries'
    
  4. 若要仅获取单个共享查询结果,请使用 az graph shared query show 命令。

    # Show a specific Azure Resource Graph shared query
    az graph shared-query show --resource-group 'resource-graph-queries' \
       --name 'Summarize resources by location'
    
  5. 使用 az graph query 命令中的 {{shared-query-uri}} 语法在 Azure CLI 中运行共享查询。 首先,从前面的 show 命令结果中复制 id 字段。 将示例中 shared-query-uri 文本替换为 id 字段中的值,但保留周围的 {{}} 字符。

    # Run a Azure Resource Graph shared query
    az graph query --graph-query "{{shared-query-uri}}"
    

    注意

    {{shared-query-uri}} 语法是预览功能。

另一种查找 Resource Graph 共享查询的方法是通过 Azure 门户。 在门户中,使用搜索栏搜索“Resource Graph 查询”。 选择共享查询。 在“概述”页上,“查询”选项卡显示已保存的查询 。 在 Resource Graph Explorer 中单击“编辑”按钮将其打开。

清理资源

如果要从 Azure CLI 环境中删除 Resource Graph 共享查询、资源组和扩展,可以使用以下命令执行此操作:

# Delete the Azure Resource Graph shared query
az graph shared-query delete --resource-group 'resource-graph-queries' \
   --name 'Summarize resources by location'

# 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

# Remove the Azure Resource Graph extension from the Azure CLI environment
az extension remove -n resource-graph

后续步骤

在本快速入门中,你已将 Resource Graph 扩展添加到 Azure CLI 环境并创建了一个共享查询。 若要详细了解 Resource Graph 语言,请继续阅读查询语言详细信息页。