Microsoft.Security assessments
Definicja zasobu Bicep
Typ zasobu oceny to zasób rozszerzenia, co oznacza, że można zastosować go do innego zasobu.
scope Użyj właściwości w tym zasobie, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń w aplikacji Bicep.
Typ zasobu oceny można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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' = {
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'
}
}
}
Obiekty ResourceDetails
Ustaw właściwość źródłową , aby określić typ obiektu.
W przypadku platformy Azure użyj:
source: 'Azure'
W przypadku onPremiseSql użyj:
source: 'OnPremiseSql'
databaseName: 'string'
machineName: 'string'
serverName: 'string'
sourceComputerId: 'string'
vmuuid: 'string'
workspaceId: 'string'
Wartości właściwości
oceny
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 1–260 Prawidłowe znaki: Alfanumeryczne, podkreślenia i łączniki. |
| scope | Użyj polecenia podczas tworzenia zasobu rozszerzenia w zakresie innym niż zakres wdrożenia. | Zasób docelowy Dla Bicep ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia. |
| properties | Opisuje właściwości oceny. | SecurityAssessmentPropertiesOrSecurityAssessmentProp... |
SecurityAssessmentPropertiesOrSecurityAssessmentProp...
| Nazwa | Opis | Wartość |
|---|---|---|
| additionalData | Dodatkowe dane dotyczące oceny | SecurityAssessmentPropertiesBaseAdditionalData |
| metadane | Opisuje właściwości metadanych oceny. | SecurityAssessmentMetadataProperties |
| partnersData | Dane dotyczące integracji partnerów innych firm | SecurityAssessmentPartnerData |
| resourceDetails | Szczegóły zasobu, który został oceniony | ResourceDetails (wymagane) |
| status | Wynik oceny | AssessmentStatusOrAssessmentStatusResponse (wymagane) |
SecurityAssessmentPropertiesBaseAdditionalData
| Nazwa | Opis | Wartość |
|---|---|---|
| {niestandardowa właściwość} | ciąg |
SecurityAssessmentMetadataProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| assessmentType | BuiltIn, jeśli ocena oparta na wbudowanej definicji Azure Policy, Niestandardowy, jeśli ocena oparta na niestandardowej definicji Azure Policy | "BuiltIn" "CustomPolicy" "CustomerManaged" "VerifiedPartner" (wymagane) |
| categories | Tablica ciągów zawierająca dowolną z: "Obliczenia" "Dane" "IdentityAndAccess" "IoT" "Sieć" |
|
| description (opis) | Czytelny opis oceny przez człowieka | ciąg |
| displayName | Przyjazna dla użytkownika nazwa wyświetlana oceny | ciąg (wymagany) |
| implementationEffort | Nakład pracy nad wdrożeniem wymagany do skorygowania tej oceny | "Wysoki" "Niski" "Umiarkowany" |
| partnerData | Opisuje partnera, który utworzył ocenę | SecurityAssessmentMetadataPartnerData |
| preview | 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 | ciąg |
| ważność | Poziom ważności oceny | "Wysoki" "Niski" "Średni" (wymagany) |
| Zagrożeń | Tablica ciągów zawierająca dowolną z: "accountBreach" "dataExfiltration" "dataSpillage" "denialOfService" "elevationOfPrivilege" "maliciousInsider" "missingCoverage" "threatResistance" |
|
| userImpact | Wpływ oceny na użytkownika | "Wysoki" "Niski" "Umiarkowany" |
SecurityAssessmentMetadataPartnerData
| Nazwa | Opis | Wartość |
|---|---|---|
| partnerName | Nazwa firmy partnera | ciąg (wymagany) |
| Productname | Nazwa produktu partnera, który utworzył ocenę | ciąg |
| wpis tajny | Wpis tajny w celu uwierzytelnienia partnera i zweryfikowania, czy utworzono ocenę — tylko zapis | ciąg (wymagany) Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
SecurityAssessmentPartnerData
| Nazwa | Opis | Wartość |
|---|---|---|
| partnerName | Nazwa firmy partnera | ciąg (wymagany) |
| wpis tajny | wpis tajny do uwierzytelniania partnera — tylko zapis | ciąg (wymagany) Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
ResourceDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| source | Ustawianie typu obiektu | Azure OnPremiseSql (wymagane) |
AzureResourceDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| source | Platforma, na której znajduje się oceniony zasób | "Azure" (wymagane) |
OnPremiseSqlResourceDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| source | Platforma, na której znajduje się oceniony zasób | "OnPremiseSql" (wymagane) |
| databaseName | Nazwa bazy danych Sql zainstalowana na maszynie | ciąg (wymagany) |
| Machinename | Nazwa maszyny | ciąg (wymagany) |
| serverName | Nazwa serwera SQL zainstalowana na maszynie | ciąg (wymagany) |
| 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óry jest dołączony komputer | ciąg (wymagany) |
AssessmentStatusOrAssessmentStatusResponse
| Nazwa | Opis | Wartość |
|---|---|---|
| Spowodować | Kod programowy przyczyny stanu oceny | ciąg |
| kod | Kod programowy stanu oceny | "W dobrej kondycji" "NotApplicable" "W złej kondycji" (wymagane) |
| description (opis) | Czytelny opis stanu oceny przez człowieka | ciąg |
Definicja zasobu szablonu usługi ARM
Typ zasobu oceny to zasób rozszerzenia, co oznacza, że można zastosować go do innego zasobu.
scope Użyj właściwości w tym zasobie, aby ustawić zakres dla tego zasobu. Zobacz Ustawianie zakresu dla zasobów rozszerzeń w szablonach usługi ARM.
Typ zasobu oceny można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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",
"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"
}
}
}
Obiekty ResourceDetails
Ustaw właściwość źródłową , aby określić typ obiektu.
W przypadku platformy Azure użyj:
"source": "Azure"
W przypadku onPremiseSql użyj:
"source": "OnPremiseSql",
"databaseName": "string",
"machineName": "string",
"serverName": "string",
"sourceComputerId": "string",
"vmuuid": "string",
"workspaceId": "string"
Wartości właściwości
oceny
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.Security/assessments" |
| apiVersion | Wersja interfejsu API zasobów | '2021-06-01' |
| name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 1–260 Prawidłowe znaki: Alfanumeryczne, podkreślenia i łączniki. |
| scope | Użyj polecenia podczas tworzenia zasobu rozszerzenia w zakresie innym niż zakres wdrożenia. | Zasób docelowy W przypadku formatu JSON ustaw wartość na pełną nazwę zasobu, aby zastosować zasób rozszerzenia do. |
| properties | Opisuje właściwości oceny. | SecurityAssessmentPropertiesOrSecurityAssessmentProp... |
SecurityAssessmentPropertiesOrSecurityAssessmentProp...
| Nazwa | Opis | Wartość |
|---|---|---|
| additionalData | Dodatkowe dane dotyczące oceny | SecurityAssessmentPropertiesBaseAdditionalData |
| metadane | Opisuje właściwości metadanych oceny. | SecurityAssessmentMetadataProperties |
| partnersData | Dane dotyczące integracji partnerów innych firm | SecurityAssessmentPartnerData |
| resourceDetails | Szczegóły zasobu, który został oceniony | ResourceDetails (wymagane) |
| status | Wynik oceny | AssessmentStatusOrAssessmentStatusResponse (wymagane) |
SecurityAssessmentPropertiesBaseAdditionalData
| Nazwa | Opis | Wartość |
|---|---|---|
| {niestandardowa właściwość} | ciąg |
SecurityAssessmentMetadataProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| assessmentType | BuiltIn, jeśli ocena oparta na wbudowanej definicji Azure Policy, Niestandardowy, jeśli ocena oparta na niestandardowej definicji Azure Policy | "BuiltIn" "CustomPolicy" "CustomerManaged" "VerifiedPartner" (wymagane) |
| categories | Tablica ciągów zawierająca dowolną z: "Obliczenia" "Dane" "IdentityAndAccess" "IoT" "Sieć" |
|
| description (opis) | Czytelny opis oceny przez człowieka | ciąg |
| displayName | Przyjazna dla użytkownika nazwa wyświetlana oceny | ciąg (wymagany) |
| implementationEffort | Nakład pracy nad wdrożeniem wymagany do skorygowania tej oceny | "Wysoki" "Niski" "Umiarkowany" |
| partnerData | Opisuje partnera, który utworzył ocenę | SecurityAssessmentMetadataPartnerData |
| preview | 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 | ciąg |
| ważność | Poziom ważności oceny | "Wysoki" "Niski" "Średni" (wymagany) |
| Zagrożeń | Tablica ciągów zawierająca dowolną z: "accountBreach" "dataExfiltration" "dataSpillage" "denialOfService" "elevationOfPrivilege" "maliciousInsider" "missingCoverage" "threatResistance" |
|
| userImpact | Wpływ oceny na użytkownika | "Wysoki" "Niski" "Umiarkowany" |
SecurityAssessmentMetadataPartnerData
| Nazwa | Opis | Wartość |
|---|---|---|
| partnerName | Nazwa firmy partnera | ciąg (wymagany) |
| Productname | Nazwa produktu partnera, który utworzył ocenę | ciąg |
| wpis tajny | Wpis tajny w celu uwierzytelnienia partnera i zweryfikowania, czy utworzono ocenę — tylko zapis | ciąg (wymagany) Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
SecurityAssessmentPartnerData
| Nazwa | Opis | Wartość |
|---|---|---|
| partnerName | Nazwa firmy partnera | ciąg (wymagany) |
| wpis tajny | wpis tajny do uwierzytelniania partnera — tylko zapis | ciąg (wymagany) Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
ResourceDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| source | Ustawianie typu obiektu | Azure OnPremiseSql (wymagane) |
AzureResourceDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| source | Platforma, na której znajduje się oceniony zasób | "Azure" (wymagane) |
OnPremiseSqlResourceDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| source | Platforma, na której znajduje się oceniony zasób | "OnPremiseSql" (wymagane) |
| databaseName | Nazwa bazy danych Sql zainstalowana na maszynie | ciąg (wymagany) |
| Machinename | Nazwa maszyny | ciąg (wymagany) |
| serverName | Nazwa serwera SQL zainstalowana na maszynie | ciąg (wymagany) |
| 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óry jest dołączony komputer | ciąg (wymagany) |
AssessmentStatusOrAssessmentStatusResponse
| Nazwa | Opis | Wartość |
|---|---|---|
| Spowodować | Kod programowy przyczyny stanu oceny | ciąg |
| kod | Kod programowy stanu oceny | "W dobrej kondycji" "NotApplicable" "W złej kondycji" (wymagane) |
| description (opis) | Czytelny opis stanu oceny przez człowieka | ciąg |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu oceny to zasób rozszerzenia, co oznacza, że można zastosować go do innego zasobu.
parent_id Użyj właściwości w tym zasobie, aby ustawić zakres dla tego zasobu.
Typ zasobu oceny można wdrożyć z operacjami docelowymi:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Security/assessments, dodaj następujący element 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łową , aby określić typ obiektu.
W przypadku platformy Azure użyj:
source = "Azure"
W przypadku onPremiseSql użyj:
source = "OnPremiseSql"
databaseName = "string"
machineName = "string"
serverName = "string"
sourceComputerId = "string"
vmuuid = "string"
workspaceId = "string"
Wartości właściwości
oceny
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.Security/assessments@2021-06-01" |
| name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 1–260 Prawidłowe znaki: Alfanumeryczne, podkreślenia i łączniki. |
| parent_id | Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. | ciąg (wymagany) |
| properties | Opisuje właściwości oceny. | SecurityAssessmentPropertiesOrSecurityAssessmentProp... |
SecurityAssessmentPropertiesOrSecurityAssessmentProp...
| Nazwa | Opis | Wartość |
|---|---|---|
| additionalData | Dodatkowe dane dotyczące oceny | SecurityAssessmentPropertiesBaseAdditionalData |
| metadane | Opisuje właściwości metadanych oceny. | SecurityAssessmentMetadataProperties |
| partnersData | Dane dotyczące integracji partnerów innych firm | SecurityAssessmentPartnerData |
| resourceDetails | Szczegóły zasobu, który został oceniony | ResourceDetails (wymagane) |
| status | Wynik oceny | AssessmentStatusOrAssessmentStatusResponse (wymagane) |
SecurityAssessmentPropertiesBaseAdditionalData
| Nazwa | Opis | Wartość |
|---|---|---|
| {niestandardowa właściwość} | ciąg |
SecurityAssessmentMetadataProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| assessmentType | BuiltIn, jeśli ocena oparta na wbudowanej definicji Azure Policy, Niestandardowy, jeśli ocena oparta na niestandardowej definicji Azure Policy | "BuiltIn" "CustomPolicy" "CustomerManaged" "VerifiedPartner" (wymagane) |
| categories | Tablica ciągów zawierająca dowolną z: "Obliczenia" "Dane" "IdentityAndAccess" "IoT" "Sieć" |
|
| description (opis) | Czytelny opis oceny przez człowieka | ciąg |
| displayName | Przyjazna dla użytkownika nazwa wyświetlana oceny | ciąg (wymagany) |
| implementationEffort | Nakład pracy nad wdrożeniem wymagany do skorygowania tej oceny | "Wysoki" "Niski" "Umiarkowany" |
| partnerData | Opisuje partnera, który utworzył ocenę | SecurityAssessmentMetadataPartnerData |
| preview | 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 | ciąg |
| ważność | Poziom ważności oceny | "Wysoki" "Niski" "Średni" (wymagany) |
| Zagrożeń | Tablica ciągów zawierająca dowolną z: "accountBreach" "dataExfiltration" "dataSpillage" "denialOfService" "elevationOfPrivilege" "maliciousInsider" "missingCoverage" "threatResistance" |
|
| userImpact | Wpływ oceny na użytkownika | "Wysoki" "Niski" "Umiarkowany" |
SecurityAssessmentMetadataPartnerData
| Nazwa | Opis | Wartość |
|---|---|---|
| partnerName | Nazwa firmy partnera | ciąg (wymagany) |
| Productname | Nazwa produktu partnera, który utworzył ocenę | ciąg |
| wpis tajny | Wpis tajny w celu uwierzytelnienia partnera i zweryfikowania, czy utworzono ocenę — tylko zapis | ciąg (wymagany) Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
SecurityAssessmentPartnerData
| Nazwa | Opis | Wartość |
|---|---|---|
| partnerName | Nazwa firmy partnera | ciąg (wymagany) |
| wpis tajny | wpis tajny do uwierzytelniania partnera — tylko zapis | ciąg (wymagany) Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
ResourceDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| source | Ustawianie typu obiektu | Azure OnPremiseSql (wymagane) |
AzureResourceDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| source | Platforma, na której znajduje się oceniony zasób | "Azure" (wymagane) |
OnPremiseSqlResourceDetails
| Nazwa | Opis | Wartość |
|---|---|---|
| source | Platforma, na której znajduje się oceniony zasób | "OnPremiseSql" (wymagane) |
| databaseName | Nazwa bazy danych Sql zainstalowana na maszynie | ciąg (wymagany) |
| Machinename | Nazwa maszyny | ciąg (wymagany) |
| serverName | Nazwa serwera SQL zainstalowana na maszynie | ciąg (wymagany) |
| 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óry jest dołączony komputer | ciąg (wymagany) |
AssessmentStatusOrAssessmentStatusResponse
| Nazwa | Opis | Wartość |
|---|---|---|
| Spowodować | Kod programowy przyczyny stanu oceny | ciąg |
| kod | Kod programowy stanu oceny | "W dobrej kondycji" "NotApplicable" "W złej kondycji" (wymagane) |
| description (opis) | Czytelny opis stanu oceny przez człowieka | ciąg |