Share via

Microsoft.Security assessmentMetadata 2020-01-01

  • 發行項

Bicep 資源定義

assessmentMetadata 資源類型是 延伸模組資源，這表示您可以將它套用至另一個資源。

scope使用此資源上的 屬性來設定此資源的範圍。 請參閱 在 Bicep 中設定擴充功能資源的範圍。

assessmentMetadata 資源類型可以使用目標作業進行部署：

您可以在下列層級將此資源類型參考為唯讀資源： 租使用者

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Security/assessmentMetadata 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Security/assessmentMetadata@2020-01-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    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'
  }
}

屬性值

assessmentMetadata

名稱 描述 值
NAME 資源名稱 需要字串 ()

字元限制：1-260

合法字元：
英數字元、底線和連字號。
範圍 在與部署範圍不同的範圍內建立擴充資源時，請使用 。 目標資源

針對 Bicep，請將此屬性設定為資源的符號名稱，以套用 延伸模組資源。
properties 描述評量元數據的屬性。 SecurityAssessmentMetadataProperties

SecurityAssessmentMetadataProperties

名稱 描述 值
assessmentType 如果以內建 Azure 原則 定義為基礎的評定，則為 BuiltIn;如果根據自定義 Azure 原則 定義進行評量，則為自定義 'BuiltIn'
'CustomPolicy'
'CustomerManaged'
'VerifiedPartner' (必要)
categories 包含任何項目的字串數組：
'Compute'
'Data'
'IdentityAndAccess'
'IoT'
'Networking'
description 評估的人類可讀描述 字串
displayName 評估的使用者易記顯示名稱 需要字串 ()
implementationEffort 補救此評估所需的實作工作 'High'
'Low'
'Moderate'
partnerData 描述建立評定的合作夥伴 SecurityAssessmentMetadataPartnerData
preview 如果此評量處於預覽版本狀態，則為 True bool
remediationDescription 人類可閱讀的可讀說明，說明您應該執行哪些動作來減輕此安全性問題 字串
嚴重程度 評估的嚴重性層級 'High'
'Low'
必要) 'Medium' (
威脅 包含任何項目的字串數組：
'accountBreach'
'dataExfiltration'
'dataSpillage'
'denialOfService'
'elevationOfPrivilege'
'maliciousInsider'
'missingCoverage'
'threatResistance'
userImpact 評估的用戶影響 'High'
'Low'
'Moderate'

SecurityAssessmentMetadataPartnerData

名稱 描述 值
partnerName 合作夥伴公司的名稱 需要字串 ()
productName 建立評量之合作夥伴的產品名稱 字串
secret 驗證合作夥伴並確認其已建立評定的秘密 - 僅寫入 需要字串 ()

約束：
敏感性值。 以安全參數的形式傳入。

ARM 範本資源定義

assessmentMetadata 資源類型是 延伸模組資源，這表示您可以將它套用至另一個資源。

scope使用此資源上的 屬性來設定此資源的範圍。 請參閱 在ARM範本中設定擴充功能資源的範圍。

assessmentMetadata 資源類型可以使用目標作業進行部署：

您可以在下列層級將此資源類型參考為唯讀資源： 租使用者

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Security/assessmentMetadata 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Security/assessmentMetadata",
  "apiVersion": "2020-01-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "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"
  }
}

屬性值

assessmentMetadata

名稱 描述 值
類型 資源類型 'Microsoft.Security/assessmentMetadata'
apiVersion 資源 API 版本 '2020-01-01'
NAME 資源名稱 需要字串 ()

字元限制：1-260

合法字元：
英數字元、底線和連字號。
範圍 在與部署範圍不同的範圍內建立擴充資源時，請使用 。 目標資源

針對 JSON，請將值設定為要套用 擴充資源 的資源完整名稱。
properties 描述評量元數據的屬性。 SecurityAssessmentMetadataProperties

SecurityAssessmentMetadataProperties

