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=2024-01-01-preview
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
data
|
path | True |
string |
Nom de la définition du connecteur de données. Modèle d’expression régulière: |
resource
|
path | True |
string |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
subscription
|
path | True |
string |
ID de l’abonnement cible. |
workspace
|
path | True |
string |
Nom de l’espace de travail. Modèle d’expression régulière: |
api-version
|
query | True |
string |
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 |
Type de définition de connecteur UiConfig pour « Personnalisable ». |
|
etag |
string |
Etag de la ressource Azure |
|
properties.connectionsConfig |
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. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK | DataConnectorDefinition: |
Mis à jour |
201 Created | DataConnectorDefinition: |
Date de création |
Other Status Codes |
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
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=2024-01-01-preview
{
"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 |
---|---|
Cloud |
Structure de réponse d’erreur. |
Cloud |
Détails de l’erreur. |
Connectivity |
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). |
Connector |
Type de données créé par le connecteur, y compris une requête indiquant quand a été la dernière fois que le type de données a été reçu dans l’espace de travail. |
Connector |
Exposition status du connecteur aux clients. |
Connector |
Autorisations requises pour le connecteur. |
Connector |
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 par rapport au fournisseur de ressources spécifié. |
created |
Type d’identité qui a créé la ressource. |
Customizable |
Type de définition de connecteur UiConfig pour « Personnalisable ». |
Customizable |
Définition du connecteur pour le type « Personnalisable ». |
Customizable |
Type de définition de connecteur UiConfig pour « Personnalisable ». |
Custom |
Autorisations personnalisées requises pour le connecteur. |
Data |
Type de définitions de connecteur de données |
Graph |
Requête de graphique pour afficher le volume de données arrivant dans l’espace de travail au fil du temps. |
Instruction |
Étapes d’instruction pour activer le connecteur. |
Instruction |
Détails de l’étape d’instruction, à afficher dans la section Étapes d’instructions de la page du connecteur dans le portail Sentinel. |
Provider |
Étendue sur laquelle l’utilisateur doit disposer d’autorisations pour pouvoir créer des connexions. |
Resource |
Autorisations requises pour le fournisseur de ressources de connecteur défini dans ResourceProviders. Pour plus d’informations sur les autorisations, consultez ici. |
system |
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 |
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 adapté à l’affichage 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 de 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 le 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 de 0 à 4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal). |
ConnectorDefinitionsPermissions
Autorisations requises pour le connecteur.
Nom | Type | Description |
---|---|---|
customs |
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 |
Obtient ou définit les autorisations du 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 par rapport au 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 d’affichage du fournisseur d’autorisations. |
requiredPermissions |
Autorisations requises pour le fournisseur de ressources de connecteur défini dans ResourceProviders. Pour plus d’informations sur les autorisations, consultez ici. |
|
scope |
É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 UiConfig pour « Personnalisable ».
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 |
Type de définition de connecteur UiConfig pour « Personnalisable ». |
|
properties.connectorUiConfig |
Type de définition de connecteur UiConfig pour « Personnalisable ». |
|
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 |
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 UiConfig pour « Personnalisable ».
Nom | Type | Description |
---|---|---|
availability |
Exposition status du connecteur aux clients. |
|
connectivityCriteria |
Obtient ou définit la façon dont le connecteur vérifie si le connecteur est connecté. |
|
dataTypes |
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 |
Obtient ou définit les requêtes de graphe pour afficher le volume de données actuel au fil du temps. |
|
id |
string |
Obtient ou définit l’ID de connecteur personnalisé. champ facultatif. |
instructionSteps |
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 |
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 graphe. 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 graphe. |
metricName |
string |
Obtient ou définit le nom de la métrique que la requête vérifie. Par exemple : « Total data receive ». |
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 |
Obtient ou définit les détails des étapes d’instruction internes. 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 |
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 défini 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 l’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 |
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 dernière ressource. |
lastModifiedByType |
Type d’identité qui a modifié la dernière ressource. |