Resources - Resources

Referencia

Servicio:: Azure Resource Graph

Versión de la API:: 2024-04-01

Consulta los recursos administrados por Azure Resource Manager para ver los ámbitos especificados en la solicitud.

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
query	True	string	Consulta de recursos.
facets		FacetRequest[]	Matriz de solicitudes de faceta que se van a calcular en el resultado de la consulta.
managementGroups		string[]	Grupos de administración de Azure en los que se va a ejecutar la consulta. Ejemplo: [ 'mg1', 'mg2' ]
options		QueryRequestOptions	Opciones de evaluación de consultas
subscriptions		string[]	Suscripciones de Azure en las que se va a ejecutar la consulta.

Respuestas

Nombre	Tipo	Description
200 OK	QueryResponse	Resultado de la operación de consulta
Other Status Codes	ErrorResponse	Error al procesar la solicitud. Consulte el parámetro error.code para identificar el error específico.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Access a properties field

Basic management group query

Basic query

Basic tenant query

Complex query

Filter resources

First page query

Next page query

Query with a facet request

Random page query

Summarize resources by location

Access a properties field

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "subscriptions": [
    "cfbbd179-59d2-4052-aa06-9270a38aa9d6"
  ],
  "query": "Resources | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by tostring(properties.storageProfile.osDisk.osType)"
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 2,
  "count": 2,
  "resultTruncated": "false",
  "facets": [],
  "data": [
    {
      "properties_storageProfile_osDisk_osType": "Linux",
      "count": 7
    },
    {
      "properties_storageProfile_osDisk_osType": "Windows",
      "count": 23
    }
  ]
}

Basic management group query

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "managementGroups": [
    "e927f598-c1d4-4f72-8541-95d83a6a4ac8",
    "ProductionMG"
  ],
  "query": "Resources | project id, name, type, location, tags | limit 3"
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 3,
  "count": 3,
  "resultTruncated": "false",
  "facets": [],
  "data": [
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface",
      "name": "myNetworkInterface",
      "type": "microsoft.network/networkinterfaces",
      "location": "centralus",
      "tags": {
        "tag1": "Value1"
      }
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet",
      "name": "myVnet",
      "type": "microsoft.network/virtualnetworks",
      "location": "westus",
      "tags": {}
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp",
      "name": "myPublicIp",
      "type": "microsoft.network/publicipaddresses",
      "location": "westus",
      "tags": {}
    }
  ]
}

Basic query

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "subscriptions": [
    "cfbbd179-59d2-4052-aa06-9270a38aa9d6"
  ],
  "query": "Resources | project id, name, type, location, tags | limit 3"
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 3,
  "count": 3,
  "resultTruncated": "false",
  "facets": [],
  "data": [
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface",
      "name": "myNetworkInterface",
      "type": "microsoft.network/networkinterfaces",
      "location": "centralus",
      "tags": {
        "tag1": "Value1"
      }
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet",
      "name": "myVnet",
      "type": "microsoft.network/virtualnetworks",
      "location": "westus",
      "tags": {}
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp",
      "name": "myPublicIp",
      "type": "microsoft.network/publicipaddresses",
      "location": "westus",
      "tags": {}
    }
  ]
}

Basic tenant query

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "query": "Resources | project id, name, type, location, tags | limit 3"
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 3,
  "count": 3,
  "resultTruncated": "false",
  "facets": [],
  "data": [
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface",
      "name": "myNetworkInterface",
      "type": "microsoft.network/networkinterfaces",
      "location": "centralus",
      "tags": {
        "tag1": "Value1"
      }
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet",
      "name": "myVnet",
      "type": "microsoft.network/virtualnetworks",
      "location": "westus",
      "tags": {}
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp",
      "name": "myPublicIp",
      "type": "microsoft.network/publicipaddresses",
      "location": "westus",
      "tags": {}
    }
  ]
}

