快速入门:使用 Azure CLI 运行你的第一个 Resource Graph 查询

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

在此过程结束时,你已将该扩展添加到所选的 Azure CLI 安装中,并将运行你的第一个 Resource Graph 查询。

先决条件

如果没有 Azure 订阅,请在开始前创建一个试用版订阅帐户。

备注

请先运行 az cloud set -n AzureChinaCloud 更改云环境,然后才能在 Azure 中国世纪互联中使用 Azure CLI。 若要切换回 Azure 公有云,请再次运行 az cloud set -n AzureCloud

添加 Resource Graph 扩展

若要使 Azure CLI 能够查询 Azure Resource Graph,则必须添加该扩展。 此扩展适用于可以使用 Azure CLI 的任何位置,包括 Windows 10 上的 bashAzure CLI Docker 映像或在本地安装。

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

  2. 在所选的 Azure CLI 环境中,使用以下命令导入该扩展:

    # Add the Resource Graph extension to the Azure CLI environment
    az extension add --name resource-graph
    
  3. 验证该扩展是否已安装以及是否为预期的版本(至少为 1.0.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 资源,以及每个资源的名称和资源类型 。 若要按管理组或订阅进行查询,请使用 --managementgroups--subscriptions 参数。

  1. 使用 graph 扩展和 query 命令运行你的第一个 Azure Resource Graph 查询:

    # Login first with az login
    az cloud set -n AzureChinaCloud
    az login
    
    # Run Azure Resource Graph query
    az graph query -q 'Resources | project name, type | limit 5'
    

    备注

    由于此查询示例未提供排序修饰符(例如 order by),因此多次运行此查询可能会为每个请求生成一组不同的资源。

  2. 将查询更新为 order by Name 属性:

    # Run Azure Resource Graph query with 'order by'
    az graph query -q 'Resources | project name, type | limit 5 | order by name asc'
    

    备注

    与第一个查询一样,多次运行此查询可能会为每个请求生成一组不同的资源。 查询命令的顺序非常重要。 在本例中,order by 位于 limit 之后。 命令按此顺序执行,首先会限制查询结果,然后对它们进行排序。

  3. 将查询更新为先 order by Name 属性,然后再 limit 为前五个结果:

    # Run Azure Resource Graph query with `order by` first, then with `limit`
    az graph query -q 'Resources | project name, type | order by name asc | limit 5'
    

假设环境中没有任何变化,则多次运行最后一个查询时,返回的结果将是一致的且按 Name 属性排序,但仍限制为前五个结果。

清理资源

如果希望从 Azure CLI 环境中删除 Resource Graph 扩展,可使用以下命令:

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

后续步骤

本快速入门介绍了如何将 Resource Graph 扩展添加到 Azure CLI 环境并运行第一个查询。 若要详细了解 Resource Graph 语言,请继续阅读查询语言详细信息页。