Attestations - Create Or Update At Resource
Erstellt oder aktualisiert einen Nachweis im Ressourcenbereich.
PUT https://management.azure.com/{resourceId}/providers/Microsoft.PolicyInsights/attestations/{attestationName}?api-version=2022-09-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
attestation
|
path | True |
string |
Der Name des Nachweises. |
resource
|
path | True |
string |
Ressourcen-ID |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
properties.policyAssignmentId | True |
string |
Die Ressourcen-ID der Richtlinienzuweisung, für die der Nachweis den Status festlegt. |
properties.assessmentDate |
string |
Der Zeitpunkt der Beweiswürdigung |
|
properties.comments |
string |
Kommentare, die beschreiben, warum dieser Nachweis erstellt wurde. |
|
properties.complianceState |
Der Konformitätszustand, der für die Ressource festgelegt werden soll. |
||
properties.evidence |
Der Nachweis, der den in diesem Nachweis festgelegten Konformitätszustand unterstützt. |
||
properties.expiresOn |
string |
Der Zeitpunkt, zu dem der Konformitätszustand abläuft. |
|
properties.metadata |
object |
Zusätzliche Metadaten für diesen Nachweis |
|
properties.owner |
string |
Die Person, die für das Festlegen des Zustands der Ressource verantwortlich ist. Dieser Wert ist in der Regel eine Azure Active Directory-Objekt-ID. |
|
properties.policyDefinitionReferenceId |
string |
Die Richtliniendefinitions-Referenz-ID aus einer Richtliniensatzdefinition, für die der Nachweis den Status festlegt. Wenn die Richtlinienzuweisung eine Richtliniensatzdefinition zuweist, kann der Nachweis eine Definition innerhalb der Setdefinition mit dieser Eigenschaft auswählen oder diese auslassen und den Zustand für die gesamte Mengendefinition festlegen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der aktualisierte Nachweis. |
|
201 Created |
Der erstellte Nachweis. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Create attestation at individual resource scope
Sample Request
PUT https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM/providers/Microsoft.PolicyInsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e?api-version=2022-09-01
{
"properties": {
"policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
"policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551",
"complianceState": "Compliant",
"expiresOn": "2021-06-15T00:00:00Z",
"owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966",
"comments": "This subscription has passed a security audit.",
"evidence": [
{
"description": "The results of the security audit.",
"sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011"
}
],
"assessmentDate": "2021-06-10T00:00:00Z",
"metadata": {
"departmentId": "NYC-MARKETING-1"
}
}
}
Sample Response
{
"properties": {
"policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
"policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551",
"complianceState": "Compliant",
"lastComplianceStateChangeAt": "2020-06-15T18:52:27Z",
"expiresOn": "2021-06-15T00:00:00Z",
"owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966",
"comments": "This subscription has passed a security audit.",
"evidence": [
{
"description": "The results of the security audit.",
"sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011"
}
],
"assessmentDate": "2021-06-10T00:00:00Z",
"metadata": {
"departmentId": "NYC-MARKETING-1"
},
"provisioningState": "Succeeded"
},
"systemData": {
"createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"createdByType": "User",
"createdAt": "2020-06-15T18:52:27Z",
"lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"lastModifiedByType": "User",
"lastModifiedAt": "2020-06-15T18:52:27Z"
},
"id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
"name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
"type": "Microsoft.PolicyInsights/attestations"
}
{
"properties": {
"policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
"policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551",
"complianceState": "Compliant",
"lastComplianceStateChangeAt": "2020-06-15T18:52:27Z",
"expiresOn": "2021-06-15T00:00:00Z",
"owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966",
"comments": "This subscription has passed a security audit.",
"evidence": [
{
"description": "The results of the security audit.",
"sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011"
}
],
"assessmentDate": "2021-06-10T00:00:00Z",
"metadata": {
"departmentId": "NYC-MARKETING-1"
},
"provisioningState": "Succeeded"
},
"systemData": {
"createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"createdByType": "User",
"createdAt": "2020-06-15T18:52:27Z",
"lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"lastModifiedByType": "User",
"lastModifiedAt": "2020-06-15T18:52:27Z"
},
"id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
"name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
"type": "Microsoft.PolicyInsights/attestations"
}
Definitionen
Name | Beschreibung |
---|---|
Attestation |
Eine Nachweisressource. |
Attestation |
Ein Beweis, der den im Nachweis festgelegten Konformitätsstatus unterstützt. |
Compliance |
Der Konformitätszustand, der für die Ressource festgelegt werden soll. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Error |
Fehlerdefinition. |
Error |
Fehlerantwort. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
Typed |
Szenariospezifische Fehlerdetails. |
Attestation
Eine Nachweisressource.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties.assessmentDate |
string |
Der Zeitpunkt der Beweiswürdigung |
properties.comments |
string |
Kommentare, die beschreiben, warum dieser Nachweis erstellt wurde. |
properties.complianceState |
Der Konformitätszustand, der für die Ressource festgelegt werden soll. |
|
properties.evidence |
Der Nachweis, der den in diesem Nachweis festgelegten Konformitätszustand unterstützt. |
|
properties.expiresOn |
string |
Der Zeitpunkt, zu dem der Konformitätszustand abläuft. |
properties.lastComplianceStateChangeAt |
string |
Der Zeitpunkt, zu dem der Konformitätszustand zuletzt in diesem Nachweis geändert wurde. |
properties.metadata |
object |
Zusätzliche Metadaten für diesen Nachweis |
properties.owner |
string |
Die Person, die für das Festlegen des Zustands der Ressource verantwortlich ist. Dieser Wert ist in der Regel eine Azure Active Directory-Objekt-ID. |
properties.policyAssignmentId |
string |
Die Ressourcen-ID der Richtlinienzuweisung, für die der Nachweis den Status festlegt. |
properties.policyDefinitionReferenceId |
string |
Die Richtliniendefinitions-Referenz-ID aus einer Richtliniensatzdefinition, für die der Nachweis den Status festlegt. Wenn die Richtlinienzuweisung eine Richtliniensatzdefinition zuweist, kann der Nachweis eine Definition innerhalb der Setdefinition mit dieser Eigenschaft auswählen oder diese auslassen und den Zustand für die gesamte Mengendefinition festlegen. |
properties.provisioningState |
string |
Die status des Nachweises. |
systemData |
Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen. |
|
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
AttestationEvidence
Ein Beweis, der den im Nachweis festgelegten Konformitätsstatus unterstützt.
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Die Beschreibung dieses Beweisstücks. |
sourceUri |
string |
Der URI-Speicherort des Beweiss. |
ComplianceState
Der Konformitätszustand, der für die Ressource festgelegt werden soll.
Name | Typ | Beschreibung |
---|---|---|
Compliant |
string |
Die Ressource entspricht der Richtlinie. |
NonCompliant |
string |
Die Ressource entspricht nicht der Richtlinie. |
Unknown |
string |
Der Konformitätsstatus der Ressource ist nicht bekannt. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDefinition
Fehlerdefinition.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Zusätzliche szenariospezifische Fehlerdetails. |
|
code |
string |
Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient. |
details |
Interne Fehlerdetails. |
|
message |
string |
Beschreibung des Fehlers |
target |
string |
Das Ziel des Fehlers. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Die Fehlerdetails. |
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
TypedErrorInfo
Szenariospezifische Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
info |
Die szenariospezifischen Fehlerdetails. |
|
type |
string |
Der Typ der enthaltenen Fehlerdetails. |