Share via


Microsoft.Security-Bewertungen

Bicep-Ressourcendefinition

Der Ressourcentyp assessments ist eine Erweiterungsressource, d. h. Sie können sie auf eine andere Ressource anwenden.

Verwenden Sie die scope -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen. Weitere Informationen finden Sie unter Festlegen des Bereichs für Erweiterungsressourcen in Bicep.

Der Ressourcentyp assessments kann mit Vorgängen bereitgestellt werden, die folgendes ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Security/assessments-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden Bicep hinzu.

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'
    }
  }
}

ResourceDetails-Objekte

Legen Sie die Quelleigenschaft fest, um den Typ des Objekts anzugeben.

Verwenden Sie für Azure Folgendes:

  source: 'Azure'

Verwenden Sie für OnPremiseSql Folgendes:

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

Eigenschaftswerte

assessments

Name BESCHREIBUNG Wert
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-260

Gültige Zeichen:
Alphanumerische Zeichen, Unterstriche und Bindestriche.
scope Verwenden Sie beim Erstellen einer Erweiterungsressource in einem anderen Bereich als dem Bereitstellungsbereich. Zielressource

Legen Sie für Bicep diese Eigenschaft auf den symbolischen Namen der Ressource fest, um die Erweiterungsressource anzuwenden.
properties Beschreibt die Eigenschaften einer Bewertung. SecurityAssessmentPropertiesOrSecurityAssessmentProp...

SecurityAssessmentPropertiesOrSecurityAssessmentProp...

Name BESCHREIBUNG Wert
additionalData Zusätzliche Daten zur Bewertung SecurityAssessmentPropertiesBaseAdditionalData
metadata Beschreibt die Eigenschaften einer Bewertungsmetadaten. SecurityAssessmentMetadataProperties
partnersData Daten zur Integration von Drittanbieterpartnern SecurityAssessmentPartnerData
resourceDetails Details der bewerteten Ressource ResourceDetails (erforderlich)
status Das Ergebnis der Bewertung AssessmentStatusOrAssessmentStatusResponse (erforderlich)

SecurityAssessmentPropertiesBaseAdditionalData

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

SecurityAssessmentMetadataProperties

Name BESCHREIBUNG Wert
assessmentType BuiltIn, wenn die Bewertung basierend auf der integrierten Azure Policy Definition, Benutzerdefiniert, wenn die Bewertung auf benutzerdefinierten Azure Policy Definition basiert "BuiltIn"
"CustomPolicy"
"CustomerManaged"
"VerifiedPartner" (erforderlich)
categories Zeichenfolgenarray, das eines der folgenden Elemente enthält:
"Compute"
"Daten"
"IdentityAndAccess"
"IoT"
"Netzwerk"
description Lesbare Beschreibung der Bewertung Zeichenfolge
displayName Benutzerfreundlicher Anzeigename der Bewertung Zeichenfolge (erforderlich)
implementationEffort Der implementierungsaufwand, der zum Beheben dieser Bewertung erforderlich ist "Hoch"
"Niedrig"
"Mittel"
partnerData Beschreibt den Partner, der die Bewertung erstellt hat. SecurityAssessmentMetadataPartnerData
preview True, wenn sich diese Bewertung in der Vorschauversion status bool
remediationDescription Lesbare Beschreibung, was Sie tun sollten, um dieses Sicherheitsproblem zu beheben Zeichenfolge
severity Der Schweregrad der Bewertung "Hoch"
"Niedrig"
"Mittel" (erforderlich)
Bedrohungen Zeichenfolgenarray, das eines der folgenden Elemente enthält:
"accountBreach"
'dataExfiltration'
'dataSpillage'
"denialOfService"
"elevationOfPrivilege"
"maliciousInsider"
"missingCoverage"
"threatResistance"
userImpact Die Benutzerwirkung der Bewertung "Hoch"
"Niedrig"
"Mittel"

SecurityAssessmentMetadataPartnerData

Name BESCHREIBUNG Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
ProductName Name des Produkts des Partners, der die Bewertung erstellt hat Zeichenfolge
secret Geheimnis, um den Partner zu authentifizieren und zu überprüfen, ob die Bewertung erstellt wurde – schreibgeschützt Zeichenfolge (erforderlich)

Einschränkungen:
Vertraulicher Wert. Übergeben Sie als sicheren Parameter.

SecurityAssessmentPartnerData

Name BESCHREIBUNG Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
secret Geheimnis zum Authentifizieren des Partners – schreibgeschützt Zeichenfolge (erforderlich)

