Partager via


Data Connector Definitions - Create Or Update

Crée ou met à jour la définition du connecteur de données.

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

Paramètres URI

Nom Dans Obligatoire Type Description
dataConnectorDefinitionName
path True

string

pattern: ^[a-z0-9A-Z-_]*$

Nom de la définition du connecteur de données.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string (uuid)

ID de l’abonnement cible. La valeur doit être un UUID.

workspaceName
path True

string

minLength: 1
maxLength: 90
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

Nom de l’espace de travail.

api-version
query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Corps de la demande

CustomizableConnectorDefinition

Définition du connecteur pour le type 'Personnalisable'.

Nom Obligatoire Type Description
kind True string:

Customizable

Type de connecteur de données

properties.connectorUiConfig True

CustomizableConnectorUiConfig

Le type de définition de connecteur UiConfig pour 'Personnalisable'.

etag

string

Etag de la ressource Azure

properties.connectionsConfig

CustomizableConnectionsConfig

Le type de définition de connecteur UiConfig pour 'Personnalisable'.

properties.createdTimeUtc

string (date-time)

Obtient ou définit la date de création de la définition du connecteur au format UTC.

properties.lastModifiedUtc

string (date-time)

Obtient ou définit la date de dernière modification de la définition du connecteur au format UTC.

Réponses

Nom Type Description
200 OK DataConnectorDefinition:

CustomizableConnectorDefinition

Updated

201 Created DataConnectorDefinition:

CustomizableConnectorDefinition

Créé

Other Status Codes

CloudError

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

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

Create data connector definition

Exemple de requête

PUT https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5?api-version=2025-09-01

{
  "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"
              }
            }
          ]
        }
      ]
    }
  }
}

Exemple de réponse

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "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"
        }
      ],
      "sampleQueries": [
        {
          "description": "All logs",
          "query": "GitHubAuditLogPolling_CL \n | take 10"
        }
      ],
      "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"
              }
            }
          ]
        }
      ]
    }
  }
}
{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "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"
        }
      ],
      "sampleQueries": [
        {
          "description": "All logs",
          "query": "GitHubAuditLogPolling_CL \n | take 10"
        }
      ],
      "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"
              }
            }
          ]
        }
      ]
    }
  }
}

Définitions

Nom Description
CloudError

Structure de réponse d’erreur.

CloudErrorBody

Détails de l’erreur.

ConnectivityCriterion

Les critères par lesquels nous déterminons si le connecteur est connecté ou non. Par exemple, utilisez une requête KQL pour vérifier si le type de données attendu est fluide.

ConnectorDataType

Type de données créé par le connecteur, y compris une requête indiquant la date de la dernière réception de ce type de données dans l’espace de travail.

ConnectorDefinitionsAvailability

L’état d’exposition 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 puisse créer des connexions. L’utilisateur doit disposer des autorisations requises (Lecture\Écriture, ..) dans l’étendue spécifiée ProviderPermissionsScope sur le fournisseur de ressources spécifié.

createdByType

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

CustomizableConnectionsConfig

Le type de définition de connecteur UiConfig pour 'Personnalisable'.

CustomizableConnectorDefinition

Définition du connecteur pour le type 'Personnalisable'.

CustomizableConnectorUiConfig

Le type de définition de connecteur UiConfig pour 'Personnalisable'.

CustomPermissionDetails

Les autorisations personnalisées requises pour le connecteur.

DataConnectorDefinitionKind

Le type de définitions du connecteur de données

GraphQuery

La requête 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

L’étendue sur laquelle l’utilisateur doit disposer des autorisations, afin de pouvoir créer des connexions.

ResourceProviderRequiredPermissions

Autorisations requises pour le fournisseur de ressources du connecteur définies dans ResourceProviders. Pour plus d’informations sur les autorisations, voir <voir href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format" ;>ici</voir>.

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 programme.

message

string

Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.

ConnectivityCriterion

Les critères par lesquels nous déterminons si le connecteur est connecté ou non. Par exemple, utilisez une requête KQL pour vérifier si le type de données attendu est fluide.

Nom Type Description
type

string

