Remediations - List For Resource Group
Ruft alle Korrekturen für das Abonnement ab.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations?api-version=2021-10-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations?$top={$top}&$filter={$filter}&api-version=2021-10-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Ressourcengruppenname |
subscription
|
path | True |
string |
Microsoft Azure-Abonnement-ID. |
api-version
|
query | True |
string |
Client-API-Version. |
$filter
|
query |
string |
OData-Filterausdruck. |
|
$top
|
query |
integer int32 |
Maximale Anzahl von Datensätzen, die zurückgegeben werden sollen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die abgerufenen Korrekturen. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
List remediations at resource group scope |
List remediations at resource group scope with query parameters |
List remediations at resource group scope
Beispielanforderung
GET https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/remediations?api-version=2021-10-01
Beispiel für eine Antwort
{
"value": [
{
"properties": {
"policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
"provisioningState": "Succeeded",
"createdOn": "2018-09-13T21:51:09.075918Z",
"lastUpdatedOn": "2018-09-13T21:52:10.0011706Z",
"resourceDiscoveryMode": "ExistingNonCompliant",
"deploymentStatus": {
"totalDeployments": 2,
"successfulDeployments": 2,
"failedDeployments": 0
},
"statusMessage": "Remediation extended status",
"correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6",
"resourceCount": 42,
"parallelDeployments": 6,
"failureThreshold": {
"percentage": 0.1
}
},
"id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
"name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
"type": "Microsoft.PolicyInsights/remediations",
"systemData": {
"createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"createdByType": "User",
"createdAt": "2018-09-13T21:49:16.4638131Z",
"lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-09-13T21:50:18.4647478Z"
}
},
{
"properties": {
"policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
"provisioningState": "Succeeded",
"createdOn": "2018-09-13T21:49:16.4638131Z",
"lastUpdatedOn": "2018-09-13T21:50:18.4647478Z",
"resourceDiscoveryMode": "ExistingNonCompliant",
"deploymentStatus": {
"totalDeployments": 2,
"successfulDeployments": 2,
"failedDeployments": 0
},
"statusMessage": "Remediation extended status",
"correlationId": "957378d3-a143-421e-8b0e-3048dff01932"
},
"id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/0866f0cc-6cb3-422c-9fb6-a4e3e2266da8",
"name": "0866f0cc-6cb3-422c-9fb6-a4e3e2266da8",
"type": "Microsoft.PolicyInsights/remediations",
"systemData": {
"createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"createdByType": "User",
"createdAt": "2018-09-13T21:49:16.4638131Z",
"lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-09-13T21:50:18.4647478Z"
}
}
]
}
List remediations at resource group scope with query parameters
Beispielanforderung
GET https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/remediations?$top=1&$filter=PolicyAssignmentId eq '/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5'&api-version=2021-10-01
Beispiel für eine Antwort
{
"value": [
{
"properties": {
"policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
"provisioningState": "Succeeded",
"createdOn": "2018-09-13T21:51:09.075918Z",
"lastUpdatedOn": "2018-09-13T21:52:10.0011706Z",
"resourceDiscoveryMode": "ExistingNonCompliant",
"deploymentStatus": {
"totalDeployments": 2,
"successfulDeployments": 2,
"failedDeployments": 0
},
"statusMessage": "Remediation extended status",
"correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6",
"resourceCount": 42,
"parallelDeployments": 6,
"failureThreshold": {
"percentage": 0.1
}
},
"id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
"name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
"type": "Microsoft.PolicyInsights/remediations",
"systemData": {
"createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"createdByType": "User",
"createdAt": "2018-09-13T21:49:16.4638131Z",
"lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-09-13T21:50:18.4647478Z"
}
},
{
"properties": {
"policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
"provisioningState": "Succeeded",
"createdOn": "2018-09-13T21:49:16.4638131Z",
"lastUpdatedOn": "2018-09-13T21:50:18.4647478Z",
"resourceDiscoveryMode": "ExistingNonCompliant",
"deploymentStatus": {
"totalDeployments": 2,
"successfulDeployments": 2,
"failedDeployments": 0
},
"statusMessage": "Remediation extended status",
"correlationId": "957378d3-a143-421e-8b0e-3048dff01932"
},
"id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/0866f0cc-6cb3-422c-9fb6-a4e3e2266da8",
"name": "0866f0cc-6cb3-422c-9fb6-a4e3e2266da8",
"type": "Microsoft.PolicyInsights/remediations",
"systemData": {
"createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"createdByType": "User",
"createdAt": "2018-09-13T21:49:16.4638131Z",
"lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-09-13T21:50:18.4647478Z"
}
}
]
}
Definitionen
Name | Beschreibung |
---|---|
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Error |
Fehlerdefinition. |
Error |
Fehlerantwort. |
Failure |
Schwellenwerteinstellungen für Behebungsfehler |
Remediation |
Die Wartungsdefinition. |
Remediation |
Die Bereitstellung status Zusammenfassung für alle Bereitstellungen, die durch die Wartung erstellt wurden. |
Remediation |
Die Filter, die angewendet werden, um zu bestimmen, welche Ressourcen behoben werden sollen. |
Remediation |
Liste der Korrekturen. |
Resource |
Die Art und Weise, wie Ressourcen zur Behebung ermittelt werden. Wird standardmäßig Auf ExistingNonCompliant festgelegt, wenn nicht angegeben. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
Typed |
Szenariospezifische Fehlerdetails. |
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. |
FailureThreshold
Schwellenwerteinstellungen für Behebungsfehler
Name | Typ | Beschreibung |
---|---|---|
percentage |
number |
Eine Zahl zwischen 0,0 und 1,0, die den Prozentsatz des Fehlerschwellenwerts darstellt. Die Wartung schlägt fehl, wenn der Prozentsatz der fehlgeschlagenen Wartungsvorgänge (d. h. fehlgeschlagene Bereitstellungen) diesen Schwellenwert überschreitet. |
Remediation
Die Wartungsdefinition.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Die ID der Korrektur. |
name |
string |
Der Name der Korrektur. |
properties.correlationId |
string |
Die Wartungskorrelations-ID. Kann verwendet werden, um Ereignisse im Zusammenhang mit der Behebung im Aktivitätsprotokoll zu finden. |
properties.createdOn |
string |
Der Zeitpunkt, zu dem die Korrektur erstellt wurde. |
properties.deploymentStatus |
Die Bereitstellung status Zusammenfassung für alle Bereitstellungen, die durch die Wartung erstellt wurden. |
|
properties.failureThreshold |
Schwellenwerteinstellungen für Behebungsfehler |
|
properties.filters |
Die Filter, die angewendet werden, um zu bestimmen, welche Ressourcen behoben werden sollen. |
|
properties.lastUpdatedOn |
string |
Der Zeitpunkt, zu dem die Korrektur zuletzt aktualisiert wurde. |
properties.parallelDeployments |
integer |
Bestimmt, wie viele Ressourcen zu einem bestimmten Zeitpunkt behoben werden müssen. Kann verwendet werden, um das Tempo der Sanierung zu erhöhen oder zu reduzieren. Falls nicht angegeben, wird der Standardwert für parallele Bereitstellungen verwendet. |
properties.policyAssignmentId |
string |
Die Ressourcen-ID der Richtlinienzuweisung, die behoben werden soll. |
properties.policyDefinitionReferenceId |
string |
Die Referenz-ID der Richtliniendefinition der einzelnen Definition, die behoben werden soll. Erforderlich, wenn die zu korrigierende Richtlinienzuweisung eine Richtliniensatzdefinition zuweist. |
properties.provisioningState |
string |
Der status der Behebung. Dies bezieht sich auf die gesamte Wartungsaufgabe, nicht auf einzelne Bereitstellungen. Zulässige Werte sind Auswerten, Abgebrochen, Abbrechen, Fehler, Abgeschlossen oder Erfolgreich. |
properties.resourceCount |
integer |
Bestimmt die maximale Anzahl von Ressourcen, die vom Wartungsauftrag behoben werden können. Falls nicht angegeben, wird die Standardressourcenanzahl verwendet. |
properties.resourceDiscoveryMode |
Die Art und Weise, wie Ressourcen zur Behebung ermittelt werden. Wird standardmäßig Auf ExistingNonCompliant festgelegt, wenn nicht angegeben. |
|
properties.statusMessage |
string |
Die Behebung status Meldung. Stellt zusätzliche Details zum Zustand der Wartung bereit. |
systemData |
Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen. |
|
type |
string |
Der Typ der Korrektur. |
RemediationDeploymentSummary
Die Bereitstellung status Zusammenfassung für alle Bereitstellungen, die durch die Wartung erstellt wurden.
Name | Typ | Beschreibung |
---|---|---|
failedDeployments |
integer |
Die Anzahl der Bereitstellungen, die für die Wartung erforderlich sind, bei denen ein Fehler aufgetreten ist. |
successfulDeployments |
integer |
Die Anzahl der Bereitstellungen, die von der erfolgreichen Wartung erforderlich sind. |
totalDeployments |
integer |
Die Anzahl der Bereitstellungen, die für die Wartung erforderlich sind. |
RemediationFilters
Die Filter, die angewendet werden, um zu bestimmen, welche Ressourcen behoben werden sollen.
Name | Typ | Beschreibung |
---|---|---|
locations |
string[] |
Die Ressourcenspeicherorte, die behoben werden. |
RemediationListResult
Liste der Korrekturen.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Die URL zum Abrufen der nächsten Gruppe von Ergebnissen. |
value |
Array von Korrekturdefinitionen. |
ResourceDiscoveryMode
Die Art und Weise, wie Ressourcen zur Behebung ermittelt werden. Wird standardmäßig Auf ExistingNonCompliant festgelegt, wenn nicht angegeben.
Name | Typ | Beschreibung |
---|---|---|
ExistingNonCompliant |
string |
Korrigieren sie Ressourcen, von denen bereits bekannt ist, dass sie nicht konform sind. |
ReEvaluateCompliance |
string |
Bewerten Sie den Kompatibilitätsstatus der Ressourcen erneut, und korrigieren Sie dann die Ressourcen, die als nicht konform eingestuft wurden. |
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. |