Data Connector Definitions - Get

Référence

Service:: Sentinel

API Version:: 2024-01-01-preview

Obtient une définition de connecteur de données.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/{dataConnectorDefinitionName}?api-version=2024-01-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dataConnectorDefinitionName	path	True	string	Nom de la définition du connecteur de données. Regex pattern: `^[a-z0-9A-Z-_]*$`
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
workspaceName	path	True	string	Nom de l’espace de travail. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	DataConnectorDefinition: CustomizableConnectorDefinition	Succès
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Exemples

Get customize data connector definition

Sample Request

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12?api-version=2024-01-01-preview

Sample Response

Status code:: 200

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12",
  "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12",
  "type": "Microsoft.SecurityInsights/dataConnectorDefinitions",
  "kind": "Customizable",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "connectorUiConfig": {
      "title": "GitHub Enterprise Audit Log",
      "publisher": "GitHub",
      "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.",
      "graphQueries": [
        {
          "metricName": "Total events received",
          "legend": "GitHub audit log events",
          "baseQuery": "GitHubAuditLogPolling_CL"
        }
      ],
      "dataTypes": [
        {
          "name": "GitHubAuditLogPolling_CL",
          "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n            | summarize Time = max(TimeGenerated)\n            | where isnotempty(Time)"
        }
      ],
      "connectivityCriteria": [
        {
          "type": "IsConnectedQuery",
          "value": [
            "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)"
          ]
        }
      ],
      "availability": {
        "status": 1,
        "isPreview": false
      },
      "permissions": {
        "resourceProvider": [
          {
            "provider": "Microsoft.OperationalInsights/workspaces",
            "permissionsDisplayText": "read and write permissions are required.",
            "providerDisplayName": "Workspace",
            "scope": "Workspace",
            "requiredPermissions": {
              "write": true,
              "read": false,
              "delete": false,
              "action": false
            }
          }
        ],
        "customs": [
          {
            "name": "GitHub API personal token Key",
            "description": "You need access to GitHub personal token, the key should have 'admin:org' scope"
          }
        ]
      },
      "instructionSteps": [
        {
          "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel",
          "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key",
          "instructions": [
            {
              "type": "OAuthForm",
              "parameters": {
                "clientIdLabel": "Client ID",
                "clientSecretLabel": "Client Secret",
                "connectButtonLabel": "Connect",
                "disconnectButtonLabel": "Disconnect"
              }
            }
          ]
        }
      ]
    },
    "connectionsConfig": {
      "templateSpecName": "templateNameMock",
      "templateSpecVersion": "1.0.0"
    }
  }
}

Définitions

Nom	Description
CloudError	Structure de réponse d’erreur.
CloudErrorBody	Détails de l’erreur.
ConnectivityCriterion	Critères selon lesquels nous déterminons si le connecteur est connecté ou non. Par exemple, utilisez une requête KQL pour case activée si le type de données attendu circule).
ConnectorDataType	Type de données créé par le connecteur, y compris une requête indiquant quand a été la dernière fois que ce type de données a été reçu dans l’espace de travail.
ConnectorDefinitionsAvailability	Exposition status du connecteur aux clients.
ConnectorDefinitionsPermissions	Autorisations requises pour le connecteur.
ConnectorDefinitionsResourceProvider	Les détails du fournisseur de ressources incluent les autorisations requises pour que l’utilisateur crée des connexions. L’utilisateur doit disposer des autorisations requises (Read\Write, ..) dans l’étendue Spécifiée ProviderPermissionsScope sur le fournisseur de ressources spécifié.
createdByType	Type d’identité qui a créé la ressource.
CustomizableConnectionsConfig	Type de définition de connecteur « Personnalisable » uiConfig.
CustomizableConnectorDefinition	Définition du connecteur pour le type « Personnalisable ».
CustomizableConnectorUiConfig	Type de définition de connecteur « Personnalisable » uiConfig.
CustomPermissionDetails	Autorisations personnalisées requises pour le connecteur.
DataConnectorDefinitionKind	Type de définitions de connecteur de données
GraphQuery	Requête de graphique pour afficher le volume de données arrivant dans l’espace de travail au fil du temps.
InstructionStep	Étapes d’instruction pour activer le connecteur.
InstructionStepDetails	Détails de l’étape d’instruction, à afficher dans la section Étapes d’instructions de la page du connecteur dans le portail Sentinel.
ProviderPermissionsScope	Étendue sur laquelle l’utilisateur doit disposer d’autorisations pour pouvoir créer des connexions.
ResourceProviderRequiredPermissions	Autorisations requises pour le fournisseur de ressources de connecteur qui définissent dans ResourceProviders. Pour plus d’informations sur les autorisations, consultez ici.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CloudError