Obtient ou définit le type de connectivité.

value

string[]

Obtient ou définit les requêtes de vérification de la connectivité.

ConnectorDataType

Type de données créé par le connecteur, y compris une requête indiquant la date de la dernière réception de ce type de données dans l’espace de travail.

Nom Type Description
lastDataReceivedQuery

string

Obtient ou définit la requête pour indiquer la date de la dernière réception des données pertinentes dans l’espace de travail.

name

string

Obtient ou définit le nom du type de données à afficher dans le graphique.

ConnectorDefinitionsAvailability

L’état d’exposition 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 (int32)

L’état d’exposition du connecteur aux clients. Les valeurs disponibles sont comprises entre 0 et 4 (0 = Aucun, 1 = Disponible, 2 = FeatureFlag, 3 = Interne).

ConnectorDefinitionsPermissions

Autorisations requises pour le connecteur.

Nom Type Description
customs

CustomPermissionDetails[]

Obtient ou définit les autorisations douanières requises pour que l’utilisateur puisse créer des connexions.

licenses

string[]

Obtient ou définit les licences requises pour que l’utilisateur puisse créer des connexions.

resourceProvider

ConnectorDefinitionsResourceProvider[]

Obtient ou définit les autorisations du fournisseur de ressources requises pour que l’utilisateur puisse créer 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 puisse créer des connexions. L’utilisateur doit disposer des autorisations requises (Lecture\Écriture, ..) 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 du connecteur définies dans ResourceProviders. Pour plus d’informations sur les autorisations, voir <voir href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format" ;>ici</voir>.

scope

ProviderPermissionsScope

L’étendue sur laquelle l’utilisateur doit disposer des autorisations, afin de pouvoir créer des connexions.

createdByType

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

Valeur Description
User
Application
ManagedIdentity
Key

CustomizableConnectionsConfig

Le type de définition de connecteur UiConfig pour 'Personnalisable'.

Nom Type Description
templateSpecName

string

Obtient ou définit le nom du modèle. Le modèle comprend des modèles ARM qui peuvent être créés par le connecteur, généralement les 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 (arm-id)

ID de ressource complet pour la ressource. Par exemple, « /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

Le type de définition de connecteur UiConfig pour 'Personnalisable'.

properties.connectorUiConfig

CustomizableConnectorUiConfig

Le type de définition de connecteur UiConfig pour 'Personnalisable'.

properties.createdTimeUtc

string (date-time)

Obtient ou définit la date de création de la définition du connecteur au format UTC.

properties.lastModifiedUtc

string (date-time)

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

Le type de définition de connecteur UiConfig pour 'Personnalisable'.

Nom Type Description
availability

ConnectorDefinitionsAvailability

L’état d’exposition du connecteur aux clients.

connectivityCriteria

ConnectivityCriterion[]

Obtient ou définit la façon dont le connecteur vérifie s’il est connecté.

dataTypes

ConnectorDataType[]

Obtient ou définit les types de données pour vérifier 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 graphiques pour afficher le volume de données actuel au fil du temps.

id

string

Obtient ou définit le champ facultatif ID de connecteur personnalisé.

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 de connecteurs 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 de la lame de connecteur.

CustomPermissionDetails

Les 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

Le type de définitions du connecteur de données

Valeur Description
Customizable

GraphQuery

La requête 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 du 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 : 'Total des 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 internes. Par exemple : l’étape d’instruction 1 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 de type d’instruction.

type

string

Obtient ou définit le nom du type d’instruction.

ProviderPermissionsScope

L’étendue sur laquelle l’utilisateur doit disposer des autorisations, afin de pouvoir créer des connexions.

Valeur Description
Subscription
ResourceGroup
Workspace

ResourceProviderRequiredPermissions

Autorisations requises pour le fournisseur de ressources du connecteur définies dans ResourceProviders. Pour plus d’informations sur les autorisations, voir <voir href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format" ;>ici</voir>.

Nom Type Description
action

boolean

Obtient ou définit une valeur indiquant s’il s’agit d’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 s’il s’agit d’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 (date-time)

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 (date-time)

Horodatage de la dernière modification de 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.