Query Pack Queries - Search

Busque una lista de consultas definidas en un QueryPack de Log Analytics según las propiedades de búsqueda dadas.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/search?api-version=2019-09-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/search?api-version=2019-09-01&$top={$top}&includeBody={includeBody}&$skipToken={$skipToken}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
queryPackName
path True

string

Nombre del recurso QueryPack de Log Analytics.

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

subscriptionId
path True

string

Identificador de la suscripción de destino.

api-version
query True

string

Versión de API que se usará para la operación.

$skipToken
query

string

Token codificado en Base64 que se usa para capturar la página siguiente de elementos. El valor predeterminado es null.

$top
query

integer

int64

Número máximo de elementos devueltos en la página.

includeBody
query

boolean

Marca que indica si se va a devolver o no el cuerpo de cada consulta aplicable. Si es false, devuelva solo la información de consulta.

Cuerpo de la solicitud

Nombre Tipo Description
related

Related

Los elementos de metadatos relacionados de la función.

tags

object

Etiquetas asociadas a la consulta.

Respuestas

Nombre Tipo Description
200 OK

LogAnalyticsQueryPackQueryListResult

Una lista que contiene 0 o más consultas contenidas en el QueryPack de Log Analytics.

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo 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 suplantación de su cuenta de usuario

Ejemplos

QuerySearch

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/Microsoft.OperationalInsights/queryPacks/my-querypack/queries/search?api-version=2019-09-01&$top=3&includeBody=True

{
  "related": {
    "categories": [
      "other",
      "analytics"
    ]
  },
  "tags": {
    "my-label": [
      "label1"
    ]
  }
}

Respuesta de muestra