Complex query

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "subscriptions": [
    "cfbbd179-59d2-4052-aa06-9270a38aa9d6"
  ],
  "query": "Resources | project id, name, type, location | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by location | top 3 by count_"
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 3,
  "count": 3,
  "resultTruncated": "false",
  "facets": [],
  "data": [
    {
      "location": "centralus",
      "count_": 11
    },
    {
      "location": "eastus",
      "count_": 11
    },
    {
      "location": "southcentralus",
      "count_": 3
    }
  ]
}

Filter resources

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "subscriptions": [
    "cfbbd179-59d2-4052-aa06-9270a38aa9d6"
  ],
  "query": "Resources | project id, name, type, location | where type =~ 'Microsoft.Compute/virtualMachines' | limit 3"
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 3,
  "count": 3,
  "resultTruncated": "false",
  "facets": [],
  "data": [
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/virtualMachines/myVm1",
      "name": "myVm1",
      "type": "microsoft.compute/virtualmachines",
      "location": "centralus"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Compute/virtualMachines/myVirtualMachine",
      "name": "myVirtualMachine",
      "type": "microsoft.compute/virtualmachines",
      "location": "eastus"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG3/providers/Microsoft.Compute/virtualMachines/testVm",
      "name": "testVm",
      "type": "microsoft.compute/virtualmachines",
      "location": "eastus"
    }
  ]
}

First page query

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "subscriptions": [
    "cfbbd179-59d2-4052-aa06-9270a38aa9d6"
  ],
  "query": "Resources | where name contains 'test' | project id, name, type, location",
  "options": {
    "$top": 3,
    "$skip": 0
  }
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 386,
  "count": 3,
  "resultTruncated": "false",
  "facets": [],
  "$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ==",
  "data": [
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/yetanothertest_OsDisk_1_f396cbcb625a457bb69fe2abf5975820",
      "name": "yetanothertest_OsDisk_1_f396cbcb625a457bb69fe2abf5975820",
      "type": "microsoft.compute/disks",
      "location": "eastus"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA",
      "name": "TestAA",
      "type": "microsoft.automation/automationaccounts",
      "location": "westcentralus"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA/runbooks/TestRB",
      "name": "TestRB",
      "type": "microsoft.automation/automationaccounts/runbooks",
      "location": "westcentralus"
    }
  ]
}

