Metadata - Get

Référence

Service:: Log Analytics

Version d'API:: 2022-10-27_Preview

Obtient des informations de métadonnées
Récupérez les informations de métadonnées de l’espace de travail, y compris son schéma, ses fonctions, ses informations sur l’espace de travail, ses catégories, etc.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string	ID de l’espace de travail. Il s’agit de l’ID d’espace de travail du panneau Propriétés dans le Portail Azure.

Réponses

Nom	Type	Description
200 OK	metadataResults	OK. L’appel d’API a réussi et le résultat des métadonnées se trouve dans la charge utile de réponse
Other Status Codes	errorResponse	Objet de réponse d’erreur.

Sécurité

oauth2

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

metadataGet

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
        ]
      }
    }
  ]
}

Définitions

Nom	Description
Applications	Indication d’autorisation pour les applications Application Insights sur la demande de métadonnées.
Columns	Liste des colonnes définies sur la table
errorDetail	Détails de l’erreur.
errorInfo	Code et message d’une erreur.
errorResponse	Détails de l’erreur.
metadataApplication	Application Insights.
metadataCategory	Catégorie de métadonnées.
MetadataColumnDataType	Type de données de la colonne
metadataFunction	Fonction stockée.
metadataPermissions	Informations d’autorisation.
metadataQuery	Requête stockée.
metadataResourceType	Type de ressource dans Azure.
metadataResults	Réponse aux métadonnées.
metadataSolution	Une solution Log Analytics.
metadataTable	Table de données qui participe à un schéma d’espace de travail.
metadataWorkspace	Un espace de travail Log Analytics.
Related	Éléments de métadonnées associés pour la catégorie
Resources	Indication d’autorisation pour les ressources Azure sur la demande de métadonnées.
Workspaces	Indication d’autorisation pour les espaces de travail sur la demande de métadonnées.

Applications

Indication d’autorisation pour les applications Application Insights sur la demande de métadonnées.

Nom	Type	Description
resourceId	string	ID de ressource sur l’indication d’autorisation.

Columns

Liste des colonnes définies sur la table

Nom	Type	Description
description	string	Description de la colonne
isPreferredFacet	boolean	Indicateur indiquant que cette colonne est une facette préférée
name	string	Nom de la colonne
source	object	une indication de la source de la colonne, utilisée uniquement lorsque plusieurs espaces de travail ont une définition en conflit pour la colonne
type	MetadataColumnDataType	Type de données de la colonne

errorDetail

Détails de l’erreur.

Nom	Type	Description
additionalProperties	object	Propriétés supplémentaires qui peuvent être fournies sur l’objet détails de l’erreur
code	string	Code de l’erreur.
message	string	Message d’erreur lisible par l’homme.
resources	string[]	Indique les ressources responsables de l’erreur.
target	string	Indique la propriété de la requête responsable de l’erreur.
value	string	Indique la valeur dans 'target' qui est responsable de l’erreur.

errorInfo

Code et message d’une erreur.

Nom	Type	Description
additionalProperties	object	Propriétés supplémentaires qui peuvent être fournies sur l’objet d’informations d’erreur
code	string	Code d’erreur lisible par machine.
details	errorDetail[]	détails de l’erreur.
innererror	errorInfo	Code et message d’une erreur. Détails internes de l’erreur s’ils existent.
message	string	Message d’erreur lisible par l’homme.

errorResponse

Détails de l’erreur.

Nom	Type	Description
error	errorInfo	Code et message d’une erreur. Détails de l’erreur.

metadataApplication

Application Insights.

Nom	Type	Description
id	string	ID de l’application Application Insights.
name	string	Nom de l’application Application Insights.
region	string	Région Azure de l’application Application Insights.
related	Related	Éléments de métadonnées associés pour l’application Application Insights.
resourceId	string	ID de ressource ARM de l’application Application Insights.

metadataCategory

Catégorie de métadonnées.

Nom	Type	Description
description	string	Description de la catégorie
displayName	string	Nom d’affichage de la catégorie
id	string	ID de la catégorie
related	Related	Éléments de métadonnées associés pour la catégorie

MetadataColumnDataType

Type de données de la colonne

Nom	Type	Description
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

metadataFunction

Fonction stockée.

Nom	Type	Description
body	string	Corps KQL de la fonction.
description	string	Description de la fonction.
displayName	string	Nom d’affichage de la fonction.
id	string	ID de la fonction.
name	string	Nom de la fonction, à utiliser dans les requêtes.
parameters	string	Paramètres/arguments de la fonction, le cas échéant.
properties	object	Propriétés de la fonction.
related	Related	Éléments de métadonnées associés pour la fonction.
tags	object	Balises associées à la fonction.

metadataPermissions

Informations d’autorisation.

Nom	Type	Description
applications	Applications[]	Indication d’autorisation pour les applications Application Insights sur la demande de métadonnées.
resources	Resources[]	Indication d’autorisation pour les ressources Azure sur la demande de métadonnées.
workspaces	Workspaces[]	Indication d’autorisation pour les espaces de travail sur la demande de métadonnées.

