Share via


Évaluations Microsoft.Security

Définition de ressource Bicep

Le type de ressource d’évaluation 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.

Le type de ressource d’évaluation peut être déployé avec des opérations qui ciblent :

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.Security/assessments, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Security/assessments@2021-06-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    additionalData: {
      {customized property}: 'string'
    }
    metadata: {
      assessmentType: 'string'
      categories: [
        'string'
      ]
      description: 'string'
      displayName: 'string'
      implementationEffort: 'string'
      partnerData: {
        partnerName: 'string'
        productName: 'string'
        secret: 'string'
      }
      preview: bool
      remediationDescription: 'string'
      severity: 'string'
      threats: [
        'string'
      ]
      userImpact: 'string'
    }
    partnersData: {
      partnerName: 'string'
      secret: 'string'
    }
    resourceDetails: {
      source: 'string'
      // For remaining properties, see ResourceDetails objects
    }
    status: {
      cause: 'string'
      code: 'string'
      description: 'string'
    }
  }
}

Objets ResourceDetails

Définissez la propriété source pour spécifier le type d’objet.

Pour Azure, utilisez :

  source: 'Azure'

Pour OnPremiseSql, utilisez :

  source: 'OnPremiseSql'
  databaseName: 'string'
  machineName: 'string'
  serverName: 'string'
  sourceComputerId: 'string'
  vmuuid: 'string'
  workspaceId: 'string'

Valeurs de propriétés

assessments

Nom Description Valeur
name Nom de la ressource string (obligatoire)

Limite de caractères : 1-260

Caractères valides :
Caractères alphanumériques, traits de soulignement et traits d’union.
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.
properties Décrit les propriétés d’une évaluation. SecurityAssessmentPropertiesOrSecurityAssessmentProp...

SecurityAssessmentPropertiesOrSecurityAssessmentProp...

Nom Description Valeur
additionalData Données supplémentaires concernant l’évaluation SecurityAssessmentPropertiesBaseAdditionalData
metadata Décrit les propriétés d’une métadonnées d’évaluation. SecurityAssessmentMetadataProperties
partnersData Données relatives à l’intégration de partenaires tiers SecurityAssessmentPartnerData
resourceDetails Détails de la ressource évaluée ResourceDetails (obligatoire)
status Le résultat de l’évaluation AssessmentStatusOrAssessmentStatusResponse (obligatoire)

SecurityAssessmentPropertiesBaseAdditionalData

Nom Description Valeur
{propriété personnalisée} string

SecurityAssessmentMetadataProperties

Nom Description Valeur
assessmentType BuiltIn si l’évaluation basée sur la définition de Azure Policy intégrée, Personnalisée si l’évaluation basée sur la définition de Azure Policy personnalisée 'BuiltIn'
'CustomPolicy'
'CustomerManaged'
'VerifiedPartner' (obligatoire)
categories Tableau de chaînes contenant l’un des éléments suivants :
'Compute'
'Data'
'IdentityAndAccess'
'IoT'
'Mise en réseau'
description Description lisible par l’utilisateur de l’évaluation string
displayName Nom complet convivial de l’évaluation string (obligatoire)
implementationEffort Effort d’implémentation requis pour corriger cette évaluation 'High'
'Low'
'Modéré'
partnerData Décrit le partenaire qui a créé l’évaluation SecurityAssessmentMetadataPartnerData
preview True si cette évaluation est en version préliminaire status bool
remediationDescription Description lisible par l’utilisateur de ce que vous devez faire pour atténuer ce problème de sécurité string
severity Niveau de gravité de l’évaluation 'High'
'Faible'
'Medium' (obligatoire)
menaces Tableau de chaînes contenant l’un des éléments suivants :
'accountBreach'
'dataExfiltration'
'dataSpillage'
'denialOfService'
'elevationOfPrivilege'
'maliciousInsider'
'missingCoverage'
'threatResistance'
userImpact Impact de l’évaluation sur l’utilisateur 'High'
'Faible'
'Modéré'

SecurityAssessmentMetadataPartnerData

Nom Description Valeur
partnerName Nom de la société du partenaire chaîne (obligatoire)
ProductName Nom du produit du partenaire qui a créé l’évaluation string
secret Secret pour authentifier le partenaire et vérifier qu’il a créé l’évaluation - écriture uniquement chaîne (obligatoire)

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.

SecurityAssessmentPartnerData

