Udostępnij za pośrednictwem

Microsoft.Security assessments

  • Artykuł

Definicja zasobu Bicep

Typ zasobu oceny można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Security/assessments, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Security/assessments@2021-06-01' = {
  scope: resourceSymbolicName or scope
  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'
    }
  }
}

Obiekty ResourceDetails

Ustaw właściwość źródła , aby określić typ obiektu.

W przypadku azureużyj:

{
  source: 'Azure'
}

W przypadku OnPremiseSqlużyj:

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

Wartości właściwości

AssessmentStatusOrAssessmentStatusResponse

Nazwa Opis Wartość
przyczyna Kod programowy przyczyny stanu oceny struna
kod Kod programowy stanu oceny "W dobrej kondycji"
"NotApplicable"
"W złej kondycji" (wymagane)
opis Czytelny opis stanu oceny przez człowieka struna

AzureResourceDetails

Nazwa Opis Wartość
źródło Platforma, na której znajduje się oceniony zasób "Azure" (wymagane)

Microsoft.Security/assessments

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Opisuje właściwości oceny. SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
zakres Użyj polecenia podczas tworzenia zasobu w zakresie innym niż zakres wdrożenia. Ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia .

OnPremiseSqlResourceDetails

Nazwa Opis Wartość
databaseName Nazwa bazy danych Sql zainstalowana na maszynie ciąg (wymagany)
machineName Nazwa maszyny ciąg (wymagany)
nazwa_serwera Nazwa serwera SQL zainstalowana na maszynie ciąg (wymagany)
źródło Platforma, na której znajduje się oceniony zasób "OnPremiseSql" (wymagane)
sourceComputerId Identyfikator agenta pakietu oms zainstalowany na maszynie ciąg (wymagany)
vmuuid Unikatowy identyfikator maszyny ciąg (wymagany)
workspaceId Identyfikator zasobu platformy Azure obszaru roboczego, do którego jest dołączony komputer ciąg (wymagany)

ResourceDetails

Nazwa Opis Wartość
źródło Ustaw wartość "Azure" dla typu AzureResourceDetails. Ustaw wartość "OnPremiseSql" dla typu OnPremiseSqlResourceDetails. "Azure"
"OnPremiseSql" (wymagane)

SecurityAssessmentMetadataPartnerData

Nazwa Opis Wartość
partnerName Nazwa firmy partnera ciąg (wymagany)
productName Nazwa produktu partnera, który utworzył ocenę struna
tajny Wpis tajny umożliwiający uwierzytelnienie partnera i zweryfikowanie utworzenia oceny — tylko zapis struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr. (wymagane)

SecurityAssessmentMetadataProperties

Nazwa Opis Wartość
assessmentType BuiltIn, jeśli ocena oparta na wbudowanej definicji usługi Azure Policy, niestandardowy, jeśli ocena jest oparta na niestandardowej definicji usługi Azure Policy "BuiltIn"
"CustomerManaged"
"CustomPolicy"
"VerifiedPartner" (wymagane)
Kategorie Tablica ciągów zawierająca dowolną z:
"Obliczenia"
"Dane"
"IdentityAndAccess"
"IoT"
"Sieć"
opis Czytelny opis oceny przez człowieka struna
displayName Przyjazna dla użytkownika nazwa wyświetlana oceny ciąg (wymagany)
implementationEffort Wysiłek wdrożeniowy wymagany do skorygowania tej oceny "Wysoki"
"Niski"
"Umiarkowany"
partnerData Opisuje partnera, który utworzył ocenę SecurityAssessmentMetadataPartnerData
prapremiera Prawda, jeśli ta ocena ma stan wersji zapoznawczej Bool
remediationDescription Czytelny opis tego, co należy zrobić, aby rozwiązać ten problem z zabezpieczeniami struna
dotkliwość Poziom ważności oceny "Wysoki"
"Niski"
"Średni" (wymagany)
Zagrożeń Tablica ciągów zawierająca dowolną z:
"accountBreach"
"dataExfiltration"
"dataSpillage"
"denialOfService"
"elevationOfPrivilege"
"złośliwyInsider"
"missingCoverage"
"threatResistance"
userImpact Wpływ oceny na użytkownika "Wysoki"
"Niski"
"Umiarkowany"

SecurityAssessmentPartnerData

Nazwa Opis Wartość
partnerName Nazwa firmy partnera ciąg (wymagany)
tajny wpis tajny do uwierzytelniania partnera — tylko zapis struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr. (wymagane)

SecurityAssessmentPropertiesBaseAdditionalData

Nazwa Opis Wartość

SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse

Nazwa Opis Wartość
additionalData Dodatkowe dane dotyczące oceny SecurityAssessmentPropertiesBaseAdditionalData
metadane Opisuje właściwości metadanych oceny. SecurityAssessmentMetadataProperties
partnersData Dane dotyczące integracji partnera innej firmy SecurityAssessmentPartnerData
resourceDetails Szczegóły zasobu, który został oceniony ResourceDetails (wymagane)
stan Wynik oceny AssessmentStatusOrAssessmentStatusResponse (wymagane)

