Freigeben über


Microsoft.Security Assessments 2021-06-01

Bicep-Ressourcendefinition

Der Ressourcentyp "Bewertungen" kann mit Vorgängen bereitgestellt werden, die folgendes Ziel haben:

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

Ressourcenformat

Um eine Microsoft.Security/Assessments-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.Security/assessments@2021-06-01' = {
  name: '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 Source--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Azure:

{
  source: 'Azure'
}

Verwenden Sie für OnPremiseSql-:

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

Eigenschaftswerte

AssessmentStatusOrAssessmentStatusResponse

Name Beschreibung Wert
verursachen Programmgesteuerter Code für die Ursache des Bewertungsstatus Schnur
Code Programmgesteuerter Code für den Status der Bewertung "Gesund"
'NotApplicable'
"Ungesund" (erforderlich)
Beschreibung Lesbare Beschreibung des Bewertungsstatus Schnur

AzureResourceDetails

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

Microsoft.Security/Assessments

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Beschreibt die Eigenschaften einer Bewertung. SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse

OnPremiseSqlResourceDetails

Name Beschreibung Wert
databaseName Der sql-Datenbankname, der auf dem Computer installiert ist Zeichenfolge (erforderlich)
machineName Der Name des Computers Zeichenfolge (erforderlich)
serverName Der auf dem Computer installierte Sql Server-Name Zeichenfolge (erforderlich)
Quelle Die Plattform, auf der sich die bewertete Ressource befindet "OnPremiseSql" (erforderlich)
sourceComputerId Die oms-Agent-ID, die auf dem Computer installiert ist 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)

ResourceDetails

Name Beschreibung Wert
Quelle Legen Sie für den Typ AzureResourceDetailsauf "Azure" fest. Legen Sie für den Typ OnPremiseSqlResourceDetailsauf "OnPremiseSqlResourceDetails" fest. "Azure"
"OnPremiseSql" (erforderlich)

SecurityAssessmentMetadataPartnerData

Name Beschreibung Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
productName Name des Produkts des Partners, der die Bewertung erstellt hat Schnur
geheim Geheimer Schlüssel, um den Partner zu authentifizieren und zu überprüfen, ob die Bewertung erstellt wurde – schreibgeschützt Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

SecurityAssessmentMetadataProperties

Name Beschreibung Wert
assessmentType BuiltIn, wenn die Bewertung basierend auf der integrierten Azure-Richtliniendefinition , benutzerdefiniert, wenn die Bewertung basierend auf der benutzerdefinierten Azure-Richtliniendefinition 'BuiltIn'
"CustomerManaged"
'CustomPolicy'
"VerifiedPartner" (erforderlich)
Kategorien Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Berechnen"
"Daten"
'IdentityAndAccess'
"IoT"
"Netzwerk"
Beschreibung Lesbare Beschreibung der Bewertung Schnur
displayName Benutzerfreundlicher Anzeigename der Bewertung Zeichenfolge (erforderlich)
implementationEffort Der Implementierungsaufwand, der zur Behebung dieser Bewertung erforderlich ist "Hoch"
"Niedrig"
"Moderat"
partnerData Beschreibt den Partner, der die Bewertung erstellt hat. SecurityAssessmentMetadataPartnerData-
Vorschau True, wenn sich diese Bewertung im Vorschauversionsstatus befindet Bool
remediationDescription Menschliche lesbare Beschreibung, was Sie tun sollten, um dieses Sicherheitsproblem zu beheben Schnur
Strenge Schweregrad der Bewertung "Hoch"
"Niedrig"
"Mittel" (erforderlich)
Bedrohungen Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"accountBreach"
'dataExfiltration'
'dataSpillage'
'denialOfService'
'elevationOfPrivilege'
'maliciousInsider'
"missingCoverage"
"threatResistance"
userImpact Die Auswirkungen der Benutzer auf die Bewertung "Hoch"
"Niedrig"
"Moderat"

SecurityAssessmentPartnerData

Name Beschreibung Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
geheim geheim, um den Partner zu authentifizieren – schreibgeschützt Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

SecurityAssessmentPropertiesBaseAdditionalData

Name Beschreibung Wert

SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse

Name Beschreibung Wert
additionalData Zusätzliche Daten zur Bewertung SecurityAssessmentPropertiesBaseAdditionalData-
Metadaten Beschreibt die Eigenschaften einer Bewertungsmetadaten. SecurityAssessmentMetadataProperties
partnersData Daten zur Integration von Drittanbietern SecurityAssessmentPartnerData-
resourceDetails Details der Ressource, die bewertet wurde ResourceDetails- (erforderlich)
Status Das Ergebnis der Bewertung AssessmentStatusOrAssessmentStatusResponse (erforderlich)

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "Bewertungen" kann mit Vorgängen bereitgestellt werden, die folgendes Ziel haben:

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