Next page query

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "subscriptions": [
    "cfbbd179-59d2-4052-aa06-9270a38aa9d6"
  ],
  "query": "Resources | where name contains 'test' | project id, name, type, location",
  "options": {
    "$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ=="
  }
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 386,
  "count": 3,
  "resultTruncated": "false",
  "facets": [],
  "$skipToken": "eyAibm8yIjogImx1Y2syIiwgImJ1dDIiOiAibmljZTIiLCAidHJ5MiI6ICIhIiB9",
  "data": [
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/second_OsDisk_dddddbcb625a457bb69fe2abf5975820",
      "name": "second_OsDisk_dddddbcb625a457bb69fe2abf5975820",
      "type": "microsoft.compute/disks",
      "location": "eastus"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/AATest",
      "name": "AATest",
      "type": "microsoft.automation/automationaccounts",
      "location": "westcentralus"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA/runbooks/RBTest",
      "name": "RBTest",
      "type": "microsoft.automation/automationaccounts/runbooks",
      "location": "westcentralus"
    }
  ]
}

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "subscriptions": [
    "cfbbd179-59d2-4052-aa06-9270a38aa9d6"
  ],
  "query": "Resources | where type =~ 'Microsoft.Compute/virtualMachines' | project id, name, location, resourceGroup, properties.storageProfile.osDisk.osType | limit 5",
  "facets": [
    {
      "expression": "location",
      "options": {
        "sortOrder": "desc",
        "$top": 3
      }
    },
    {
      "expression": "properties.storageProfile.osDisk.osType",
      "options": {
        "sortOrder": "desc",
        "$top": 3
      }
    },
    {
      "expression": "nonExistingColumn",
      "options": {
        "sortOrder": "desc",
        "$top": 3
      }
    },
    {
      "expression": "resourceGroup",
      "options": {
        "sortBy": "tolower(resourceGroup)",
        "sortOrder": "asc",
        "$top": 3
      }
    },
    {
      "expression": "resourceGroup",
      "options": {
        "filter": "resourceGroup contains 'test'",
        "$top": 3
      }
    }
  ]
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 5,
  "count": 5,
  "resultTruncated": "false",
  "data": [
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/B-TEST-RG/providers/Microsoft.Compute/virtualMachines/myTestVm",
      "name": "myTestVm",
      "location": "eastus",
      "resourceGroup": "B-TEST-RG",
      "properties_storageProfile_osDisk_osType": "Windows"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/c-rg/providers/Microsoft.Compute/virtualMachines/myTestAccountVm",
      "name": "myTestAccountVm",
      "location": "westcentralus",
      "resourceGroup": "c-rg",
      "properties_storageProfile_osDisk_osType": "Windows"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/I-RG/providers/Microsoft.Compute/virtualMachines/yetanothertest",
      "name": "yetanothertest",
      "location": "eastus",
      "resourceGroup": "I-RG",
      "properties_storageProfile_osDisk_osType": "Linux"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/x-test-rg/providers/Microsoft.Compute/virtualMachines/drafttest1bux4cv7a7q3aw",
      "name": "drafttest1bux4cv7a7q3aw",
      "location": "southcentralus",
      "resourceGroup": "x-test-rg",
      "properties_storageProfile_osDisk_osType": "Linux"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/y-rg/providers/Microsoft.Compute/virtualMachines/testvmntp25370",
      "name": "testvmntp25370",
      "location": "eastus",
      "resourceGroup": "y-rg",
      "properties_storageProfile_osDisk_osType": "Windows"
    }
  ],
  "facets": [
    {
      "expression": "location",
      "resultType": "FacetResult",
      "totalRecords": 3,
      "count": 3,
      "data": [
        {
          "location": "eastus",
          "count": 3
        },
        {
          "location": "southcentralus",
          "count": 1
        },
        {
          "location": "westcentralus",
          "count": 1
        }
      ]
    },
    {
      "expression": "properties.storageProfile.osDisk.osType",
      "resultType": "FacetResult",
      "totalRecords": 2,
      "count": 2,
      "data": [
        {
          "properties_storageProfile_osDisk_osType": "Linux",
          "count": 2
        },
        {
          "properties_storageProfile_osDisk_osType": "Windows",
          "count": 3
        }
      ]
    },
    {
      "expression": "nonExistingColumn",
      "resultType": "FacetError",
      "errors": [
        {
          "code": "NoValidColumns",
          "message": "No valid columns in facet expression."
        },
        {
          "code": "InvalidColumnNames",
          "message": "Invalid column names: [nonExistingColumn]."
        }
      ]
    },
    {
      "expression": "resourceGroup",
      "resultType": "FacetResult",
      "totalRecords": 5,
      "count": 3,
      "data": [
        {
          "resourceGroup": "B-TEST-RG",
          "count": 1
        },
        {
          "resourceGroup": "c-rg",
          "count": 1
        },
        {
          "resourceGroup": "I-RG",
          "count": 1
        }
      ]
    },
    {
      "expression": "resourceGroup",
      "resultType": "FacetResult",
      "totalRecords": 2,
      "count": 2,
      "data": [
        {
          "resourceGroup": "B-TEST-RG",
          "count": 1
        },
        {
          "resourceGroup": "x-test-rg",
          "count": 1
        }
      ]
    }
  ]
}

Random page query

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "subscriptions": [
    "cfbbd179-59d2-4052-aa06-9270a38aa9d6"
  ],
  "query": "Resources | where name contains 'test' | project id, name, type, location",
  "options": {
    "$top": 2,
    "$skip": 10
  }
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 386,
  "count": 2,
  "resultTruncated": "false",
  "facets": [],
  "$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ==",
  "data": [
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/third_OsDisk_dddddbcb625a457bb69fe2abf5975820",
      "name": "third_OsDisk_dddddbcb625a457bb69fe2abf5975820",
      "type": "microsoft.compute/disks",
      "location": "eastus"
    },
    {
      "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/CCTest",
      "name": "CCTest",
      "type": "microsoft.automation/automationaccounts",
      "location": "westcentralus"
    }
  ]
}