Definicja zasobu szablonu usługi ARM

Typ zasobu oceny można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Security/assessments, dodaj następujący kod JSON do szablonu.

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

Obiekty ResourceDetails

Ustaw właściwość źródła , aby określić typ obiektu.

W przypadku azureużyj:

{
  "source": "Azure"
}

W przypadku OnPremiseSqlużyj:

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

Wartości właściwości

AssessmentStatusOrAssessmentStatusResponse

Nazwa Opis Wartość
przyczyna Kod programowy przyczyny stanu oceny struna
kod Kod programowy stanu oceny "W dobrej kondycji"
"NotApplicable"
"W złej kondycji" (wymagane)
opis Czytelny opis stanu oceny przez człowieka struna

AzureResourceDetails

Nazwa Opis Wartość
źródło Platforma, na której znajduje się oceniony zasób "Azure" (wymagane)

Microsoft.Security/assessments

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2021-06-01'
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Opisuje właściwości oceny. SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
typ Typ zasobu "Microsoft.Security/assessments"

OnPremiseSqlResourceDetails

Nazwa Opis Wartość
databaseName Nazwa bazy danych Sql zainstalowana na maszynie ciąg (wymagany)
machineName Nazwa maszyny ciąg (wymagany)
nazwa_serwera Nazwa serwera SQL zainstalowana na maszynie ciąg (wymagany)
źródło Platforma, na której znajduje się oceniony zasób "OnPremiseSql" (wymagane)
sourceComputerId Identyfikator agenta pakietu oms zainstalowany na maszynie ciąg (wymagany)
vmuuid Unikatowy identyfikator maszyny ciąg (wymagany)
workspaceId Identyfikator zasobu platformy Azure obszaru roboczego, do którego jest dołączony komputer ciąg (wymagany)

ResourceDetails

Nazwa Opis Wartość
źródło Ustaw wartość "Azure" dla typu AzureResourceDetails. Ustaw wartość "OnPremiseSql" dla typu OnPremiseSqlResourceDetails. "Azure"
"OnPremiseSql" (wymagane)

SecurityAssessmentMetadataPartnerData

Nazwa Opis Wartość
partnerName Nazwa firmy partnera ciąg (wymagany)
productName Nazwa produktu partnera, który utworzył ocenę struna
tajny Wpis tajny umożliwiający uwierzytelnienie partnera i zweryfikowanie utworzenia oceny — tylko zapis struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr. (wymagane)

SecurityAssessmentMetadataProperties

Nazwa Opis Wartość
assessmentType BuiltIn, jeśli ocena oparta na wbudowanej definicji usługi Azure Policy, niestandardowy, jeśli ocena jest oparta na niestandardowej definicji usługi Azure Policy "BuiltIn"
"CustomerManaged"
"CustomPolicy"
"VerifiedPartner" (wymagane)
Kategorie Tablica ciągów zawierająca dowolną z:
"Obliczenia"
"Dane"
"IdentityAndAccess"
"IoT"
"Sieć"
opis Czytelny opis oceny przez człowieka struna
displayName Przyjazna dla użytkownika nazwa wyświetlana oceny ciąg (wymagany)
implementationEffort Wysiłek wdrożeniowy wymagany do skorygowania tej oceny "Wysoki"
"Niski"
"Umiarkowany"
partnerData Opisuje partnera, który utworzył ocenę SecurityAssessmentMetadataPartnerData
prapremiera Prawda, jeśli ta ocena ma stan wersji zapoznawczej Bool
remediationDescription Czytelny opis tego, co należy zrobić, aby rozwiązać ten problem z zabezpieczeniami struna
dotkliwość Poziom ważności oceny "Wysoki"
"Niski"
"Średni" (wymagany)
Zagrożeń Tablica ciągów zawierająca dowolną z:
"accountBreach"
"dataExfiltration"
"dataSpillage"
"denialOfService"
"elevationOfPrivilege"
"złośliwyInsider"
"missingCoverage"
"threatResistance"
userImpact Wpływ oceny na użytkownika "Wysoki"
"Niski"
"Umiarkowany"

SecurityAssessmentPartnerData

Nazwa Opis Wartość
partnerName Nazwa firmy partnera ciąg (wymagany)
tajny wpis tajny do uwierzytelniania partnera — tylko zapis struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr. (wymagane)

SecurityAssessmentPropertiesBaseAdditionalData

Nazwa Opis Wartość

SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse

Nazwa Opis Wartość
additionalData Dodatkowe dane dotyczące oceny SecurityAssessmentPropertiesBaseAdditionalData
metadane Opisuje właściwości metadanych oceny. SecurityAssessmentMetadataProperties
partnersData Dane dotyczące integracji partnera innej firmy SecurityAssessmentPartnerData
resourceDetails Szczegóły zasobu, który został oceniony ResourceDetails (wymagane)
stan Wynik oceny AssessmentStatusOrAssessmentStatusResponse (wymagane)

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu oceny można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Security/assessments, dodaj następujący program Terraform do szablonu.

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