metadataQuery

Requête stockée.

Nom	Type	Description
body	string	Corps KQL de la requête.
description	string	Description de la requête.
displayName	string	Nom d’affichage de la requête.
id	string	ID de la requête.
labels	string[]	Les étiquettes définies par l’utilisateur associées à la requête.
properties	object	Propriétés de la requête.
related	Related	Éléments de métadonnées associés pour la requête.
tags	object	Balises associées à la requête.

metadataResourceType

Type de ressource dans Azure.

Nom	Type	Description
description	string	Description du type de ressource
displayName	string	Nom d’affichage du type de ressource
id	string	ID du type de ressource
labels	string[]	Étiquettes définies par l’utilisateur du type de ressource
properties	object	Propriétés du type de ressource
related	Related	Éléments de métadonnées associés pour le type de ressource
tags	object	Balises associées au type de ressource
type	string	Type du type de ressource

metadataResults

Réponse aux métadonnées.

Nom	Type	Description
applications	metadataApplication[]	Liste des applications Application Insights référencées dans la demande de métadonnées.
categories	metadataCategory[]	Liste des catégories référencées dans cette réponse de métadonnées.
functions	metadataFunction[]	Liste des fonctions stockées dans l’espace de travail ou introduites par des solutions, etc.
permissions	metadataPermissions[]	Liste des règles d’autorisation qui ont affecté la demande de métadonnées.
queries	metadataQuery[]	Liste des requêtes enregistrées stockées dans l’espace de travail ou introduites par des solutions, des types de ressources, etc.
resourceTypes	metadataResourceType[]	Liste des types de ressources référencés dans cette réponse de métadonnées.
resources	metadataResource[]	Liste des ressources Azure référencées dans la demande de métadonnées.
solutions	metadataSolution[]	Liste des solutions Log Analytics installées sur l’espace de travail.
tables	metadataTable[]	Liste des tables et colonnes qui composent le schéma de l’espace de travail.
workspaces	metadataWorkspace[]	Liste des espaces de travail Log Analytics référencés dans la demande de métadonnées.

metadataSolution

Une solution Log Analytics.

Nom	Type	Description
description	string	Description de la solution Log Analytics
displayName	string	Nom d’affichage de la solution Log Analytics
id	string	ID de la solution Log Analytics
name	string	Nom de la solution Log Analytics
properties	object	Propriétés de la solution Log Analytics
related	Related	Éléments de métadonnées associés pour la solution Log Analytics
tags	object	Balises associées à la solution Log Analytics

metadataTable

Table de données qui participe à un schéma d’espace de travail.

Nom	Type	Description
columns	Columns[]	Liste des colonnes définies sur la table
description	string	Description de la table
id	string	ID de la table
labels	string[]	Étiquettes définies par l’utilisateur de la table
name	string	Le nom de la table
properties	object	Propriétés de la table
related	Related	Éléments de métadonnées associés pour la table
tags	object	Balises associées à la table
timespanColumn	string	Colonne associée au paramètre de requête d’intervalle de temps pour la table

metadataWorkspace

Un espace de travail Log Analytics.

Nom	Type	Description
id	string	ID de l’espace de travail Log Analytics.
name	string	Nom de l’espace de travail Log Analytics.
region	string	Région Azure de l’espace de travail Log Analytics.
related	Related	Éléments de métadonnées associés pour l’espace de travail Log Analytics.
resourceId	string	ID de ressource ARM de l’espace de travail Log Analytics.

Éléments de métadonnées associés pour la catégorie

Nom	Type	Description
functions	string[]	Fonctions liées à la catégorie
queries	string[]	Requêtes enregistrées liées à la catégorie
resourceTypes	string[]	Types de ressources liés à la catégorie
solutions	string[]	Les solutions Log Analytics liées à la catégorie
tables	string[]	Tables liées à la catégorie

Resources

Indication d’autorisation pour les ressources Azure sur la demande de métadonnées.

Nom	Type	Description
denyTables	string[]	Liste des tables auxquelles l’accès a été refusé pour l’ID de ressource.
resourceId	string	ID de ressource sur l’indication d’autorisation.

Workspaces

Indication d’autorisation pour les espaces de travail sur la demande de métadonnées.

Nom	Type	Description
denyTables	string[]	Liste des tables auxquelles l’accès a été refusé pour l’ID de ressource.
resourceId	string	ID de ressource sur l’indication d’autorisation.

Partager via

Metadata - Get

Paramètres URI

Réponses

Sécurité

oauth2

Étendues

Exemples

metadataGet

Exemple de requête

Exemple de réponse

Définitions

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Resources

Workspaces

Ressources supplémentaires

Partager via

Metadata - Get

Paramètres URI

Réponses

Sécurité

oauth2

Étendues

Exemples

metadataGet

Exemple de requête

Exemple de réponse

Définitions

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Related

Resources

Workspaces

Ressources supplémentaires