{
  "value": [
    {
      "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/4337bb16-d6fe-4ff7-97cf-59df25941476",
      "name": "4337bb16-d6fe-4ff7-97cf-59df25941476",
      "type": "microsoft.operationalinsights/queryPacks/queries",
      "systemData": {
        "createdBy": "string",
        "createdByType": "application",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "application",
        "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
      },
      "properties": {
        "id": "4337bb16-d6fe-4ff7-97cf-59df25941476",
        "timeCreated": "2019-08-15T10:29:56.1030254Z",
        "author": "1809f206-263a-46f7-942d-4572c156b7e7",
        "timeModified": "2019-08-15T10:29:56.1030254Z",
        "displayName": "Heartbeat_1",
        "description": "Thie query takes 10 entries of heartbeat 0",
        "body": "Heartbeat | take 1",
        "related": {
          "categories": [
            "other"
          ]
        },
        "tags": {
          "my-label": [
            "label1"
          ],
          "my-other-label": [
            "label2"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/bf015bf7-be70-49c2-8d52-4cce85c42ef1",
      "name": "bf015bf7-be70-49c2-8d52-4cce85c42ef1",
      "type": "microsoft.operationalinsights/queryPacks/queries",
      "systemData": {
        "createdBy": "string",
        "createdByType": "application",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "application",
        "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
      },
      "properties": {
        "id": "bf015bf7-be70-49c2-8d52-4cce85c42ef1",
        "timeCreated": "2019-08-15T10:30:26.7943629Z",
        "author": "1809f206-263a-46f7-942d-4572c156b7e7",
        "timeModified": "2019-08-15T10:30:26.7943629Z",
        "displayName": "Heartbeat_2",
        "description": "Thie query takes 10 entries of heartbeat 1",
        "body": "Heartbeat | take 1",
        "related": {
          "categories": [
            "analytics"
          ]
        },
        "tags": {
          "my-label": [
            "label1"
          ],
          "my-other-label": [
            "label2"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/8d91c6ca-9c56-49c6-b3ae-112a68871acd",
      "name": "8d91c6ca-9c56-49c6-b3ae-112a68871acd",
      "type": "microsoft.operationalinsights/queryPacks/queries",
      "systemData": {
        "createdBy": "string",
        "createdByType": "application",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "application",
        "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
      },
      "properties": {
        "id": "8d91c6ca-9c56-49c6-b3ae-112a68871acd",
        "timeCreated": "2019-08-15T10:30:29.4505584Z",
        "author": "1809f206-263a-46f7-942d-4572c156b7e7",
        "timeModified": "2019-08-15T10:30:29.4505584Z",
        "displayName": "Heartbeat_3",
        "description": "Thie query takes 10 entries of heartbeat 2",
        "body": "Heartbeat | take 1",
        "related": {
          "categories": [
            "other",
            "analytics"
          ]
        },
        "tags": {
          "my-label": [
            "label1"
          ],
          "my-other-label": [
            "label2"
          ]
        }
      }
    }
  ],
  "nextLink": null
}

Definiciones

Nombre Description
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

IdentityType

Tipo de identidad que crea o modifica recursos.

LogAnalyticsQueryPackQuery

Una definición de QueryPack-Query de Log Analytics.

LogAnalyticsQueryPackQueryListResult

Describe la lista de recursos de QueryPack-Query de Log Analytics.

LogAnalyticsQueryPackQuerySearchProperties

Propiedades que definen una instancia de Log Analytics QueryPack-Query propiedades de búsqueda.

Related

Los elementos de metadatos relacionados de la función.

SystemData

Datos del sistema de solo lectura

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

IdentityType

Tipo de identidad que crea o modifica recursos.

Nombre Tipo Description
application

string

key

string

managedIdentity

string

user

string

LogAnalyticsQueryPackQuery

Una definición de QueryPack-Query de Log Analytics.

Nombre Tipo Description
id

string

Identificador de recurso de Azure

name

string

Nombre de recurso de Azure

properties.author

string

Identificador de objeto del usuario que crea la consulta.

properties.body

string

Cuerpo de la consulta.

properties.description

string

Descripción de la consulta.

properties.displayName

string

Nombre para mostrar único para la consulta en el paquete de consultas.

properties.id

string

Identificador único de la aplicación. Este campo no se puede cambiar.

properties.properties

object

Propiedades adicionales que se pueden establecer para la consulta.

properties.related

Related

Los elementos de metadatos relacionados de la función.

properties.tags

object

Etiquetas asociadas a la consulta.

properties.timeCreated

string

Fecha de creación de la consulta de Log Analytics, en formato ISO 8601.

properties.timeModified

string

Fecha de última modificación de la consulta de Log Analytics, en formato ISO 8601.

systemData

SystemData

Datos del sistema de solo lectura

type

string

Tipo de recurso de Azure

LogAnalyticsQueryPackQueryListResult

Describe la lista de recursos de QueryPack-Query de Log Analytics.

Nombre Tipo Description
nextLink

string

URI para obtener el siguiente conjunto de definiciones de QueryPack de Log Analytics si hay demasiadas QueryPack-Queries donde se devuelve en el conjunto de resultados.

value

LogAnalyticsQueryPackQuery[]

Lista de definiciones de consulta QueryPack de Log Analytics.

LogAnalyticsQueryPackQuerySearchProperties

Propiedades que definen una instancia de Log Analytics QueryPack-Query propiedades de búsqueda.

Nombre Tipo Description
related

Related

Los elementos de metadatos relacionados de la función.

tags

object

Etiquetas asociadas a la consulta.

Los elementos de metadatos relacionados de la función.

Nombre Tipo Description
categories

string[]

Categorías relacionadas para la función.

resourceTypes

string[]

Los tipos de recursos relacionados para la función.

solutions

string[]

Las soluciones de Log Analytics relacionadas para la función.

SystemData

Datos del sistema de solo lectura

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC)

createdBy

string

Identificador de la identidad que creó el recurso.

createdByType

IdentityType

Tipo de identidad que creó el recurso.

lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

Identificador de la identidad que modificó el recurso por última vez.

lastModifiedByType

IdentityType

Tipo de identidad que modificó por última vez el recurso.