Summarize resources by location

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01

{
  "subscriptions": [
    "cfbbd179-59d2-4052-aa06-9270a38aa9d6"
  ],
  "query": "Resources | project id, name, type, location | summarize by location"
}

Respuesta de muestra

status code:: 200

{
  "totalRecords": 3,
  "count": 3,
  "resultTruncated": "false",
  "facets": [],
  "data": [
    {
      "location": "centralus"
    },
    {
      "location": "eastus"
    },
    {
      "location": "westus"
    }
  ]
}

Definiciones

Nombre	Description
AuthorizationScopeFilter	Define qué nivel de recursos de autorización se deben devolver en función de las suscripciones y los grupos de administración que se pasan como ámbitos.
Error	Información de error.
ErrorDetails	Detalles del error.
ErrorResponse	Respuesta de error.
FacetError	Faceta cuya ejecución produjo un error.
FacetRequest	Solicitud para calcular estadísticas adicionales (facetas) en los resultados de la consulta.
FacetRequestOptions	Las opciones para la evaluación de facetas
FacetResult	Faceta ejecutada correctamente que contiene estadísticas adicionales sobre la respuesta de una consulta.
FacetSortOrder	Criterio de ordenación por la columna seleccionada (recuento de forma predeterminada).
QueryRequest	Describe una consulta que se va a ejecutar.
QueryRequestOptions	Opciones para la evaluación de consultas
QueryResponse	Resultado de la consulta.
ResultFormat	Define en qué formato se devuelve el resultado de la consulta.
ResultTruncated	Indica si los resultados de la consulta se truncan.

AuthorizationScopeFilter

Enumeración

Define qué nivel de recursos de autorización se deben devolver en función de las suscripciones y los grupos de administración que se pasan como ámbitos.

Valor	Description
AtScopeAboveAndBelow
AtScopeAndAbove
AtScopeAndBelow
AtScopeExact

Error

Object

Información de error.

Nombre	Tipo	Description
code	string	Código de error que identifica el error específico.
details	ErrorDetails[]	Detalles del error
message	string	Mensaje de error legible para personas.

ErrorDetails

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error que identifica el error específico.
message	string	Mensaje de error legible para personas.

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Información de error. Información de error.

FacetError

Object

Faceta cuya ejecución produjo un error.

Nombre	Tipo	Description
errors	ErrorDetails[]	Matriz que contiene errores de faceta detectados con detalles.
expression	string	Expresión de faceta, igual que en la solicitud de faceta correspondiente.
resultType	string: FacetError	Tipo de resultado

FacetRequest

Object

Solicitud para calcular estadísticas adicionales (facetas) en los resultados de la consulta.

Nombre	Tipo	Description
expression	string	Columna o lista de columnas que se van a resumir por
options	FacetRequestOptions	Las opciones para la evaluación de facetas

FacetRequestOptions

Object

Las opciones para la evaluación de facetas

Nombre	Tipo	Valor predeterminado	Description
$top	integer (int32) minimum: 1 maximum: 1000		Número máximo de filas de facetas que se deben devolver.
filter	string		Especifica la condición de filtro para la cláusula "where" que se ejecutará en el resultado de la consulta principal, justo antes de la faceta real.
sortBy	string		Nombre de columna o expresión de consulta en la que se va a ordenar. El valor predeterminado es contar si no está presente.
sortOrder	FacetSortOrder	desc	Criterio de ordenación por la columna seleccionada (recuento de forma predeterminada).

FacetResult

Object

Faceta ejecutada correctamente que contiene estadísticas adicionales sobre la respuesta de una consulta.

Nombre	Tipo	Description
count	integer (int32)	Número de registros devueltos en la respuesta de faceta.
data	object	Matriz JObject o Tabla que contiene las facetas deseadas. Solo está presente si la faceta es válida.
expression	string	Expresión de faceta, igual que en la solicitud de faceta correspondiente.
resultType	string: FacetResult	Tipo de resultado
totalRecords	integer (int64)	Número de registros totales en los resultados de la faceta.

