Compartir vía


Inicio rápido: Ejecución de consultas de Resource Graph mediante Azure PowerShell

En este inicio rápido se describe cómo ejecutar una consulta de Azure Resource Graph mediante el Az.ResourceGraph módulo para Azure PowerShell. El módulo se incluye con la versión más reciente de Azure PowerShell y agrega cmdlets para Resource Graph.

En el artículo también se muestra cómo ordenar (organizar) y limitar los resultados de la consulta. Puede ejecutar una consulta de recursos en el inquilino, los grupos de administración o las suscripciones.

Requisitos previos

Instalación del módulo

Si instaló las versiones más recientes de PowerShell y Azure PowerShell, ya tiene el módulo Az.ResourceGraph y la versión necesaria de PowerShellGet.

Instalación del módulo opcional

Siga los pasos siguientes para instalar el módulo Az.ResourceGraph para que pueda usar Azure PowerShell a fin de ejecutar consultas de Azure Resource Graph. El módulo Azure Resource Graph requiere la versión 2.0.1 o posterior de PowerShellGet.

  1. Compruebe su versión de PowerShellGet:

    Get-Module -Name PowerShellGet
    

    Si necesita actualizar, vaya a PowerShellGet.

  2. Instalación del módulo :

    Install-Module -Name Az.ResourceGraph -Repository PSGallery -Scope CurrentUser
    

    El comando instala el módulo en el ámbito CurrentUser. Si necesita realizar la instalación en el ámbito AllUsers, ejecútela desde una sesión administrativa de PowerShell.

  3. Compruebe que el módulo se instaló:

    Get-Command -Module Az.ResourceGraph -CommandType Cmdlet
    

    El comando muestra la versión del cmdlet Search-AzGraph y carga el módulo en la sesión de PowerShell.

Conexión con Azure

Desde una sesión de terminal de Visual Studio Code, conéctese a Azure. Si tiene más de una suscripción, ejecute los comandos para establecer el contexto en la suscripción. Reemplace <subscriptionID> con la identificación de su suscripción de Azure.

Connect-AzAccount

# Run these commands if you have multiple subscriptions
Get-AzSubScription
Set-AzContext -Subscription <subscriptionID>

Ejecución de una consulta

Una vez agregado el módulo al entorno, puede ejecutar una consulta basada en inquilinos. La consulta de este ejemplo devuelve cinco recursos de Azure con el name y type de cada recurso. Para hacer una consulta por grupo de administración o suscripción, use los parámetros -ManagementGroup o -Subscription.

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

    Search-AzGraph -Query 'Resources | project name, type | limit 5'
    

    En este ejemplo de consulta no se usa un modificador de ordenación como order by. Si ejecuta la consulta varias veces, puede producir un conjunto diferente de recursos para cada solicitud.

  2. Actualice la consulta para order by la namepropiedad:

    Search-AzGraph -Query 'Resources | project name, type | limit 5 | order by name asc'
    

    Al igual que la consulta anterior, si ejecuta esta consulta varias veces, podría producir un conjunto diferente de recursos para cada solicitud. El orden de los comandos de consulta es importante. En este ejemplo, el order by viene después del limit. La consulta limita los resultados a cinco recursos y, a continuación, ordena esos resultados por nombre.

  3. Actualice la consulta para order by la propiedad name y, a continuación, limit la salida a cinco resultados:

    Search-AzGraph -Query 'Resources | project name, type | order by name asc | limit 5'
    

    Si esta consulta se ejecuta varias veces sin cambios en el entorno, los resultados son coherentes y ordenados por la propiedad name, pero todavía están limitados a cinco resultados. La consulta ordena los resultados por nombre y, a continuación, limita la salida a cinco recursos.

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

Limpieza de recursos

Para cerrar la sesión de Azure PowerShell:

Disconnect-AzAccount

Pasos de limpieza opcionales

Si instaló la versión más reciente de Azure PowerShell, se incluye el módulo Az.ResourceGraph y no se debe quitar. Los pasos siguientes son opcionales si ha instalado manualmente el módulo Az.ResourceGraph y desea quitar el módulo.

Para quitar el módulo Az.ResourceGraph de la sesión de PowerShell, ejecute el siguiente comando:

Remove-Module -Name Az.ResourceGraph

Para desinstalar el módulo Az.ResourceGraph del equipo, ejecute el siguiente comando:

Uninstall-Module -Name Az.ResourceGraph

Es posible que se muestre un mensaje en el que se indique que módulo Az.ResourceGraph está actualmente en uso. Si es así, debe apagar la sesión de PowerShell e iniciar una nueva sesión. A continuación, ejecute el comando para desinstalar el módulo del equipo.

Pasos siguientes

En este inicio rápido, agregó el módulo Resource Graph al entorno de Azure PowerShell y ejecutó una consulta. Para más información, vaya a la página de detalles del lenguaje de consulta.