Einschränkungen:
Vertraulicher Wert. Übergeben Sie als sicheren Parameter.

ResourceDetails

Name BESCHREIBUNG Wert
source Festlegen des Objekttyps Azure
OnPremiseSql (erforderlich)

AzureResourceDetails

Name BESCHREIBUNG Wert
source Die Plattform, auf der sich die bewertete Ressource befindet "Azure" (erforderlich)

OnPremiseSqlResourceDetails

Name BESCHREIBUNG Wert
source Die Plattform, auf der sich die bewertete Ressource befindet "OnPremiseSql" (erforderlich)
databaseName Sql-Datenbankname, der auf dem Computer installiert ist Zeichenfolge (erforderlich)
Maschinename Der Name des Computers Zeichenfolge (erforderlich)
serverName Der sql Server-Name, der auf dem Computer installiert ist Zeichenfolge (erforderlich)
sourceComputerId Die auf dem Computer installierte OMS-Agent-ID Zeichenfolge (erforderlich)
vmuuid Die eindeutige ID des Computers Zeichenfolge (erforderlich)
workspaceId Azure-Ressourcen-ID des Arbeitsbereichs, an den der Computer angefügt ist Zeichenfolge (erforderlich)

AssessmentStatusOrAssessmentStatusResponse

Name BESCHREIBUNG Wert
cause Programmgesteuerter Code für die Ursache der Bewertung status Zeichenfolge
code Programmgesteuerter Code für die status der Bewertung "Fehlerfrei"
"NotApplicable"
"Fehlerhaft" (erforderlich)
description Für Menschen lesbare Beschreibung des Bewertungsstatus Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp assessments ist eine Erweiterungsressource, d. h. Sie können sie auf eine andere Ressource anwenden.

Verwenden Sie die scope -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen. Weitere Informationen finden Sie unter Festlegen des Bereichs für Erweiterungsressourcen in ARM-Vorlagen.

Der Ressourcentyp assessments kann mit Vorgängen bereitgestellt werden, die folgendes ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Security/assessments-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

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

ResourceDetails-Objekte

Legen Sie die Quelleigenschaft fest, um den Typ des Objekts anzugeben.

Verwenden Sie für Azure Folgendes:

  "source": "Azure"

Verwenden Sie für OnPremiseSql Folgendes:

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

Eigenschaftswerte

assessments

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Security/assessments"
apiVersion Die Version der Ressourcen-API '2021-06-01'
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-260

Gültige Zeichen:
Alphanumerische Zeichen, Unterstriche und Bindestriche.
scope Verwenden Sie beim Erstellen einer Erweiterungsressource in einem anderen Bereich als dem Bereitstellungsbereich. Zielressource

Legen Sie für JSON den Wert auf den vollständigen Namen der Ressource fest, auf die die Erweiterungsressource angewendet werden soll.
properties Beschreibt die Eigenschaften einer Bewertung. SecurityAssessmentPropertiesOrSecurityAssessmentProp...

SecurityAssessmentPropertiesOrSecurityAssessmentProp...

Name BESCHREIBUNG Wert
additionalData Zusätzliche Daten zur Bewertung SecurityAssessmentPropertiesBaseAdditionalData
metadata Beschreibt die Eigenschaften einer Bewertungsmetadaten. SecurityAssessmentMetadataProperties
partnersData Daten zur Integration von Drittanbieterpartnern SecurityAssessmentPartnerData
resourceDetails Details der bewerteten Ressource ResourceDetails (erforderlich)
status Das Ergebnis der Bewertung AssessmentStatusOrAssessmentStatusResponse (erforderlich)

SecurityAssessmentPropertiesBaseAdditionalData

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

SecurityAssessmentMetadataProperties