FacetSortOrder

Enumeración

Criterio de ordenación por la columna seleccionada (recuento de forma predeterminada).

Valor	Description
asc
desc

QueryRequest

Object

Describe una consulta que se va a ejecutar.

Nombre	Tipo	Description
facets	FacetRequest[]	Matriz de solicitudes de faceta que se van a calcular en el resultado de la consulta.
managementGroups	string[]	Grupos de administración de Azure en los que se va a ejecutar la consulta. Ejemplo: [ 'mg1', 'mg2' ]
options	QueryRequestOptions	Opciones de evaluación de consultas
query	string	Consulta de recursos.
subscriptions	string[]	Suscripciones de Azure en las que se va a ejecutar la consulta.

QueryRequestOptions

Object

Opciones para la evaluación de consultas

Nombre	Tipo	Valor predeterminado	Description
$skip	integer (int32) minimum: 0		Número de filas que se van a omitir desde el principio de los resultados. Invalida el desplazamiento de página siguiente cuando `$skipToken` propiedad está presente.
$skipToken	string		Token de continuación para la paginación, capturando el siguiente tamaño de página y desplazamiento, así como el contexto de la consulta.
$top	integer (int32) minimum: 1 maximum: 1000		Número máximo de filas que debe devolver la consulta. Invalida el tamaño de página cuando `$skipToken` propiedad está presente.
allowPartialScopes	boolean	False	Solo se aplica a las consultas de nivel de inquilino y grupo de administración para decidir si se permiten ámbitos parciales para el resultado en caso de que el número de suscripciones supere los límites permitidos.
authorizationScopeFilter	AuthorizationScopeFilter	AtScopeAndBelow	Define qué nivel de recursos de autorización se deben devolver en función de las suscripciones y los grupos de administración que se pasan como ámbitos.
resultFormat	ResultFormat	objectArray	Define en qué formato se devuelve el resultado de la consulta.

QueryResponse

Object

Resultado de la consulta.

Nombre	Tipo	Description
$skipToken	string	Cuando está presente, el valor se puede pasar a una llamada de consulta posterior (junto con la misma consulta y ámbitos usados en la solicitud actual) para recuperar la siguiente página de datos.
count	integer (int64)	Número de registros devueltos en la respuesta actual. En el caso de paginación, este es el número de registros de la página actual.
data	object	Salida de consulta en formato de tabla o matriz JObject.
facets	Facet[]: FacetError[] FacetResult[]	Facetas de consulta.
resultTruncated	ResultTruncated	Indica si los resultados de la consulta se truncan.
totalRecords	integer (int64)	Número de registros totales que coinciden con la consulta.

ResultFormat

Enumeración

Define en qué formato se devuelve el resultado de la consulta.

Valor	Description
objectArray
table

ResultTruncated

Enumeración

Indica si los resultados de la consulta se truncan.

Valor	Description
false
true

Compartir a través de

Resources - Resources

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Access a properties field

Solicitud de ejemplo

Respuesta de muestra

Basic management group query

Solicitud de ejemplo

Respuesta de muestra

Basic query

Solicitud de ejemplo

Respuesta de muestra

Basic tenant query

Solicitud de ejemplo

Respuesta de muestra

Complex query

Solicitud de ejemplo

Respuesta de muestra

Filter resources

Solicitud de ejemplo

Respuesta de muestra

First page query

Solicitud de ejemplo

Respuesta de muestra

Next page query

Solicitud de ejemplo

Respuesta de muestra

Query with a facet request

Solicitud de ejemplo

Respuesta de muestra

Random page query

Solicitud de ejemplo

Respuesta de muestra

Summarize resources by location

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AuthorizationScopeFilter

Error

ErrorDetails

ErrorResponse

FacetError

FacetRequest

FacetRequestOptions

FacetResult

FacetSortOrder

QueryRequest

QueryRequestOptions

QueryResponse

ResultFormat

ResultTruncated