Microsoft.Security assessments 2021-06-01
Bicep 資源定義
評估資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Security/assessments 資源，請將下列 Bicep 新增至範本。
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'
}
}
}
ResourceDetails 物件
設定 來源 屬性，以指定對象的類型。
針對 Azure，請使用：
{
source: 'Azure'
}
針對 OnPremiseSql，請使用：
{
databaseName: 'string'
machineName: 'string'
serverName: 'string'
source: 'OnPremiseSql'
sourceComputerId: 'string'
vmuuid: 'string'
workspaceId: 'string'
}
屬性值
AssessmentStatusOrAssessmentStatusResponse
| 名字 | 描述 | 價值 |
|---|---|---|
| 原因 | 評估狀態原因的程式設計程序代碼 | 字串 |
| 法典 | 評估狀態的程式設計程序代碼 | 「狀況良好」 'NotApplicable' 「狀況不良」（必要） |
| 描述 | 評估狀態的人類可讀描述 | 字串 |
AzureResourceDetails
| 名字 | 描述 | 價值 |
|---|---|---|
| 源 | 評估資源所在的平臺 | 'Azure' （必要） |
Microsoft.Security/assessments
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 描述評量的屬性。 | SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse |
| 範圍 | 在與部署範圍不同的範圍內建立資源時，請使用 。 | 將此屬性設定為資源的符號名稱，以套用 擴充資源。 |
OnPremiseSqlResourceDetails
| 名字 | 描述 | 價值 |
|---|---|---|
| databaseName | 計算機上安裝的 Sql 資料庫名稱 | 字串 （必要） |
| machineName | 計算機的名稱 | 字串 （必要） |
| serverName | 計算機上安裝的 Sql Server 名稱 | 字串 （必要） |
| 源 | 評估資源所在的平臺 | 'OnPremiseSql' （必要） |
| sourceComputerId | 計算機上安裝的 oms 代理程式識別碼 | 字串 （必要） |
| vmuuid | 計算機的唯一標識碼 | 字串 （必要） |
| workspaceId | 計算機所連結工作區的 Azure 資源識別碼 | 字串 （必要） |
ResourceDetails
| 名字 | 描述 | 價值 |
|---|---|---|
| 源 | 針對 azureResourceDetails類型 |
'Azure' 'OnPremiseSql' （必要） |
SecurityAssessmentMetadataPartnerData
| 名字 | 描述 | 價值 |
|---|---|---|
| partnerName | 合作夥伴公司的名稱 | 字串 （必要） |
| productName | 建立評量之合作夥伴的產品名稱 | 字串 |
| 秘密 | 驗證合作夥伴並確認其已建立評定的秘密 - 僅寫入 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 （必要） |
SecurityAssessmentMetadataProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| assessmentType | 根據內建的 Azure 原則定義進行評量時，BuiltIn 會根據自定義 Azure 原則定義自定義評量 | 'BuiltIn' 'CustomerManaged' 'CustomPolicy' 'VerifiedPartner' （必要） |
| 類別 | 包含任何的字串數組： 'Compute' 'Data' 'IdentityAndAccess' 'IoT' 「網路」 |
|
| 描述 | 評估的人類可讀描述 | 字串 |
| displayName | 評估的使用者易記顯示名稱 | 字串 （必要） |
| implementationEffort | 補救此評估所需的實作工作 | 'High' 'Low' 'Moderate' |
| partnerData | 描述建立評定的合作夥伴 | SecurityAssessmentMetadataPartnerData |
| 預覽 | True 是表示 如果此評量處於預覽版本狀態 | bool |
| remediationDescription | 人類可讀的關於您應該執行哪些動作來減輕此安全性問題的描述 | 字串 |
| 嚴厲 | 評定的嚴重性層級 | 'High' 'Low' 'Medium' （必要） |
| 威脅 | 包含任何的字串數組： 'accountBreach' 'dataExfiltration' 'dataSpillage' 'denialOfService' 'elevationOfPrivilege' 'maliciousInsider' 'missingCoverage' 'threatResistance' |
|
| userImpact | 評估的用戶影響 | 'High' 'Low' 'Moderate' |
SecurityAssessmentPartnerData
| 名字 | 描述 | 價值 |
|---|---|---|
| partnerName | 合作夥伴公司的名稱 | 字串 （必要） |
| 秘密 | 驗證夥伴的秘密 - 僅寫入 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 （必要） |
SecurityAssessmentPropertiesBaseAdditionalData
| 名字 | 描述 | 價值 |
|---|
SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
| 名字 | 描述 | 價值 |
|---|---|---|
| additionalData | 有關評量的其他數據 | SecurityAssessmentPropertiesBaseAdditionalData |
| 元數據 | 描述評估元數據的屬性。 | SecurityAssessmentMetadataProperties |
| partnersData | 第三方合作夥伴整合的相關數據 | SecurityAssessmentPartnerData |
| resourceDetails | 已評估之資源的詳細數據 | ResourceDetails （必要） |
| 地位 | 評量的結果 | AssessmentStatusOrAssessmentStatusResponse （必要） |
ARM 樣本資源定義
評估資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Security/assessments 資源，請將下列 JSON 新增至範本。
{
"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 物件
設定 來源 屬性，以指定對象的類型。
針對 Azure，請使用：
{
"source": "Azure"
}
針對 OnPremiseSql，請使用：
{
"databaseName": "string",
"machineName": "string",
"serverName": "string",
"source": "OnPremiseSql",
"sourceComputerId": "string",
"vmuuid": "string",
"workspaceId": "string"
}
屬性值
AssessmentStatusOrAssessmentStatusResponse
| 名字 | 描述 | 價值 |
|---|---|---|
| 原因 | 評估狀態原因的程式設計程序代碼 | 字串 |
| 法典 | 評估狀態的程式設計程序代碼 | 「狀況良好」 'NotApplicable' 「狀況不良」（必要） |
| 描述 | 評估狀態的人類可讀描述 | 字串 |
AzureResourceDetails
| 名字 | 描述 | 價值 |
|---|---|---|
| 源 | 評估資源所在的平臺 | 'Azure' （必要） |
Microsoft.Security/assessments
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2021-06-01' |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 描述評量的屬性。 | SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse |
| 類型 | 資源類型 | 'Microsoft.Security/assessments' |
OnPremiseSqlResourceDetails
| 名字 | 描述 | 價值 |
|---|---|---|
| databaseName | 計算機上安裝的 Sql 資料庫名稱 | 字串 （必要） |
| machineName | 計算機的名稱 | 字串 （必要） |
| serverName | 計算機上安裝的 Sql Server 名稱 | 字串 （必要） |
| 源 | 評估資源所在的平臺 | 'OnPremiseSql' （必要） |
| sourceComputerId | 計算機上安裝的 oms 代理程式識別碼 | 字串 （必要） |
| vmuuid | 計算機的唯一標識碼 | 字串 （必要） |
| workspaceId | 計算機所連結工作區的 Azure 資源識別碼 | 字串 （必要） |
ResourceDetails
| 名字 | 描述 | 價值 |
|---|---|---|
| 源 | 針對 azureResourceDetails類型 |
'Azure' 'OnPremiseSql' （必要） |
SecurityAssessmentMetadataPartnerData
| 名字 | 描述 | 價值 |
|---|---|---|
| partnerName | 合作夥伴公司的名稱 | 字串 （必要） |
| productName | 建立評量之合作夥伴的產品名稱 | 字串 |
| 秘密 | 驗證合作夥伴並確認其已建立評定的秘密 - 僅寫入 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 （必要） |
SecurityAssessmentMetadataProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| assessmentType | 根據內建的 Azure 原則定義進行評量時，BuiltIn 會根據自定義 Azure 原則定義自定義評量 | 'BuiltIn' 'CustomerManaged' 'CustomPolicy' 'VerifiedPartner' （必要） |
| 類別 | 包含任何的字串數組： 'Compute' 'Data' 'IdentityAndAccess' 'IoT' 「網路」 |
|
| 描述 | 評估的人類可讀描述 | 字串 |
| displayName | 評估的使用者易記顯示名稱 | 字串 （必要） |
| implementationEffort | 補救此評估所需的實作工作 | 'High' 'Low' 'Moderate' |
| partnerData | 描述建立評定的合作夥伴 | SecurityAssessmentMetadataPartnerData |
| 預覽 | True 是表示 如果此評量處於預覽版本狀態 | bool |
| remediationDescription | 人類可讀的關於您應該執行哪些動作來減輕此安全性問題的描述 | 字串 |
| 嚴厲 | 評定的嚴重性層級 | 'High' 'Low' 'Medium' （必要） |
| 威脅 | 包含任何的字串數組： 'accountBreach' 'dataExfiltration' 'dataSpillage' 'denialOfService' 'elevationOfPrivilege' 'maliciousInsider' 'missingCoverage' 'threatResistance' |
|
| userImpact | 評估的用戶影響 | 'High' 'Low' 'Moderate' |
SecurityAssessmentPartnerData
| 名字 | 描述 | 價值 |
|---|---|---|
| partnerName | 合作夥伴公司的名稱 | 字串 （必要） |
| 秘密 | 驗證夥伴的秘密 - 僅寫入 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 （必要） |
SecurityAssessmentPropertiesBaseAdditionalData
| 名字 | 描述 | 價值 |
|---|
SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
| 名字 | 描述 | 價值 |
|---|---|---|
| additionalData | 有關評量的其他數據 | SecurityAssessmentPropertiesBaseAdditionalData |
| 元數據 | 描述評估元數據的屬性。 | SecurityAssessmentMetadataProperties |
| partnersData | 第三方合作夥伴整合的相關數據 | SecurityAssessmentPartnerData |
| resourceDetails | 已評估之資源的詳細數據 | ResourceDetails （必要） |
| 地位 | 評量的結果 | AssessmentStatusOrAssessmentStatusResponse （必要） |
Terraform （AzAPI 提供者） 資源定義
評估資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Security/assessments 資源，請將下列 Terraform 新增至範本。
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 物件
設定 來源 屬性，以指定對象的類型。
針對 Azure，請使用：
{
source = "Azure"
}
針對 OnPremiseSql，請使用：
{
databaseName = "string"
machineName = "string"
serverName = "string"
source = "OnPremiseSql"
sourceComputerId = "string"
vmuuid = "string"
workspaceId = "string"
}
屬性值
AssessmentStatusOrAssessmentStatusResponse
| 名字 | 描述 | 價值 |
|---|---|---|
| 原因 | 評估狀態原因的程式設計程序代碼 | 字串 |
| 法典 | 評估狀態的程式設計程序代碼 | 「狀況良好」 'NotApplicable' 「狀況不良」（必要） |
| 描述 | 評估狀態的人類可讀描述 | 字串 |
AzureResourceDetails
| 名字 | 描述 | 價值 |
|---|---|---|
| 源 | 評估資源所在的平臺 | 'Azure' （必要） |
Microsoft.Security/assessments
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 （必要） |
| parent_id | 要套用此延伸模組資源之資源的標識碼。 | 字串 （必要） |
| 性能 | 描述評量的屬性。 | SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse |
| 類型 | 資源類型 | “Microsoft.Security/assessments@2021-06-01” |
OnPremiseSqlResourceDetails
| 名字 | 描述 | 價值 |
|---|---|---|
| databaseName | 計算機上安裝的 Sql 資料庫名稱 | 字串 （必要） |
| machineName | 計算機的名稱 | 字串 （必要） |
| serverName | 計算機上安裝的 Sql Server 名稱 | 字串 （必要） |
| 源 | 評估資源所在的平臺 | 'OnPremiseSql' （必要） |
| sourceComputerId | 計算機上安裝的 oms 代理程式識別碼 | 字串 （必要） |
| vmuuid | 計算機的唯一標識碼 | 字串 （必要） |
| workspaceId | 計算機所連結工作區的 Azure 資源識別碼 | 字串 （必要） |
ResourceDetails
| 名字 | 描述 | 價值 |
|---|---|---|
| 源 | 針對 azureResourceDetails類型 |
'Azure' 'OnPremiseSql' （必要） |
SecurityAssessmentMetadataPartnerData
| 名字 | 描述 | 價值 |
|---|---|---|
| partnerName | 合作夥伴公司的名稱 | 字串 （必要） |
| productName | 建立評量之合作夥伴的產品名稱 | 字串 |
| 秘密 | 驗證合作夥伴並確認其已建立評定的秘密 - 僅寫入 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 （必要） |
SecurityAssessmentMetadataProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| assessmentType | 根據內建的 Azure 原則定義進行評量時，BuiltIn 會根據自定義 Azure 原則定義自定義評量 | 'BuiltIn' 'CustomerManaged' 'CustomPolicy' 'VerifiedPartner' （必要） |
| 類別 | 包含任何的字串數組： 'Compute' 'Data' 'IdentityAndAccess' 'IoT' 「網路」 |
|
| 描述 | 評估的人類可讀描述 | 字串 |
| displayName | 評估的使用者易記顯示名稱 | 字串 （必要） |
| implementationEffort | 補救此評估所需的實作工作 | 'High' 'Low' 'Moderate' |
| partnerData | 描述建立評定的合作夥伴 | SecurityAssessmentMetadataPartnerData |
| 預覽 | True 是表示 如果此評量處於預覽版本狀態 | bool |
| remediationDescription | 人類可讀的關於您應該執行哪些動作來減輕此安全性問題的描述 | 字串 |
| 嚴厲 | 評定的嚴重性層級 | 'High' 'Low' 'Medium' （必要） |
| 威脅 | 包含任何的字串數組： 'accountBreach' 'dataExfiltration' 'dataSpillage' 'denialOfService' 'elevationOfPrivilege' 'maliciousInsider' 'missingCoverage' 'threatResistance' |
|
| userImpact | 評估的用戶影響 | 'High' 'Low' 'Moderate' |
SecurityAssessmentPartnerData
| 名字 | 描述 | 價值 |
|---|---|---|
| partnerName | 合作夥伴公司的名稱 | 字串 （必要） |
| 秘密 | 驗證夥伴的秘密 - 僅寫入 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 （必要） |
SecurityAssessmentPropertiesBaseAdditionalData
| 名字 | 描述 | 價值 |
|---|
SecurityAssessmentPropertiesOrSecurityAssessmentPropertiesResponse
| 名字 | 描述 | 價值 |
|---|---|---|
| additionalData | 有關評量的其他數據 | SecurityAssessmentPropertiesBaseAdditionalData |
| 元數據 | 描述評估元數據的屬性。 | SecurityAssessmentMetadataProperties |
| partnersData | 第三方合作夥伴整合的相關數據 | SecurityAssessmentPartnerData |
| resourceDetails | 已評估之資源的詳細數據 | ResourceDetails （必要） |
| 地位 | 評量的結果 | AssessmentStatusOrAssessmentStatusResponse （必要） |