Ressourcenformat

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

{
  "type": "Microsoft.Security/assessments",
  "apiVersion": "2021-06-01",
  "name": "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 Source--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Azure:

{
  "source": "Azure"
}

Verwenden Sie für OnPremiseSql-:

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

Eigenschaftswerte

AssessmentStatusOrAssessmentStatusResponse

Name Beschreibung Wert
verursachen Programmgesteuerter Code für die Ursache des Bewertungsstatus Schnur
Code Programmgesteuerter Code für den Status der Bewertung "Gesund"
'NotApplicable'
"Ungesund" (erforderlich)
Beschreibung Lesbare Beschreibung des Bewertungsstatus Schnur

AzureResourceDetails

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

Microsoft.Security/Assessments

Name Beschreibung Wert
apiVersion Die API-Version '2021-06-01'
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Beschreibt die Eigenschaften einer Bewertung. SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
Art Der Ressourcentyp "Microsoft.Security/Assessments"

OnPremiseSqlResourceDetails

Name Beschreibung Wert
databaseName Der sql-Datenbankname, der auf dem Computer installiert ist Zeichenfolge (erforderlich)
machineName Der Name des Computers Zeichenfolge (erforderlich)
serverName Der auf dem Computer installierte Sql Server-Name Zeichenfolge (erforderlich)
Quelle Die Plattform, auf der sich die bewertete Ressource befindet "OnPremiseSql" (erforderlich)
sourceComputerId Die oms-Agent-ID, die auf dem Computer installiert ist 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)

ResourceDetails

Name Beschreibung Wert
Quelle Legen Sie für den Typ AzureResourceDetailsauf "Azure" fest. Legen Sie für den Typ OnPremiseSqlResourceDetailsauf "OnPremiseSqlResourceDetails" fest. "Azure"
"OnPremiseSql" (erforderlich)

SecurityAssessmentMetadataPartnerData

Name Beschreibung Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
productName Name des Produkts des Partners, der die Bewertung erstellt hat Schnur
geheim Geheimer Schlüssel, um den Partner zu authentifizieren und zu überprüfen, ob die Bewertung erstellt wurde – schreibgeschützt Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

SecurityAssessmentMetadataProperties

Name Beschreibung Wert
assessmentType BuiltIn, wenn die Bewertung basierend auf der integrierten Azure-Richtliniendefinition , benutzerdefiniert, wenn die Bewertung basierend auf der benutzerdefinierten Azure-Richtliniendefinition 'BuiltIn'
"CustomerManaged"
'CustomPolicy'
"VerifiedPartner" (erforderlich)
Kategorien Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Berechnen"
"Daten"
'IdentityAndAccess'
"IoT"
"Netzwerk"
Beschreibung Lesbare Beschreibung der Bewertung Schnur
displayName Benutzerfreundlicher Anzeigename der Bewertung Zeichenfolge (erforderlich)
implementationEffort Der Implementierungsaufwand, der zur Behebung dieser Bewertung erforderlich ist "Hoch"
"Niedrig"
"Moderat"
partnerData Beschreibt den Partner, der die Bewertung erstellt hat. SecurityAssessmentMetadataPartnerData-
Vorschau True, wenn sich diese Bewertung im Vorschauversionsstatus befindet Bool
remediationDescription Menschliche lesbare Beschreibung, was Sie tun sollten, um dieses Sicherheitsproblem zu beheben Schnur
Strenge Schweregrad der Bewertung "Hoch"
"Niedrig"
"Mittel" (erforderlich)
Bedrohungen Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"accountBreach"
'dataExfiltration'
'dataSpillage'
'denialOfService'
'elevationOfPrivilege'
'maliciousInsider'
"missingCoverage"
"threatResistance"
userImpact Die Auswirkungen der Benutzer auf die Bewertung "Hoch"
"Niedrig"
"Moderat"

SecurityAssessmentPartnerData

Name Beschreibung Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
geheim geheim, um den Partner zu authentifizieren – schreibgeschützt Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

SecurityAssessmentPropertiesBaseAdditionalData

Name Beschreibung Wert

SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse

Name Beschreibung Wert
additionalData Zusätzliche Daten zur Bewertung SecurityAssessmentPropertiesBaseAdditionalData-
Metadaten Beschreibt die Eigenschaften einer Bewertungsmetadaten. SecurityAssessmentMetadataProperties
partnersData Daten zur Integration von Drittanbietern SecurityAssessmentPartnerData-
resourceDetails Details der Ressource, die bewertet wurde ResourceDetails- (erforderlich)
Status Das Ergebnis der Bewertung AssessmentStatusOrAssessmentStatusResponse (erforderlich)

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "Bewertungen" kann mit Vorgängen bereitgestellt werden, die folgendes Ziel haben:

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