Structure de réponse d’erreur.

Nom	Type	Description
error	CloudErrorBody	Données d’erreur

CloudErrorBody

Détails de l’erreur.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message	string	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.

ConnectivityCriterion

Critères selon lesquels nous déterminons si le connecteur est connecté ou non. Par exemple, utilisez une requête KQL pour case activée si le type de données attendu circule).

Nom	Type	Description
type	string	Obtient ou définit le type de connectivité.
value	string[]	Obtient ou définit les requêtes pour la vérification de la connectivité.

ConnectorDataType

Type de données créé par le connecteur, y compris une requête indiquant quand a été la dernière fois que ce type de données a été reçu dans l’espace de travail.

Nom	Type	Description
lastDataReceivedQuery	string	Obtient ou définit la requête pour indiquer quand les données pertinentes ont été reçues pour la dernière fois dans l’espace de travail.
name	string	Obtient ou définit le nom du type de données à afficher dans le graphique.

ConnectorDefinitionsAvailability

Exposition status du connecteur aux clients.

Nom	Type	Description
isPreview	boolean	Obtient ou définit une valeur indiquant si le connecteur est en préversion.
status	integer	Exposition status du connecteur aux clients. Les valeurs disponibles sont 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).

ConnectorDefinitionsPermissions

Autorisations requises pour le connecteur.

Nom	Type	Description
customs	CustomPermissionDetails[]	Obtient ou définit les autorisations douanières requises pour que l’utilisateur crée des connexions.
licenses	string[]	Obtient ou définit les licences requises pour que l’utilisateur crée des connexions.
resourceProvider	ConnectorDefinitionsResourceProvider[]	Obtient ou définit les autorisations de fournisseur de ressources requises pour que l’utilisateur crée des connexions.
tenant	string[]	Obtient ou définit les autorisations de locataire requises pour le connecteur.

ConnectorDefinitionsResourceProvider

Les détails du fournisseur de ressources incluent les autorisations requises pour que l’utilisateur crée des connexions. L’utilisateur doit disposer des autorisations requises (Read\Write, ..) dans l’étendue Spécifiée ProviderPermissionsScope sur le fournisseur de ressources spécifié.

Nom	Type	Description
permissionsDisplayText	string	Obtient ou définit le texte de description des autorisations.
provider	string	Obtient ou définit le nom du fournisseur.
providerDisplayName	string	Obtient ou définit le nom complet du fournisseur d’autorisations.
requiredPermissions	ResourceProviderRequiredPermissions	Autorisations requises pour le fournisseur de ressources de connecteur qui définissent dans ResourceProviders. Pour plus d’informations sur les autorisations, consultez ici.
scope	ProviderPermissionsScope	Étendue sur laquelle l’utilisateur doit disposer d’autorisations pour pouvoir créer des connexions.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomizableConnectionsConfig

Type de définition de connecteur « Personnalisable » uiConfig.

Nom	Type	Description
templateSpecName	string	Obtient ou définit le nom du modèle. Le modèle inclut des modèles ARM qui peuvent être créés par le connecteur. Il s’agit généralement des modèles ARM dataConnectors.
templateSpecVersion	string	Obtient ou définit la version du modèle.

CustomizableConnectorDefinition

Définition du connecteur pour le type « Personnalisable ».

Nom	Type	Description
etag	string	Etag de la ressource Azure
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: Customizable	Type de connecteur de données
name	string	nom de la ressource.
properties.connectionsConfig	CustomizableConnectionsConfig	Type de définition de connecteur « Personnalisable » uiConfig.
properties.connectorUiConfig	CustomizableConnectorUiConfig	Type de définition de connecteur « Personnalisable » uiConfig.
properties.createdTimeUtc	string	Obtient ou définit la date de création de la définition du connecteur au format UTC.
properties.lastModifiedUtc	string	Obtient ou définit la date de dernière modification de la définition du connecteur au format UTC.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

