Partager via


Microsoft.SecurityInsights sourcecontrols 2022-08-01-preview

Définition de ressource Bicep

Le type de ressource sourcecontrols est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la scope propriété sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue des ressources d’extension dans Bicep.

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.SecurityInsights/sourcecontrols, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.SecurityInsights/sourcecontrols@2022-08-01-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  etag: 'string'
  properties: {
    contentTypes: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    id: 'string'
    lastDeploymentInfo: {
      deployment: {
        deploymentId: 'string'
        deploymentLogsUrl: 'string'
        deploymentResult: 'string'
        deploymentState: 'string'
        deploymentTime: 'string'
      }
      deploymentFetchStatus: 'string'
      message: 'string'
    }
    repository: {
      branch: 'string'
      deploymentLogsUrl: 'string'
      displayUrl: 'string'
      pathMapping: [
        {
          contentType: 'string'
          path: 'string'
        }
      ]
      url: 'string'
    }
    repositoryResourceInfo: {
      azureDevOpsResourceInfo: {
        pipelineId: 'string'
        serviceConnectionId: 'string'
      }
      gitHubResourceInfo: {
        appInstallationId: 'string'
      }
      webhook: {
        rotateWebhookSecret: bool
        webhookId: 'string'
        webhookSecretUpdateTime: 'string'
        webhookUrl: 'string'
      }
    }
    repoType: 'string'
    version: 'string'
  }
}

Valeurs de propriétés

sourcecontrols

Nom Description Valeur
name Nom de la ressource string (obligatoire)
scope Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue de déploiement. Ressource cible

Pour Bicep, définissez cette propriété sur le nom symbolique de la ressource pour appliquer la ressource d’extension.
etag Etag de la ressource Azure string
properties propriétés du contrôle de code source SourceControlProperties

SourceControlProperties

Nom Description Valeur
contentTypes Tableau de types de contenu de contrôle de code source. Tableau de chaînes contenant l’un des éléments suivants :
'AnalyticRule'
'Workbook' (obligatoire)
description Description du contrôle de code source string
displayName Nom complet du contrôle de code source string (obligatoire)
id ID (guid) du contrôle de code source string
lastDeploymentInfo Informations concernant le dernier déploiement pour le contrôle de code source. DeploymentInfo
repository Métadonnées du référentiel. Dépôt (obligatoire)
repositoryResourceInfo Informations concernant les ressources créées dans le référentiel de l’utilisateur. RepositoryResourceInfo
repoType Type de dépôt du contrôle de code source 'DevOps'
'Github' (obligatoire)
version Numéro de version associé au contrôle de code source 'V1'
'V2'

DeploymentInfo

Nom Description Valeur
deployment Informations relatives au déploiement. Déploiement
deploymentFetchStatus État lors de l’extraction du dernier déploiement. 'NotFound'
« Succès »
'Non autorisé'
message Détails supplémentaires sur le déploiement qui peuvent être affichés à l’utilisateur. string

Déploiement

Nom Description Valeur
deploymentId Identificateur de déploiement. string
deploymentLogsUrl URL pour accéder aux journaux d’action du référentiel. string
deploymentResult Résultat du déploiement. 'Annulé'
'Échec'
« Succès »
deploymentState État actuel du déploiement. 'Annulation'
'Terminé'
'In_Progress'
'Mis en file d’attente'
deploymentTime Heure à laquelle le déploiement s’est terminé. string

Référentiel

Nom Description Valeur
branche Nom de la branche du dépôt. string
deploymentLogsUrl URL pour accéder aux journaux d’action du référentiel. string
displayUrl Afficher l’URL du référentiel. string
pathMapping Dictionnaire du type de contenu de contrôle de code source et du mappage de chemin d’accès. ContentPathMap[]
url URL du référentiel. string

ContentPathMap

Nom Description Valeur
contentType Type de contenu. 'AnalyticRule'
'Classeur'
path Chemin d’accès au contenu. string

RepositoryResourceInfo

Nom Description Valeur
azureDevOpsResourceInfo Ressources créées dans Azure DevOps pour ce contrôle de code source. AzureDevOpsResourceInfo
gitHubResourceInfo Ressources créées dans GitHub pour ce contrôle de code source. GitHubResourceInfo
webhook Objet webhook créé pour le contrôle de code source. Webhook

AzureDevOpsResourceInfo

Nom Description Valeur
pipelineId ID du pipeline créé pour le contrôle de code source. string
serviceConnectionId ID de la connexion de service créée pour le contrôle de code source. string

GitHubResourceInfo

Nom Description Valeur
appInstallationId ID d’installation de l’application GitHub. string

webhook

Nom Description Valeur
rotateWebhookSecret Indicateur pour indiquer au service principal de faire pivoter le secret du webhook. bool
webhookId Identificateur unique pour le webhook. string
webhookSecretUpdateTime Heure à laquelle le secret du webhook a été mis à jour. string
webhookUrl URL appelée par le webhook. string

Définition de ressources de modèle ARM