Ressourcenformat

Um eine Microsoft.Security/Assessments-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/assessments@2021-06-01"
  name = "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 Source--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Azure:

{
  source = "Azure"
}

Verwenden Sie für OnPremiseSql-:

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

Eigenschaftswerte

AssessmentStatusOrAssessmentStatusResponse

Name Beschreibung Wert
verursachen Programmgesteuerter Code für die Ursache des Bewertungsstatus Schnur
Code Programmgesteuerter Code für den Status der Bewertung "Gesund"
'NotApplicable'
"Ungesund" (erforderlich)
Beschreibung Lesbare Beschreibung des Bewertungsstatus Schnur

AzureResourceDetails

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

Microsoft.Security/Assessments

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Beschreibt die Eigenschaften einer Bewertung. SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
Art Der Ressourcentyp "Microsoft.Security/assessments@2021-06-01"

OnPremiseSqlResourceDetails

Name Beschreibung Wert
databaseName Der sql-Datenbankname, der auf dem Computer installiert ist Zeichenfolge (erforderlich)
machineName Der Name des Computers Zeichenfolge (erforderlich)
serverName Der auf dem Computer installierte Sql Server-Name Zeichenfolge (erforderlich)
Quelle Die Plattform, auf der sich die bewertete Ressource befindet "OnPremiseSql" (erforderlich)
sourceComputerId Die oms-Agent-ID, die auf dem Computer installiert ist 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)

ResourceDetails

Name Beschreibung Wert
Quelle Legen Sie für den Typ AzureResourceDetailsauf "Azure" fest. Legen Sie für den Typ OnPremiseSqlResourceDetailsauf "OnPremiseSqlResourceDetails" fest. "Azure"
"OnPremiseSql" (erforderlich)

SecurityAssessmentMetadataPartnerData

Name Beschreibung Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
productName Name des Produkts des Partners, der die Bewertung erstellt hat Schnur
geheim Geheimer Schlüssel, um den Partner zu authentifizieren und zu überprüfen, ob die Bewertung erstellt wurde – schreibgeschützt Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

SecurityAssessmentMetadataProperties

Name Beschreibung Wert
assessmentType BuiltIn, wenn die Bewertung basierend auf der integrierten Azure-Richtliniendefinition , benutzerdefiniert, wenn die Bewertung basierend auf der benutzerdefinierten Azure-Richtliniendefinition 'BuiltIn'
"CustomerManaged"
'CustomPolicy'
"VerifiedPartner" (erforderlich)
Kategorien Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Berechnen"
"Daten"
'IdentityAndAccess'
"IoT"
"Netzwerk"
Beschreibung Lesbare Beschreibung der Bewertung Schnur
displayName Benutzerfreundlicher Anzeigename der Bewertung Zeichenfolge (erforderlich)
implementationEffort Der Implementierungsaufwand, der zur Behebung dieser Bewertung erforderlich ist "Hoch"
"Niedrig"
"Moderat"
partnerData Beschreibt den Partner, der die Bewertung erstellt hat. SecurityAssessmentMetadataPartnerData-
Vorschau True, wenn sich diese Bewertung im Vorschauversionsstatus befindet Bool
remediationDescription Menschliche lesbare Beschreibung, was Sie tun sollten, um dieses Sicherheitsproblem zu beheben Schnur
Strenge Schweregrad der Bewertung "Hoch"
"Niedrig"
"Mittel" (erforderlich)
Bedrohungen Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"accountBreach"
'dataExfiltration'
'dataSpillage'
'denialOfService'
'elevationOfPrivilege'
'maliciousInsider'
"missingCoverage"
"threatResistance"
userImpact Die Auswirkungen der Benutzer auf die Bewertung "Hoch"
"Niedrig"
"Moderat"

SecurityAssessmentPartnerData

Name Beschreibung Wert
partnerName Name des Unternehmens des Partners Zeichenfolge (erforderlich)
geheim geheim, um den Partner zu authentifizieren – schreibgeschützt Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

SecurityAssessmentPropertiesBaseAdditionalData

Name Beschreibung Wert

SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse

Name Beschreibung Wert
additionalData Zusätzliche Daten zur Bewertung SecurityAssessmentPropertiesBaseAdditionalData-
Metadaten Beschreibt die Eigenschaften einer Bewertungsmetadaten. SecurityAssessmentMetadataProperties
partnersData Daten zur Integration von Drittanbietern SecurityAssessmentPartnerData-
resourceDetails Details der Ressource, die bewertet wurde ResourceDetails- (erforderlich)
Status Das Ergebnis der Bewertung AssessmentStatusOrAssessmentStatusResponse (erforderlich)