Nom Description Valeur
partnerName Nom de la société du partenaire chaîne (obligatoire)
secret secret pour authentifier le partenaire - écriture uniquement chaîne (obligatoire)

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.

ResourceDetails

Nom Description Valeur
source Définir le type d’objet Microsoft Azure
OnPremiseSql (obligatoire)

AzureResourceDetails

Nom Description Valeur
source Plateforme où réside la ressource évaluée 'Azure' (obligatoire)

OnPremiseSqlResourceDetails

Nom Description Valeur
source Plateforme où réside la ressource évaluée 'OnPremiseSql' (obligatoire)
databaseName Nom de la base de données Sql installée sur l’ordinateur chaîne (obligatoire)
machineName Nom de la machine chaîne (obligatoire)
serverName Nom du serveur Sql installé sur l’ordinateur chaîne (obligatoire)
sourceComputerId ID de l’agent OMS installé sur l’ordinateur chaîne (obligatoire)
vmuuid ID unique de la machine chaîne (obligatoire)
workspaceId ID de ressource Azure de l’espace de travail auquel la machine est attachée chaîne (obligatoire)

AssessmentStatusOrAssessmentStatusResponse

Nom Description Valeur
cause Code programmatique pour la cause de l’évaluation status string
code Code programmatique pour le status de l’évaluation 'Sain'
'NotApplicable'
'Non sain' (obligatoire)
description Description lisible par l’homme de l’état d’évaluation string

Définition de ressources de modèle ARM

Le type de ressource d’évaluation 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.

Le type de ressource d’évaluation peut être déployé avec des opérations qui ciblent :

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.Security/assessments, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Security/assessments",
  "apiVersion": "2021-06-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "additionalData": {
      "{customized property}": "string"
    },
    "metadata": {
      "assessmentType": "string",
      "categories": [ "string" ],
      "description": "string",
      "displayName": "string",
      "implementationEffort": "string",
      "partnerData": {
        "partnerName": "string",
        "productName": "string",
        "secret": "string"
      },
      "preview": "bool",
      "remediationDescription": "string",
      "severity": "string",
      "threats": [ "string" ],
      "userImpact": "string"
    },
    "partnersData": {
      "partnerName": "string",
      "secret": "string"
    },
    "resourceDetails": {
      "source": "string"
      // For remaining properties, see ResourceDetails objects
    },
    "status": {
      "cause": "string",
      "code": "string",
      "description": "string"
    }
  }
}

Objets ResourceDetails

Définissez la propriété source pour spécifier le type d’objet.

Pour Azure, utilisez :

  "source": "Azure"

Pour OnPremiseSql, utilisez :

  "source": "OnPremiseSql",
  "databaseName": "string",
  "machineName": "string",
  "serverName": "string",
  "sourceComputerId": "string",
  "vmuuid": "string",
  "workspaceId": "string"

Valeurs de propriétés

assessments

Nom Description Valeur
type Type de ressource « Microsoft.Security/assessments »
apiVersion Version de l’API de ressource '2021-06-01'
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1-260

Caractères valides :
Caractères alphanumériques, traits de soulignement et traits d’union.
scope Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue du déploiement. Ressource cible

Pour JSON, définissez la valeur sur le nom complet de la ressource à laquelle appliquer la ressource d’extension .
properties Décrit les propriétés d’une évaluation. SecurityAssessmentPropertiesOrSecurityAssessmentProp...

SecurityAssessmentPropertiesOrSecurityAssessmentProp...

Nom Description Valeur
additionalData Données supplémentaires relatives à l’évaluation SecurityAssessmentPropertiesBaseAdditionalData
metadata Décrit les propriétés d’une métadonnées d’évaluation. SecurityAssessmentMetadataProperties
partnersData Données relatives à l’intégration de partenaires tiers SecurityAssessmentPartnerData
resourceDetails Détails de la ressource évaluée ResourceDetails (obligatoire)
status Résultat de l’évaluation AssessmentStatusOrAssessmentStatusResponse (obligatoire)

SecurityAssessmentPropertiesBaseAdditionalData

Nom Description Valeur
{propriété personnalisée} string

SecurityAssessmentMetadataProperties