Name BESCHREIBUNG Wert
assessmentType BuiltIn, wenn die Bewertung basierend auf der integrierten Azure Policy Definition, Benutzerdefiniert, wenn die Bewertung auf benutzerdefinierten Azure Policy Definition basiert "BuiltIn"
"CustomPolicy"
"CustomerManaged"
"VerifiedPartner" (erforderlich)
categories Zeichenfolgenarray, das eines der folgenden Elemente enthält:
"Compute"
"Daten"
"IdentityAndAccess"
"IoT"
"Netzwerk"
description Lesbare Beschreibung der Bewertung Zeichenfolge
displayName Benutzerfreundlicher Anzeigename der Bewertung Zeichenfolge (erforderlich)
implementationEffort Der implementierungsaufwand, der zum Beheben dieser Bewertung erforderlich ist "Hoch"
"Niedrig"
"Mittel"
partnerData Beschreibt den Partner, der die Bewertung erstellt hat. SecurityAssessmentMetadataPartnerData
preview True, wenn sich diese Bewertung in der Vorschauversion status bool
remediationDescription Lesbare Beschreibung, was Sie tun sollten, um dieses Sicherheitsproblem zu beheben Zeichenfolge
severity Schweregrad der Bewertung "Hoch"
"Niedrig"
"Mittel" (erforderlich)
Bedrohungen Zeichenfolgenarray, das folgendes enthält:
"accountBreach"
'dataExfiltration'
"dataSpillage"
"denialOfService"
"elevationOfPrivilege"
"maliciousInsider"
"MissingCoverage"
"threatResistance"
userImpact Die Benutzerwirkung der Bewertung "Hoch"
"Niedrig"
"Moderat"

SecurityAssessmentMetadataPartnerData

Name BESCHREIBUNG Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
ProductName Name des Produkts des Partners, der die Bewertung erstellt hat Zeichenfolge
secret Geheimnis, um den Partner zu authentifizieren und zu überprüfen, ob die Bewertung erstellt wurde – schreibgeschützt Zeichenfolge (erforderlich)

Einschränkungen:
Vertraulicher Wert. Übergeben Sie als sicheren Parameter.

SecurityAssessmentPartnerData

Name BESCHREIBUNG Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
secret Geheimnis zum Authentifizieren des Partners – nur Schreiben Zeichenfolge (erforderlich)

Einschränkungen:
Vertraulicher Wert. Übergeben Sie als sicheren Parameter.

ResourceDetails

Name BESCHREIBUNG Wert
source Festlegen des Objekttyps Azure
OnPremiseSql (erforderlich)

AzureResourceDetails

Name BESCHREIBUNG Wert
source Die Plattform, auf der sich die bewertete Ressource befindet "Azure" (erforderlich)

OnPremiseSqlResourceDetails

Name BESCHREIBUNG Wert
source Die Plattform, auf der sich die bewertete Ressource befindet "OnPremiseSql" (erforderlich)
databaseName Der sql-Datenbankname, der auf dem Computer installiert ist Zeichenfolge (erforderlich)
Maschinename Der Name des Computers Zeichenfolge (erforderlich)
serverName Der auf dem Computer installierte Sql Server-Name Zeichenfolge (erforderlich)
sourceComputerId Die auf dem Computer installierte OMS-Agent-ID Zeichenfolge (erforderlich)
vmuuid Die eindeutige ID des Computers Zeichenfolge (erforderlich)
workspaceId Azure-Ressourcen-ID des Arbeitsbereichs, an den der Computer angefügt ist Zeichenfolge (erforderlich)

AssessmentStatusOrAssessmentStatusResponse

Name BESCHREIBUNG Wert
cause Programmgesteuerter Code für die Ursache der Bewertung status Zeichenfolge
code Programmgesteuerter Code für die status der Bewertung "Fehlerfrei"
"NotApplicable"
"Fehlerhaft" (erforderlich)
description Für Menschen lesbare Beschreibung des Bewertungsstatus Zeichenfolge

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp assessments ist eine Erweiterungsressource, d. h. Sie können sie auf eine andere Ressource anwenden.

Verwenden Sie die parent_id -Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen.

Der Ressourcentyp assessments kann mit Vorgängen bereitgestellt werden, die folgendes ziel haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Security/assessments-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden Terraform hinzu.

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"
      }
    }
  })
}

ResourceDetails-Objekte

Legen Sie die Quelleigenschaft fest, um den Typ des Objekts anzugeben.

Verwenden Sie für Azure Folgendes:

  source = "Azure"

Verwenden Sie für OnPremiseSql Folgendes:

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

Eigenschaftswerte

assessments

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Security/assessments@2021-06-01"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-260

Gültige Zeichen:
Alphanumerische Zeichen, Unterstriche und Bindestriche.
parent_id Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. Zeichenfolge (erforderlich)
properties Beschreibt die Eigenschaften einer Bewertung. SecurityAssessmentPropertiesOrSecurityAssessmentProp...

SecurityAssessmentPropertiesOrSecurityAssessmentProp...