名稱 描述 值
assessmentType 如果以內建 Azure 原則 定義為基礎的評量，則為 BuiltIn;如果根據自定義 Azure 原則 定義進行評量，則為自定義 'BuiltIn'
'CustomPolicy'
'CustomerManaged'
'VerifiedPartner' (必要)
categories 包含任何項目的字串數組：
'Compute'
'Data'
'IdentityAndAccess'
'IoT'
'Networking'
description 評估的人類可讀描述 字串
displayName 評估的使用者易記顯示名稱 需要字串 ()
implementationEffort 補救此評估所需的實作工作 'High'
'Low'
'Moderate'
partnerData 描述建立評定的合作夥伴 SecurityAssessmentMetadataPartnerData
preview 如果此評量處於預覽版本狀態，則為 True bool
remediationDescription 人類可閱讀的可讀說明，說明您應該執行哪些動作來減輕此安全性問題 字串
嚴重程度 評估的嚴重性層級 'High'
'Low'
必要) 'Medium' (
威脅 包含任何項目的字串數組：
'accountBreach'
'dataExfiltration'
'dataSpillage'
'denialOfService'
'elevationOfPrivilege'
'maliciousInsider'
'missingCoverage'
'threatResistance'
userImpact 評估的用戶影響 'High'
'Low'
'Moderate'

SecurityAssessmentMetadataPartnerData

名稱 描述 值
partnerName 合作夥伴公司的名稱 需要字串 ()
productName 建立評量之合作夥伴的產品名稱 字串
secret 驗證合作夥伴並確認其已建立評定的秘密 - 僅寫入 需要字串 ()

約束：
敏感性值。 以安全參數的形式傳入。

Terraform (AzAPI 提供者) 資源定義

assessmentMetadata 資源類型是 延伸模組資源，這表示您可以將它套用至另一個資源。

parent_id使用此資源上的 屬性來設定此資源的範圍。

assessmentMetadata 資源類型可以使用目標作業進行部署：

  • 訂用帳戶

您可以在下列層級將此資源類型參考為唯讀資源： 租使用者

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Security/assessmentMetadata 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/assessmentMetadata@2020-01-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      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"
    }
  })
}

屬性值

assessmentMetadata

名稱 描述 值
類型 資源類型 “Microsoft.Security/assessmentMetadata@2020-01-01”
NAME 資源名稱 需要字串 ()

字元限制：1-260

合法字元：
英數字元、底線和連字號。
parent_id 要套用此擴充功能資源的資源標識碼。 需要字串 ()
properties 描述評量元數據的屬性。 SecurityAssessmentMetadataProperties

SecurityAssessmentMetadataProperties

名稱 描述 值
assessmentType 如果以內建 Azure 原則 定義為基礎的評量，則為 BuiltIn;如果根據自定義 Azure 原則 定義進行評量，則為自定義 “BuiltIn”
“CustomPolicy”
“CustomerManaged”
“VerifiedPartner” (必要)
categories 包含任何項目的字串數組：
“計算”
“Data”
“IdentityAndAccess”
“IoT”
“網络功能”
description 評估的人類可讀描述 字串
displayName 評估的使用者易記顯示名稱 需要字串 ()
implementationEffort 補救此評估所需的實作工作 "High"
"Low"
“中等”
partnerData 描述建立評定的合作夥伴 SecurityAssessmentMetadataPartnerData
preview 如果此評量處於預覽版本狀態，則為 True bool
remediationDescription 人類可閱讀的可讀說明，說明您應該執行哪些動作來減輕此安全性問題 字串
嚴重程度 評估的嚴重性層級 "High"
"Low"
“Medium” (必要)
威脅 包含任何項目的字串數組：
“accountBreach”
“dataExfiltration”
“dataSpillage”
“denialOfService”
“elevationOfPrivilege”
“maliciousInsider”
“missingCoverage”
“threatResistance”
userImpact 評估的用戶影響 "High"
"Low"
“中等”

SecurityAssessmentMetadataPartnerData

名稱 描述 值
partnerName 合作夥伴公司的名稱 需要字串 ()
productName 建立評量之合作夥伴的產品名稱 字串
secret 驗證合作夥伴並確認其已建立評定的秘密 - 僅寫入 需要字串 ()

約束：
敏感性值。 以安全參數的形式傳入。