Nom Description Valeur
assessmentType BuiltIn si l’évaluation basée sur une définition de Azure Policy intégrée, Personnalisé si l’évaluation basée sur une définition de Azure Policy personnalisée 'BuiltIn'
'CustomPolicy'
'CustomerManaged'
'VerifiedPartner' (obligatoire)
categories Tableau de chaînes contenant l’un des éléments suivants :
'Compute'
'Données'
'IdentityAndAccess'
'IoT'
'Mise en réseau'
description Description lisible par l’homme de l’évaluation string
displayName Nom d’affichage convivial de l’évaluation chaîne (obligatoire)
implementationEffort Effort de mise en œuvre nécessaire pour corriger cette évaluation 'High'
'Faible'
'Modéré'
partnerData Décrit le partenaire qui a créé l’évaluation SecurityAssessmentMetadataPartnerData
preview True si cette évaluation est en préversion status bool
remediationDescription Description lisible par l’utilisateur de ce que vous devez faire pour atténuer ce problème de sécurité string
severity Niveau de gravité de l’évaluation 'High'
'Low'
'Medium' (obligatoire)
menaces Tableau de chaînes contenant l’un des éléments suivants :
'accountBreach'
'dataExfiltration'
'dataSpillage'
'denialOfService'
'elevationOfPrivilege'
'maliciousInsider'
'missingCoverage'
'threatResistance'
userImpact Impact sur l’utilisateur de l’évaluation 'High'
'Low'
'Modéré'

SecurityAssessmentMetadataPartnerData

Nom Description Valeur
partnerName Nom de l’entreprise du partenaire string (obligatoire)
ProductName Nom du produit du partenaire qui a créé l’évaluation string
secret Secret pour authentifier le partenaire et vérifier qu’il a créé l’évaluation - écriture uniquement string (obligatoire)

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.

SecurityAssessmentPartnerData

Nom Description Valeur
partnerName Nom de l’entreprise du partenaire string (obligatoire)
secret secret pour authentifier le partenaire - écriture uniquement string (obligatoire)

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.

ResourceDetails

Nom Description Valeur
source Définir le type d’objet Microsoft Azure
OnPremiseSql (obligatoire)

AzureResourceDetails

Nom Description Valeur
source Plateforme où réside la ressource évaluée 'Azure' (obligatoire)

OnPremiseSqlResourceDetails

Nom Description Valeur
source Plateforme où réside la ressource évaluée 'OnPremiseSql' (obligatoire)
databaseName Nom de la base de données Sql installée sur la machine string (obligatoire)
machineName Nom de l’ordinateur string (obligatoire)
serverName Nom du serveur Sql installé sur l’ordinateur string (obligatoire)
sourceComputerId ID de l’agent OMS installé sur la machine string (obligatoire)
vmuuid ID unique de l’ordinateur string (obligatoire)
workspaceId ID de ressource Azure de l’espace de travail auquel la machine est attachée string (obligatoire)

AssessmentStatusOrAssessmentStatusResponse

Nom Description Valeur
cause Code programmatique pour la cause de l’évaluation status string
code Code programmatique pour la status de l’évaluation 'Sain'
'Nonapplicable'
'Non sain' (obligatoire)
description Description lisible par l’homme de l’état d’évaluation string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource d’évaluation 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.

Le type de ressource d’évaluation peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

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.Security/assessments, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/assessments@2021-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      additionalData = {
        {customized property} = "string"
      }
      metadata = {
        assessmentType = "string"
        categories = [
          "string"
        ]
        description = "string"
        displayName = "string"
        implementationEffort = "string"
        partnerData = {
          partnerName = "string"
          productName = "string"
          secret = "string"
        }
        preview = bool
        remediationDescription = "string"
        severity = "string"
        threats = [
          "string"
        ]
        userImpact = "string"
      }
      partnersData = {
        partnerName = "string"
        secret = "string"
      }
      resourceDetails = {
        source = "string"
        // For remaining properties, see ResourceDetails objects
      }
      status = {
        cause = "string"
        code = "string"
        description = "string"
      }
    }
  })
}

Objets ResourceDetails

Définissez la propriété source pour spécifier le type d’objet.

Pour Azure, utilisez :

  source = "Azure"

Pour OnPremiseSql, utilisez :

  source = "OnPremiseSql"
  databaseName = "string"
  machineName = "string"
  serverName = "string"
  sourceComputerId = "string"
  vmuuid = "string"
  workspaceId = "string"

Valeurs de propriétés

assessments

Nom Description Valeur
type Type de ressource « Microsoft.Security/assessments@2021-06-01 »
name Nom de la ressource string (obligatoire)

