Metadata - Post

Referencia

Servicio:: Log Analytics

Versión de la API:: 2022-10-27_Preview

Obtiene información de metadatos.
Recupere la información de metadatos del área de trabajo, incluidos su esquema, funciones, información del área de trabajo, categorías, etc.

POST https://api.loganalytics.io/v1/workspaces/{workspaceId}/metadata

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string	Identificador del área de trabajo. Este es el identificador del área de trabajo de la hoja Propiedades de la Azure Portal.

Respuestas

Nombre	Tipo	Description
200 OK	metadataResults	Aceptar. La llamada API se realizó correctamente y el resultado de los metadatos se encuentra en la carga de respuesta.
Other Status Codes	errorResponse	Objeto de respuesta de error.

Seguridad

oauth2

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

metadataPost

Solicitud de ejemplo

HTTP

POST https://api.loganalytics.io/v1/workspaces/b438b4f6-912a-46d5-9cb1-b44069212abc/metadata

Respuesta de muestra

status code:: 200

{
  "tables": [
    {
      "id": "ADAssessmentRecommendation",
      "name": "ADAssessmentRecommendation",
      "description": "Recommendations generated by AD assessments that are started through a scheduled task. When you schedule the assessment it runs by default every 7 days and upload the data into Azure Log Analytics",
      "timespanColumn": "TimeGenerated",
      "columns": [
        {
          "name": "SourceSystem",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "AssessmentId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "RecommendationId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Recommendation",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Description",
          "type": "string"
        },
        {
          "name": "RecommendationResult",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "TimeGenerated",
          "type": "datetime"
        },
        {
          "name": "FocusAreaId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "FocusArea",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "ActionAreaId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "ActionArea",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "RecommendationWeight",
          "type": "real"
        },
        {
          "name": "Computer",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "AffectedObjectType",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "AffectedObjectName",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Forest",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Domain",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "DomainController",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Technology",
          "type": "string"
        },
        {
          "name": "CustomData",
          "type": "string"
        },
        {
          "name": "TargetCount",
          "type": "int"
        },
        {
          "name": "IsRollup",
          "type": "bool",
          "isPreferredFacet": true
        },
        {
          "name": "IsCopied",
          "type": "bool",
          "isPreferredFacet": true
        },
        {
          "name": "RecommendationPeriod",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Type",
          "type": "string"
        },
        {
          "name": "_ResourceId",
          "type": "string"
        }
      ],
      "related": {
        "categories": [
          "workloads"
        ],
        "solutions": [
          "ADAssessment"
        ],
        "resourceTypes": [
          "microsoft.compute/virtualmachines"
        ]
      }
    },
    {
      "id": "custom_CL",
      "name": "custom_CL",
      "timespanColumn": "TimeGenerated",
      "columns": [
        {
          "name": "SourceSystem",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "ManagementGroupName",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "TimeGenerated",
          "type": "datetime",
          "isPreferredFacet": true
        },
        {
          "name": "Computer",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "RawData",
          "type": "string"
        },
        {
          "name": "Type",
          "type": "string"
        },
        {
          "name": "_ResourceId",
          "type": "string"
        }
      ],
      "related": {
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "solutions": [
    {
      "id": "ADAssessment",
      "name": "ADAssessment",
      "displayName": "Active Directory Health Check",
      "description": "Assess the risk and health of Active Directory environments.",
      "related": {
        "tables": [
          "ADAssessmentRecommendation"
        ],
        "functions": [
          "dwad"
        ],
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "functions": [
    {
      "id": "dwad",
      "name": "dwad",
      "displayName": "dasd",
      "body": "Heartbeat\r\n| where ResourceGroup != \"rg-SAP-DEVQA-005\" and ResourceGroup != \"rg-SAP-DEVQA-006\" and Computer contains \"\"\r\n| limit 500000\r\n| sort by Computer asc\r\n| distinct Computer\r\n",
      "related": {
        "solutions": [
          "ADAssessment"
        ],
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "resourceTypes": [
    {
      "id": "microsoft.compute/virtualmachines",
      "type": "Microsoft.Compute/VirtualMachines",
      "displayName": "Virtual machines",
      "related": {
        "tables": [
          "ADAssessmentRecommendation"
        ]
      }
    }
  ],
  "workspaces": [
    {
      "id": "b438b4f6-912a-46d5-9cb1-b44069212abc",
      "resourceId": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-IT",
      "name": "contosoretail-IT",
      "region": "eastus",
      "related": {
        "resourceTypes": [
          "microsoft.compute/virtualmachines"
        ],
        "tables": [
          "custom_CL"
        ],
        "solutions": [
          "ADAssessment"
        ],
        "functions": [
          "dwad"
        ]
      }
    }
  ],
  "categories": [
    {
      "id": "workloads",
      "displayName": "Workloads",
      "related": {
        "tables": [
          "ADAssessmentRecommendation",
          "ADReplicationResult",
          "SQLAssessmentRecommendation",
          "WorkloadMonitoringPerf"
        ]
      }
    }
  ]
}

Definiciones

Nombre	Description
Applications	Indicación de permiso para las aplicaciones de Application Insights en la solicitud de metadatos.
Columns	Lista de columnas definidas en la tabla
errorDetail	Detalles del error.
errorInfo	El código y el mensaje de un error.
errorResponse	Detalles del error.
metadataApplication	Una aplicación de Application Insights.
metadataCategory	Categoría de metadatos.
MetadataColumnDataType	Tipo de datos de la columna
metadataFunction	Una función almacenada.
metadataPermissions	Información de permisos.
metadataQuery	Consulta almacenada.
metadataResourceType	Tipo de recurso en Azure.
metadataResults	Una respuesta de metadatos.
metadataSolution	Una solución de Log Analytics.
metadataTable	Tabla de datos que participa en un esquema de área de trabajo.
metadataWorkspace	Un área de trabajo de Log Analytics.
Related	Elementos de metadatos relacionados para la categoría
Resources	Indicación de permiso para los recursos de Azure en la solicitud de metadatos.
Workspaces	Indicación de permiso para las áreas de trabajo en la solicitud de metadatos.

Applications

Indicación de permiso para las aplicaciones de Application Insights en la solicitud de metadatos.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso en la indicación de permiso.

Columns

Lista de columnas definidas en la tabla

Nombre	Tipo	Description
description	string	Descripción de la columna
isPreferredFacet	boolean	Marca que indica que esta columna es una faceta preferida.
name	string	Nombre de la columna
source	object	una indicación del origen de la columna, que solo se usa cuando varias áreas de trabajo tienen una definición en conflicto para la columna.
type	MetadataColumnDataType	Tipo de datos de la columna

errorDetail

Detalles del error.

Nombre	Tipo	Description
additionalProperties	object	Propiedades adicionales que se pueden proporcionar en el objeto de detalles de error
code	string	El código del error.
message	string	Mensaje de error legible para personas.
resources	string[]	Indica los recursos responsables del error.
target	string	Indica qué propiedad de la solicitud es responsable del error.
value	string	Indica qué valor de "destino" es responsable del error.

errorInfo

El código y el mensaje de un error.

Nombre	Tipo	Description
additionalProperties	object	Propiedades adicionales que se pueden proporcionar en el objeto de información de error
code	string	Código de error legible de la máquina.
details	errorDetail[]	detalles del error.
innererror	errorInfo	El código y el mensaje de un error. Detalles del error interno si existen.
message	string	Mensaje de error legible.

errorResponse

Detalles del error.

Nombre	Tipo	Description
error	errorInfo	El código y el mensaje de un error. Los detalles del error.

metadataApplication

Una aplicación de Application Insights.

Nombre	Tipo	Description
id	string	Identificador de la aplicación de Application Insights.
name	string	Nombre de la aplicación de Application Insights.
region	string	Región de Azure de la aplicación Application Insights.
related	Related	Los elementos de metadatos relacionados de la aplicación application Insights.
resourceId	string	Identificador de recurso de ARM de la aplicación de Application Insights.

metadataCategory

Categoría de metadatos.

Nombre	Tipo	Description
description	string	Descripción de la categoría
displayName	string	Nombre para mostrar de la categoría
id	string	Identificador de la categoría
related	Related	Elementos de metadatos relacionados para la categoría

MetadataColumnDataType

Tipo de datos de la columna

Nombre	Tipo	Description
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

metadataFunction

Una función almacenada.

Nombre	Tipo	Description
body	string	Cuerpo KQL de la función.
description	string	La descripción de la función.
displayName	string	Nombre para mostrar de la función.
id	string	El valor de este miembro se corresponde con el id. de la función.
name	string	Nombre de la función que se va a usar en las consultas.
parameters	string	Parámetros o argumentos de la función, si existe.
properties	object	Propiedades de la función.
related	Related	Los elementos de metadatos relacionados de la función.
tags	object	Etiquetas asociadas a la función .

metadataPermissions

Información de permisos.

Nombre	Tipo	Description
applications	Applications[]	Indicación de permiso para las aplicaciones de Application Insights en la solicitud de metadatos.
resources	Resources[]	Indicación de permiso para los recursos de Azure en la solicitud de metadatos.
workspaces	Workspaces[]	Indicación de permiso para las áreas de trabajo en la solicitud de metadatos.

metadataQuery

Consulta almacenada.

Nombre	Tipo	Description
body	string	Cuerpo KQL de la consulta.
description	string	Descripción de la consulta.
displayName	string	Nombre para mostrar de la consulta.
id	string	El identificador de la consulta.
labels	string[]	Etiquetas definidas por el usuario asociadas a la consulta.
properties	object	Propiedades de la consulta.
related	Related	Elementos de metadatos relacionados para la consulta.
tags	object	Etiquetas asociadas a la consulta.

metadataResourceType

Tipo de recurso en Azure.

Nombre	Tipo	Description
description	string	Descripción del tipo de recurso
displayName	string	Nombre para mostrar del tipo de recurso
id	string	Identificador del tipo de recurso
labels	string[]	Etiquetas definidas por el usuario del tipo de recurso
properties	object	Propiedades del tipo de recurso
related	Related	Elementos de metadatos relacionados para el tipo de recurso
tags	object	Etiquetas asociadas al tipo de recurso
type	string	Tipo del tipo de recurso

metadataResults

Una respuesta de metadatos.

Nombre	Tipo	Description
applications	metadataApplication[]	Lista de aplicaciones de Application Insights a las que se hace referencia en la solicitud de metadatos.
categories	metadataCategory[]	Lista de categorías a las que se hace referencia en esta respuesta de metadatos.
functions	metadataFunction[]	Lista de funciones almacenadas en el área de trabajo, o introducidas por soluciones, etc.
permissions	metadataPermissions[]	Lista de reglas de permisos que afectaron a la solicitud de metadatos.
queries	metadataQuery[]	Lista de consultas guardadas almacenadas en el área de trabajo o introducidas por soluciones, tipos de recursos, etc.
resourceTypes	metadataResourceType[]	Lista de tipos de recursos a los que se hace referencia en esta respuesta de metadatos.
resources	metadataResource[]	Lista de recursos de Azure a los que se hace referencia en la solicitud de metadatos.
solutions	metadataSolution[]	Lista de soluciones de Log Analytics instaladas en el área de trabajo.
tables	metadataTable[]	Lista de tablas y columnas que componen el esquema del área de trabajo.
workspaces	metadataWorkspace[]	Lista de áreas de trabajo de Log Analytics a las que se hace referencia en la solicitud de metadatos.

metadataSolution

Una solución de Log Analytics.

Nombre	Tipo	Description
description	string	Descripción de la solución de Log Analytics
displayName	string	Nombre para mostrar de la solución de Log Analytics
id	string	El identificador de la solución de Log Analytics
name	string	Nombre de la solución de Log Analytics
properties	object	Propiedades de la solución de Log Analytics
related	Related	Elementos de metadatos relacionados para la solución de Log Analytics
tags	object	Etiquetas asociadas a la solución de Log Analytics

metadataTable

Tabla de datos que participa en un esquema de área de trabajo.

Nombre	Tipo	Description
columns	Columns[]	Lista de columnas definidas en la tabla
description	string	Descripción de la tabla
id	string	El identificador de la tabla
labels	string[]	Etiquetas definidas por el usuario de la tabla
name	string	Nombre de la tabla.
properties	object	Propiedades de la tabla
related	Related	Elementos de metadatos relacionados para la tabla
tags	object	Etiquetas asociadas a la tabla
timespanColumn	string	Columna asociada al parámetro de consulta timespan para la tabla.

metadataWorkspace

Un área de trabajo de Log Analytics.

Nombre	Tipo	Description
id	string	Id. de área de trabajo de Log Analytics.
name	string	Nombre del área de trabajo de Log Analytics.
region	string	Región de Azure del área de trabajo de Log Analytics.
related	Related	Los elementos de metadatos relacionados para el área de trabajo de Log Analytics.
resourceId	string	Identificador de recurso de ARM del área de trabajo de Log Analytics.

Elementos de metadatos relacionados para la categoría

Nombre	Tipo	Description
functions	string[]	Funciones relacionadas con la categoría
queries	string[]	Consultas guardadas relacionadas con la categoría
resourceTypes	string[]	Tipos de recursos relacionados con la categoría
solutions	string[]	Soluciones de Log Analytics relacionadas con la categoría
tables	string[]	Tablas relacionadas con la categoría

Resources

Indicación de permiso para los recursos de Azure en la solicitud de metadatos.

Nombre	Tipo	Description
denyTables	string[]	Lista de tablas a las que se denegó el acceso para el identificador de recurso.
resourceId	string	Identificador de recurso en la indicación de permiso.

Workspaces

Indicación de permiso para las áreas de trabajo en la solicitud de metadatos.

Nombre	Tipo	Description
denyTables	string[]	Lista de tablas a las que se denegó el acceso para el identificador de recurso.
resourceId	string	Identificador de recurso en la indicación de permiso.

Compartir a través de

Metadata - Post

Parámetros de identificador URI

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

metadataPost

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Resources

Workspaces

Recursos adicionales

Compartir a través de

Metadata - Post

Parámetros de identificador URI

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

metadataPost

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Related

Resources

Workspaces

Recursos adicionales