Obiekty ResourceDetails

Ustaw właściwość źródła , aby określić typ obiektu.

W przypadku azureużyj:

{
  source = "Azure"
}

W przypadku OnPremiseSqlużyj:

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

Wartości właściwości

AssessmentStatusOrAssessmentStatusResponse

Nazwa Opis Wartość
przyczyna Kod programowy przyczyny stanu oceny struna
kod Kod programowy stanu oceny "W dobrej kondycji"
"NotApplicable"
"W złej kondycji" (wymagane)
opis Czytelny opis stanu oceny przez człowieka struna

AzureResourceDetails

Nazwa Opis Wartość
źródło Platforma, na której znajduje się oceniony zasób "Azure" (wymagane)

Microsoft.Security/assessments

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. ciąg (wymagany)
Właściwości Opisuje właściwości oceny. SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
typ Typ zasobu "Microsoft.Security/assessments@2021-06-01"

OnPremiseSqlResourceDetails

Nazwa Opis Wartość
databaseName Nazwa bazy danych Sql zainstalowana na maszynie ciąg (wymagany)
machineName Nazwa maszyny ciąg (wymagany)
nazwa_serwera Nazwa serwera SQL zainstalowana na maszynie ciąg (wymagany)
źródło Platforma, na której znajduje się oceniony zasób "OnPremiseSql" (wymagane)
sourceComputerId Identyfikator agenta pakietu oms zainstalowany na maszynie ciąg (wymagany)
vmuuid Unikatowy identyfikator maszyny ciąg (wymagany)
workspaceId Identyfikator zasobu platformy Azure obszaru roboczego, do którego jest dołączony komputer ciąg (wymagany)

ResourceDetails

Nazwa Opis Wartość
źródło Ustaw wartość "Azure" dla typu AzureResourceDetails. Ustaw wartość "OnPremiseSql" dla typu OnPremiseSqlResourceDetails. "Azure"
"OnPremiseSql" (wymagane)

SecurityAssessmentMetadataPartnerData

Nazwa Opis Wartość
partnerName Nazwa firmy partnera ciąg (wymagany)
productName Nazwa produktu partnera, który utworzył ocenę struna
tajny Wpis tajny umożliwiający uwierzytelnienie partnera i zweryfikowanie utworzenia oceny — tylko zapis struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr. (wymagane)

SecurityAssessmentMetadataProperties

Nazwa Opis Wartość
assessmentType BuiltIn, jeśli ocena oparta na wbudowanej definicji usługi Azure Policy, niestandardowy, jeśli ocena jest oparta na niestandardowej definicji usługi Azure Policy "BuiltIn"
"CustomerManaged"
"CustomPolicy"
"VerifiedPartner" (wymagane)
Kategorie Tablica ciągów zawierająca dowolną z:
"Obliczenia"
"Dane"
"IdentityAndAccess"
"IoT"
"Sieć"
opis Czytelny opis oceny przez człowieka struna
displayName Przyjazna dla użytkownika nazwa wyświetlana oceny ciąg (wymagany)
implementationEffort Wysiłek wdrożeniowy wymagany do skorygowania tej oceny "Wysoki"
"Niski"
"Umiarkowany"
partnerData Opisuje partnera, który utworzył ocenę SecurityAssessmentMetadataPartnerData
prapremiera Prawda, jeśli ta ocena ma stan wersji zapoznawczej Bool
remediationDescription Czytelny opis tego, co należy zrobić, aby rozwiązać ten problem z zabezpieczeniami struna
dotkliwość Poziom ważności oceny "Wysoki"
"Niski"
"Średni" (wymagany)
Zagrożeń Tablica ciągów zawierająca dowolną z:
"accountBreach"
"dataExfiltration"
"dataSpillage"
"denialOfService"
"elevationOfPrivilege"
"złośliwyInsider"
"missingCoverage"
"threatResistance"
userImpact Wpływ oceny na użytkownika "Wysoki"
"Niski"
"Umiarkowany"

SecurityAssessmentPartnerData

Nazwa Opis Wartość
partnerName Nazwa firmy partnera ciąg (wymagany)
tajny wpis tajny do uwierzytelniania partnera — tylko zapis struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr. (wymagane)

SecurityAssessmentPropertiesBaseAdditionalData

Nazwa Opis Wartość

SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse

Nazwa Opis Wartość
additionalData Dodatkowe dane dotyczące oceny SecurityAssessmentPropertiesBaseAdditionalData
metadane Opisuje właściwości metadanych oceny. SecurityAssessmentMetadataProperties
partnersData Dane dotyczące integracji partnera innej firmy SecurityAssessmentPartnerData
resourceDetails Szczegóły zasobu, który został oceniony ResourceDetails (wymagane)
stan Wynik oceny AssessmentStatusOrAssessmentStatusResponse (wymagane)