Limite de caractères : 1-260

Caractères valides :
Caractères alphanumériques, traits de soulignement et traits d’union.
parent_id ID de la ressource à laquelle appliquer cette ressource d’extension. string (obligatoire)
properties Décrit les propriétés d’une évaluation. SecurityAssessmentPropertiesOrSecurityAssessmentProp...

SecurityAssessmentPropertiesOrSecurityAssessmentProp...

Nom Description Valeur
additionalData Données supplémentaires concernant l’évaluation SecurityAssessmentPropertiesBaseAdditionalData
metadata Décrit les propriétés d’une métadonnées d’évaluation. SecurityAssessmentMetadataProperties
partnersData Données relatives à l’intégration de partenaires tiers SecurityAssessmentPartnerData
resourceDetails Détails de la ressource évaluée ResourceDetails (obligatoire)
status Le résultat de l’évaluation AssessmentStatusOrAssessmentStatusResponse (obligatoire)

SecurityAssessmentPropertiesBaseAdditionalData

Nom Description Valeur
{propriété personnalisée} string

SecurityAssessmentMetadataProperties

Nom Description Valeur
assessmentType BuiltIn si l’évaluation basée sur la définition de Azure Policy intégrée, Personnalisée si l’évaluation basée sur la définition de Azure Policy personnalisée « BuiltIn »
« CustomPolicy »
« CustomerManaged »
« VerifiedPartner » (obligatoire)
categories Tableau de chaînes contenant l’un des éléments suivants :
« Calcul »
« Données »
« IdentityAndAccess »
« IoT »
« Mise en réseau »
description Description lisible par l’utilisateur de l’évaluation string
displayName Nom complet convivial de l’évaluation string (obligatoire)
implementationEffort Effort d’implémentation requis pour corriger cette évaluation "High"
"Low"
« Modéré »
partnerData Décrit le partenaire qui a créé l’évaluation SecurityAssessmentMetadataPartnerData
preview True si cette évaluation est en version préliminaire status bool
remediationDescription Description lisible par l’utilisateur de ce que vous devez faire pour atténuer ce problème de sécurité string
severity Niveau de gravité de l’évaluation "High"
"Low"
« Moyen » (obligatoire)
menaces Tableau de chaînes contenant l’un des éléments suivants :
« accountBreach »
« dataExfiltration »
« dataSpillage »
« denialOfService »
« elevationOfPrivilege »
« maliciousInsider »
« missingCoverage »
« threatResistance »
userImpact Impact sur l’utilisateur de l’évaluation "High"
"Low"
« Modéré »

SecurityAssessmentMetadataPartnerData

Nom Description Valeur
partnerName Nom de l’entreprise du partenaire string (obligatoire)
ProductName Nom du produit du partenaire qui a créé l’évaluation string
secret Secret pour authentifier le partenaire et vérifier qu’il a créé l’évaluation - écriture uniquement string (obligatoire)

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.

SecurityAssessmentPartnerData

Nom Description Valeur
partnerName Nom de l’entreprise du partenaire string (obligatoire)
secret secret pour authentifier le partenaire - écriture uniquement string (obligatoire)

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.

ResourceDetails

Nom Description Valeur
source Définir le type d’objet Microsoft Azure
OnPremiseSql (obligatoire)

AzureResourceDetails

Nom Description Valeur
source Plateforme où réside la ressource évaluée « Azure » (obligatoire)

OnPremiseSqlResourceDetails

Nom Description Valeur
source Plateforme où réside la ressource évaluée « OnPremiseSql » (obligatoire)
databaseName Nom de la base de données Sql installée sur la machine string (obligatoire)
machineName Nom de l’ordinateur string (obligatoire)
serverName Nom du serveur Sql installé sur l’ordinateur string (obligatoire)
sourceComputerId ID de l’agent OMS installé sur la machine string (obligatoire)
vmuuid ID unique de l’ordinateur string (obligatoire)
workspaceId ID de ressource Azure de l’espace de travail auquel la machine est attachée string (obligatoire)

AssessmentStatusOrAssessmentStatusResponse

Nom Description Valeur
cause Code programmatique pour la cause de l’évaluation status string
code Code programmatique pour la status de l’évaluation « Sain »
« Nonapplicable »
« Non sain » (obligatoire)
description Description lisible par l’homme de l’état d’évaluation string