Le type de ressource sourcecontrols est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la scope propriété sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue des ressources d’extension dans les modèles ARM.

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.SecurityInsights/sourcecontrols, ajoutez le JSON suivant à votre modèle.

{
  "type": "Microsoft.SecurityInsights/sourcecontrols",
  "apiVersion": "2022-08-01-preview",
  "name": "string",
  "scope": "string",
  "etag": "string",
  "properties": {
    "contentTypes": [ "string" ],
    "description": "string",
    "displayName": "string",
    "id": "string",
    "lastDeploymentInfo": {
      "deployment": {
        "deploymentId": "string",
        "deploymentLogsUrl": "string",
        "deploymentResult": "string",
        "deploymentState": "string",
        "deploymentTime": "string"
      },
      "deploymentFetchStatus": "string",
      "message": "string"
    },
    "repository": {
      "branch": "string",
      "deploymentLogsUrl": "string",
      "displayUrl": "string",
      "pathMapping": [
        {
          "contentType": "string",
          "path": "string"
        }
      ],
      "url": "string"
    },
    "repositoryResourceInfo": {
      "azureDevOpsResourceInfo": {
        "pipelineId": "string",
        "serviceConnectionId": "string"
      },
      "gitHubResourceInfo": {
        "appInstallationId": "string"
      },
      "webhook": {
        "rotateWebhookSecret": "bool",
        "webhookId": "string",
        "webhookSecretUpdateTime": "string",
        "webhookUrl": "string"
      }
    },
    "repoType": "string",
    "version": "string"
  }
}

Valeurs de propriétés

sourcecontrols

Nom Description Valeur
type Type de ressource « Microsoft.SecurityInsights/sourcecontrols »
apiVersion Version de l’API de ressource '2022-08-01-preview'
name Nom de la ressource string (obligatoire)
scope Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue de déploiement. Ressource cible

Pour JSON, définissez la valeur sur le nom complet de la ressource à laquelle appliquer la ressource d’extension .
etag Etag de la ressource Azure string
properties propriétés du contrôle de code source SourceControlProperties

SourceControlProperties

Nom Description Valeur
contentTypes Tableau de types de contenu de contrôle de code source. Tableau de chaînes contenant l’un des éléments suivants :
'AnalyticRule'
'Workbook' (obligatoire)
description Description du contrôle de code source string
displayName Nom complet du contrôle de code source string (obligatoire)
id ID (guid) du contrôle de code source string
lastDeploymentInfo Informations concernant le dernier déploiement pour le contrôle de code source. DeploymentInfo
repository Métadonnées du référentiel. Dépôt (obligatoire)
repositoryResourceInfo Informations concernant les ressources créées dans le référentiel de l’utilisateur. RepositoryResourceInfo
repoType Type de dépôt du contrôle de code source 'DevOps'
'Github' (obligatoire)
version Numéro de version associé au contrôle de code source 'V1'
'V2'

DeploymentInfo

Nom Description Valeur
deployment Informations relatives au déploiement. Déploiement
deploymentFetchStatus État lors de l’extraction du dernier déploiement. 'NotFound'
« Succès »
'Non autorisé'
message Détails supplémentaires sur le déploiement qui peuvent être affichés à l’utilisateur. string

Déploiement

Nom Description Valeur
deploymentId Identificateur de déploiement. string
deploymentLogsUrl URL permettant d’accéder aux journaux d’action du dépôt. string
deploymentResult Résultat du déploiement. 'Canceled'
'Failed'
« Succès »
deploymentState État actuel du déploiement. 'Annulation'
'Completed'
'In_Progress'
'Mis en file d’attente'
deploymentTime Heure à laquelle le déploiement s’est terminé. string

Référentiel

Nom Description Valeur
branche Nom de la branche du dépôt. string
deploymentLogsUrl URL permettant d’accéder aux journaux d’action du dépôt. string
displayUrl Url d’affichage du dépôt. string
pathMapping Dictionnaire du type de contenu du contrôle de code source et du mappage de chemin d’accès. ContentPathMap[]
url URL du dépôt. string

ContentPathMap

Nom Description Valeur
contentType Type de contenu. 'AnalyticRule'
'Workbook'
path Chemin d’accès au contenu. string

RepositoryResourceInfo

Nom Description Valeur
azureDevOpsResourceInfo Ressources créées dans Azure DevOps pour ce contrôle de code source. AzureDevOpsResourceInfo
gitHubResourceInfo Ressources créées dans GitHub pour ce contrôle de code source. GitHubResourceInfo
webhook Objet webhook créé pour le contrôle de code source. Webhook

AzureDevOpsResourceInfo

Nom Description Valeur
pipelineId ID du pipeline créé pour le contrôle de code source. string
serviceConnectionId ID de la connexion de service créée pour le contrôle de code source. string

GitHubResourceInfo

Nom Description Valeur
appInstallationId ID d’installation de l’application GitHub. string

webhook

