Inicio rápido: Ejecutar la primera consulta de Resource Graph con Azure PowerShell

  • Artículo

El primer paso para usar Azure Resource Graph es comprobar que el módulo de Azure PowerShell está instalado. Esta guía de inicio rápido lo guiará a través del proceso de agregar el módulo a la instalación de Azure PowerShell.

Al final de este proceso, habrá agregado el módulo a la instalación de Azure PowerShell que haya elegido y habrá ejecutado la primera consulta de Resource Graph.

Prerrequisitos

Si no tiene una suscripción a Azure, cree una cuenta gratuita antes de empezar.

Azure Cloud Shell

En Azure se hospeda Azure Cloud Shell, un entorno de shell interactivo que puede utilizar mediante el explorador. Puede usar Bash o PowerShell con Cloud Shell para trabajar con los servicios de Azure. Puede usar los comandos preinstalados de Cloud Shell para ejecutar el código de este artículo sin tener que instalar nada en su entorno local.

Para iniciar Azure Cloud Shell:

Opción Ejemplo o vínculo
Seleccione Pruébelo en la esquina superior derecha de un bloque de código o de comandos. Solo con seleccionar Pruébelo no se copia automáticamente el código o comando en Cloud Shell. Captura de pantalla que muestra un ejemplo de la opción Pruébelo para Azure Cloud Shell.
Vaya a https://shell.azure.com o seleccione el botón Iniciar Cloud Shell para abrir Cloud Shell en el explorador. Captura de pantalla que muestra cómo iniciar Cloud Shell en una nueva ventana.
Seleccione el botón Cloud Shell en la barra de menús de la esquina superior derecha de Azure Portal. Captura de pantalla que muestra el botón de Cloud Shell en Azure Portal

Para usar Azure Cloud Shell:

  1. Inicie Cloud Shell.

  2. Seleccione el botón Copiar en un bloque de código (o bloque de comandos) para copiar el código o comando.

  3. Pegue el código o comando en la sesión de Cloud Shell. Para ello, seleccione Ctrl+Mayús+V en Windows y Linux, o bien seleccione Cmd+Mayús+V en macOS.

  4. Seleccione Intro para ejecutar el código o comando.

Agregar el módulo de Resource Graph

Para habilitar Azure PowerShell para consultar Azure Resource Graph, se debe agregar el módulo. Este módulo se puede usar con PowerShell y PowerShell Core instalados localmente, con Azure Cloud Shell o con la imagen de Docker de PowerShell.

Requisitos básicos

El módulo de Azure Resource Graph requiere el software siguiente:

  • Azure PowerShell 1.0.0 o posterior. Si todavía no está instalado, siga estas instrucciones.

  • PowerShellGet 2.0.1 o una versión posterior. Si no está instalado o actualizado, siga estas instrucciones.

Instalación del módulo

El módulo de Resource Graph para PowerShell es Az.ResourceGraph.

  1. Ejecute el siguiente comando como administrador en un símbolo del sistema de PowerShell:

    # Install the Resource Graph module from PowerShell Gallery
Install-Module -Name Az.ResourceGraph

  2. Asegúrese de que el módulo se haya importado y que sea como mínimo la versión 0.11.0:

    # Get a list of commands for the imported Az.ResourceGraph module
Get-Command -Module 'Az.ResourceGraph' -CommandType 'Cmdlet'

Ejecutar la primera consulta de Resource Graph

Una vez agregado el módulo de Azure PowerShell al entorno de su elección, es el momento de probar una consulta simple de Resource Graph basada en el inquilino. La consulta devolverá los cinco primeros recursos de Azure con el nombre y el tipo de recurso de cada recurso. Para hacer una consulta por grupo de administración o suscripción, use los parámetros -ManagementGroup o -Subscription.

  1. Ejecute la primera consulta de Azure Resource Graph mediante el cmdlet Search-AzGraph:

    # Login first with Connect-AzAccount if not using Cloud Shell

# Run Azure Resource Graph query
Search-AzGraph -Query 'Resources | project name, type | limit 5'

    Nota

    Como esta consulta de ejemplo no proporciona un modificador de ordenación como order by, es probable que al ejecutar esta consulta varias veces se produzca un conjunto diferente de recursos por solicitud.

  2. Actualice la consulta para order by la propiedad Nombre:

    # Run Azure Resource Graph query with 'order by'
Search-AzGraph -Query 'Resources | project name, type | limit 5 | order by name asc'

    Nota

    Al igual que con la primera consulta, es probable que al ejecutar esta consulta varias veces se produzca un conjunto diferente de recursos por solicitud. El orden de los comandos de consulta es importante. En este ejemplo, el order by viene después del limit. Este orden de comandos limita primero los resultados de la consulta y, luego, los ordena.

  3. Actualice la consulta para que primero se aplique order by a la propiedad Nombre y, después, limit a los cinco primeros resultados:

    # Store the query in a variable
$query = 'Resources | project name, type | order by name asc | limit 5'

# Run Azure Resource Graph query with `order by` first, then with `limit`
Search-AzGraph -Query $query

Cuando la consulta final se ejecuta varias veces, suponiendo que nada cambie en su entorno, los resultados devueltos serán coherentes y estarán ordenados por la propiedad Nombre, pero todavía limitados a los cinco primeros resultados.

Nota

Si la consulta no devuelve los resultados de una suscripción a la que ya tiene acceso, tenga en cuenta que Search-AzGraph cmdlet utiliza de forma predeterminada las suscripciones en el contexto predeterminado. Para ver la lista de identificadores de suscripción que forman parte del contexto predeterminado, ejecute este comando (Get-AzContext).Account.ExtendedProperties.Subscriptions. Si quiere buscar en todas las suscripciones a las que tiene acceso, puede configurar PSDefaultParameterValues para el cmdlet Search-AzGraph mediante la ejecución de $PSDefaultParameterValues=@{"Search-AzGraph:Subscription"= $(Get-AzSubscription).ID}.

Limpieza de recursos

Si quiere quitar el módulo de Resource Graph de su entorno de Azure PowerShell, puede hacerlo mediante el comando siguiente:

# Remove the Resource Graph module from the current session
Remove-Module -Name 'Az.ResourceGraph'

# Uninstall the Resource Graph module from the environment
Uninstall-Module -Name 'Az.ResourceGraph'

Nota

De esta forma no se elimina el archivo de módulo descargado anteriormente. Solo lo quita de la sesión de PowerShell en ejecución.

Pasos siguientes

En este inicio rápido, ha agregado el módulo Resource Graph a su entorno de Azure PowerShell y ha ejecutado la primera consulta. Para más información sobre el lenguaje de Resource Graph, vaya a la página de detalles del lenguaje de consulta.

Obtener más información sobre el lenguaje de consulta