CustomizableConnectorUiConfig

Type de définition de connecteur « Personnalisable » uiConfig.

Nom	Type	Description
availability	ConnectorDefinitionsAvailability	Exposition status du connecteur aux clients.
connectivityCriteria	ConnectivityCriterion[]	Obtient ou définit la façon dont le connecteur vérifie si le connecteur est connecté.
dataTypes	ConnectorDataType[]	Obtient ou définit les types de données sur case activée pour les dernières données reçues.
descriptionMarkdown	string	Obtient ou définit la description du connecteur au format Markdown.
graphQueries	GraphQuery[]	Obtient ou définit les requêtes de graphe pour afficher le volume de données actuel dans le temps.
id	string	Obtient ou définit l’ID de connecteur personnalisé. champ facultatif.
instructionSteps	InstructionStep[]	Obtient ou définit les étapes d’instruction pour activer le connecteur.
isConnectivityCriteriasMatchSome	boolean	Obtient ou définit une valeur indiquant s’il faut utiliser 'OR'(SOME) ou 'AND' entre les éléments ConnectivityCriteria.
logo	string	Obtient ou définit le logo du connecteur à utiliser lors de l’affichage du connecteur dans la galerie du connecteur d’Azure Sentinel. La valeur du logo doit être au format SVG.
permissions	ConnectorDefinitionsPermissions	Autorisations requises pour le connecteur.
publisher	string	Obtient ou définit le nom de l’éditeur du connecteur.
title	string	Obtient ou définit le titre du panneau du connecteur.

CustomPermissionDetails

Autorisations personnalisées requises pour le connecteur.

Nom	Type	Description
description	string	Obtient ou définit la description des autorisations personnalisées.
name	string	Obtient ou définit le nom des autorisations personnalisées.

DataConnectorDefinitionKind

Type de définitions de connecteur de données

Nom	Type	Description
Customizable	string

GraphQuery

Requête de graphique pour afficher le volume de données arrivant dans l’espace de travail au fil du temps.

Nom	Type	Description
baseQuery	string	Obtient ou définit la requête de base pour le graphique. La requête de base est encapsulée par l’infrastructure de l’interface utilisateur Sentinel avec une requête KQL, qui mesure le volume au fil du temps.
legend	string	Obtient ou définit la légende du graphique.
metricName	string	Obtient ou définit le nom de la métrique que la requête vérifie. Par exemple : « Nombre total de données reçues ».

InstructionStep

Étapes d’instruction pour activer le connecteur.

Nom	Type	Description
description	string	Obtient ou définit la description de l’étape d’instruction.
innerSteps	InstructionStep[]	Obtient ou définit les détails des étapes d’instruction interne. Exemple d’ennemi : l’étape 1 de l’instruction peut contenir des étapes d’instruction internes : [étape d’instruction 1.1, étape d’instruction 1.2].
instructions	InstructionStepDetails[]	Obtient ou définit les détails de l’étape d’instruction.
title	string	Obtient ou définit le titre de l’étape d’instruction.

InstructionStepDetails

Détails de l’étape d’instruction, à afficher dans la section Étapes d’instructions de la page du connecteur dans le portail Sentinel.

Nom	Type	Description
parameters	object	Obtient ou définit les paramètres des paramètres de type d’instruction.
type	string	Obtient ou définit le nom du type d’instruction.

ProviderPermissionsScope

Étendue sur laquelle l’utilisateur doit disposer d’autorisations pour pouvoir créer des connexions.

Nom	Type	Description
ResourceGroup	string
Subscription	string
Workspace	string

ResourceProviderRequiredPermissions

Autorisations requises pour le fournisseur de ressources de connecteur qui définissent dans ResourceProviders. Pour plus d’informations sur les autorisations, consultez ici.

Nom	Type	Description
action	boolean	Obtient ou définit une valeur indiquant si l’autorisation est des actions personnalisées (POST).
delete	boolean	Obtient ou définit une valeur indiquant si l’autorisation est une action de suppression (DELETE).
read	boolean	Obtient ou définit une valeur indiquant si l’autorisation est une action de lecture (GET).
write	boolean	Obtient ou définit une valeur indiquant si l’autorisation est une action d’écriture (PUT ou PATCH).

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via