Nom Description Valeur
rotateWebhookSecret Indicateur pour indiquer au service back-end de faire pivoter le secret du webhook. bool
webhookId Identificateur unique du webhook. string
webhookSecretUpdateTime Heure à laquelle le secret du webhook a été mis à jour. string
webhookUrl URL appelée par le webhook. string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource sourcecontrols est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la parent_id propriété sur cette ressource pour définir l’étendue de cette ressource.

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.SecurityInsights/sourcecontrols, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SecurityInsights/sourcecontrols@2022-08-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      contentTypes = [
        "string"
      ]
      description = "string"
      displayName = "string"
      id = "string"
      lastDeploymentInfo = {
        deployment = {
          deploymentId = "string"
          deploymentLogsUrl = "string"
          deploymentResult = "string"
          deploymentState = "string"
          deploymentTime = "string"
        }
        deploymentFetchStatus = "string"
        message = "string"
      }
      repository = {
        branch = "string"
        deploymentLogsUrl = "string"
        displayUrl = "string"
        pathMapping = [
          {
            contentType = "string"
            path = "string"
          }
        ]
        url = "string"
      }
      repositoryResourceInfo = {
        azureDevOpsResourceInfo = {
          pipelineId = "string"
          serviceConnectionId = "string"
        }
        gitHubResourceInfo = {
          appInstallationId = "string"
        }
        webhook = {
          rotateWebhookSecret = bool
          webhookId = "string"
          webhookSecretUpdateTime = "string"
          webhookUrl = "string"
        }
      }
      repoType = "string"
      version = "string"
    }
    etag = "string"
  })
}

Valeurs de propriétés

sourcecontrols

Nom Description Valeur
type Type de ressource « Microsoft.SecurityInsights/sourcecontrols@2022-08-01-preview »
name Nom de la ressource string (obligatoire)
parent_id ID de la ressource à laquelle appliquer cette ressource d’extension. string (obligatoire)
etag Etag de la ressource Azure string
properties propriétés du contrôle de code source SourceControlProperties

SourceControlProperties

Nom Description Valeur
contentTypes Tableau de types de contenu de contrôle de code source. Tableau de chaînes contenant l’un des éléments suivants :
« AnalyticRule »
« Classeur » (obligatoire)
description Description du contrôle de code source string
displayName Nom d’affichage du contrôle de code source chaîne (obligatoire)
id ID (guid) du contrôle de code source string
lastDeploymentInfo Informations sur le dernier déploiement pour le contrôle de code source. DeploymentInfo
repository Métadonnées du référentiel. Dépôt (obligatoire)
repositoryResourceInfo Informations relatives aux ressources créées dans le référentiel de l’utilisateur. RepositoryResourceInfo
repoType Type de dépôt du contrôle de code source « DevOps »
« Github » (obligatoire)
version Numéro de version associé au contrôle de code source « V1 »
« V2 »

DeploymentInfo

Nom Description Valeur
deployment Informations relatives au déploiement. Déploiement
deploymentFetchStatus État lors de l’extraction du dernier déploiement. « NotFound »
« Success »
« Non autorisé »
message Détails supplémentaires sur le déploiement qui peuvent être affichés à l’utilisateur. string

Déploiement

Nom Description Valeur
deploymentId Identificateur de déploiement. string
deploymentLogsUrl URL pour accéder aux journaux d’action du référentiel. string
deploymentResult Résultat du déploiement. « Annulé »
« Échec »
« Success »
deploymentState État actuel du déploiement. « Annulation »
« Terminé »
« In_Progress »
« Mis en file d’attente »
deploymentTime Heure à laquelle le déploiement s’est terminé. string

Référentiel

Nom Description Valeur
branche Nom de la branche du dépôt. string
deploymentLogsUrl URL pour accéder aux journaux d’action du référentiel. string
displayUrl Afficher l’URL du référentiel. string
pathMapping Dictionnaire du type de contenu de contrôle de code source et du mappage de chemin d’accès. ContentPathMap[]
url URL du référentiel. string

ContentPathMap

Nom Description Valeur
contentType Type de contenu. « AnalyticRule »
« Classeur »
path Chemin d’accès au contenu. string

RepositoryResourceInfo

Nom Description Valeur
azureDevOpsResourceInfo Ressources créées dans Azure DevOps pour ce contrôle de code source. AzureDevOpsResourceInfo
gitHubResourceInfo Ressources créées dans GitHub pour ce contrôle de code source. GitHubResourceInfo
webhook Objet webhook créé pour le contrôle de code source. Webhook

AzureDevOpsResourceInfo

Nom Description Valeur
pipelineId ID du pipeline créé pour le contrôle de code source. string
serviceConnectionId ID de la connexion de service créée pour le contrôle de code source. string

GitHubResourceInfo

Nom Description Valeur
appInstallationId ID d’installation de l’application GitHub. string

webhook

Nom Description Valeur
rotateWebhookSecret Indicateur pour indiquer au service back-end de faire pivoter le secret du webhook. bool
webhookId Identificateur unique du webhook. string
webhookSecretUpdateTime Heure à laquelle le secret du webhook a été mis à jour. string
webhookUrl URL appelée par le webhook. string