Name BESCHREIBUNG Wert
additionalData Zusätzliche Daten zur Bewertung SecurityAssessmentPropertiesBaseAdditionalData
metadata Beschreibt die Eigenschaften einer Bewertungsmetadaten. SecurityAssessmentMetadataProperties
partnersData Daten zur Integration von Drittanbieterpartnern SecurityAssessmentPartnerData
resourceDetails Details der bewerteten Ressource ResourceDetails (erforderlich)
status Das Ergebnis der Bewertung AssessmentStatusOrAssessmentStatusResponse (erforderlich)

SecurityAssessmentPropertiesBaseAdditionalData

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

SecurityAssessmentMetadataProperties

Name BESCHREIBUNG Wert
assessmentType BuiltIn, wenn die Bewertung basierend auf der integrierten Azure Policy Definition, Benutzerdefiniert, wenn die Bewertung auf benutzerdefinierten Azure Policy Definition basiert "BuiltIn"
"CustomPolicy"
"CustomerManaged"
"VerifiedPartner" (erforderlich)
categories Zeichenfolgenarray, das eines der folgenden Elemente enthält:
"Compute"
"Daten"
"IdentityAndAccess"
"IoT"
"Netzwerk"
description Lesbare Beschreibung der Bewertung Zeichenfolge
displayName Benutzerfreundlicher Anzeigename der Bewertung Zeichenfolge (erforderlich)
implementationEffort Der implementierungsaufwand, der zum Beheben dieser Bewertung erforderlich ist "High"
"Low"
"Mittel"
partnerData Beschreibt den Partner, der die Bewertung erstellt hat. SecurityAssessmentMetadataPartnerData
preview True, wenn sich diese Bewertung in der Vorschauversion status bool
remediationDescription Lesbare Beschreibung, was Sie tun sollten, um dieses Sicherheitsproblem zu beheben Zeichenfolge
severity Der Schweregrad der Bewertung "High"
"Low"
"Mittel" (erforderlich)
Bedrohungen Zeichenfolgenarray, das eines der folgenden Elemente enthält:
"accountBreach"
"dataExfiltration"
"dataSpillage"
"denialOfService"
"elevationOfPrivilege"
"maliciousInsider"
"missingCoverage"
"threatResistance"
userImpact Die Benutzerwirkung der Bewertung "High"
"Low"
"Mittel"

SecurityAssessmentMetadataPartnerData

Name BESCHREIBUNG Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
ProductName Name des Produkts des Partners, der die Bewertung erstellt hat Zeichenfolge
secret Geheimnis, um den Partner zu authentifizieren und zu überprüfen, ob die Bewertung erstellt wurde – schreibgeschützt Zeichenfolge (erforderlich)

Einschränkungen:
Vertraulicher Wert. Übergeben Sie als sicheren Parameter.

SecurityAssessmentPartnerData

Name BESCHREIBUNG Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
secret Geheimnis zum Authentifizieren des Partners – schreibgeschützt Zeichenfolge (erforderlich)

Einschränkungen:
Vertraulicher Wert. Übergeben Sie als sicheren Parameter.

ResourceDetails

Name BESCHREIBUNG Wert
source Festlegen des Objekttyps Azure
OnPremiseSql (erforderlich)

AzureResourceDetails

Name BESCHREIBUNG Wert
source Die Plattform, auf der sich die bewertete Ressource befindet "Azure" (erforderlich)

OnPremiseSqlResourceDetails

Name BESCHREIBUNG Wert
source Die Plattform, auf der sich die bewertete Ressource befindet "OnPremiseSql" (erforderlich)
databaseName Sql-Datenbankname, der auf dem Computer installiert ist Zeichenfolge (erforderlich)
Maschinename Der Name des Computers Zeichenfolge (erforderlich)
serverName Der sql Server-Name, der auf dem Computer installiert ist Zeichenfolge (erforderlich)
sourceComputerId Die auf dem Computer installierte OMS-Agent-ID Zeichenfolge (erforderlich)
vmuuid Die eindeutige ID des Computers Zeichenfolge (erforderlich)
workspaceId Azure-Ressourcen-ID des Arbeitsbereichs, an den der Computer angefügt ist Zeichenfolge (erforderlich)

AssessmentStatusOrAssessmentStatusResponse

Name BESCHREIBUNG Wert
cause Programmgesteuerter Code für die Ursache der Bewertung status Zeichenfolge
code Programmgesteuerter Code für die status der Bewertung "Gesund"
"NotApplicable"
"Fehlerhaft" (erforderlich)
description Für Menschen lesbare Beschreibung des Bewertungsstatus Zeichenfolge