Remediations - List For Management Group
Hiermee haalt u alle herstelbewerkingen voor de beheergroep op.
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations?api-version=2021-10-01
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations?$top={$top}&$filter={$filter}&api-version=2021-10-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
management
|
path | True |
string |
Beheergroep-id. |
management
|
path | True |
De naamruimte voor Microsoft Management RP; alleen 'Microsoft.Management' is toegestaan. |
|
api-version
|
query | True |
string |
Client-API-versie. |
$filter
|
query |
string |
OData-filterexpressie. |
|
$top
|
query |
integer int32 |
Maximum aantal records dat moet worden geretourneerd. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De opgehaalde herstelbewerkingen. |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
List remediations at management group scope |
List remediations at management group scope with query parameters |
List remediations at management group scope
Sample Request
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/financeMg/providers/Microsoft.PolicyInsights/remediations?api-version=2021-10-01
Sample Response
{
"value": [
{
"properties": {
"policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/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": "/providers/Microsoft.Management/managementGroups/financeMg/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:51:09.075918Z",
"lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-09-13T21:52:10.0011706Z"
}
},
{
"properties": {
"policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/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": "/providers/Microsoft.Management/managementGroups/financeMg/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 management group scope with query parameters
Sample Request
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/financeMg/providers/Microsoft.PolicyInsights/remediations?$top=1&$filter=PolicyAssignmentId eq '/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5'&api-version=2021-10-01
Sample Response
{
"value": [
{
"properties": {
"policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/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": "/providers/Microsoft.Management/managementGroups/financeMg/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:51:09.075918Z",
"lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-09-13T21:52:10.0011706Z"
}
}
]
}
Definities
Name | Description |
---|---|
created |
Het type identiteit waarmee de resource is gemaakt. |
Error |
Foutdefinitie. |
Error |
Foutreactie. |
Failure |
De instellingen voor drempelwaarden voor herstelfouten |
Management |
De naamruimte voor Microsoft Management RP; alleen 'Microsoft.Management' is toegestaan. |
Remediation |
De hersteldefinitie. |
Remediation |
Het overzicht van de implementatiestatus voor alle implementaties die door het herstel zijn gemaakt. |
Remediation |
De filters die worden toegepast om te bepalen welke resources moeten worden hersteld. |
Remediation |
Lijst met herstelbewerkingen. |
Resource |
De manier waarop resources worden gedetecteerd die moeten worden hersteld. De standaardinstelling is ExistingNonCompliant als dit niet is opgegeven. |
system |
Metagegevens met betrekking tot het maken en laatste wijzigen van de resource. |
Typed |
Scenariospecifieke foutdetails. |
createdByType
Het type identiteit waarmee de resource is gemaakt.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDefinition
Foutdefinitie.
Name | Type | Description |
---|---|---|
additionalInfo |
Aanvullende scenariospecifieke foutdetails. |
|
code |
string |
Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode. |
details |
Details van interne fouten. |
|
message |
string |
Beschrijving van de fout. |
target |
string |
Het doel van de fout. |
ErrorResponse
Foutreactie.
Name | Type | Description |
---|---|---|
error |
De foutdetails. |
FailureThreshold
De instellingen voor drempelwaarden voor herstelfouten
Name | Type | Description |
---|---|---|
percentage |
number |
Een getal tussen 0,0 en 1,0 dat de drempelwaarde voor het foutpercentage vertegenwoordigt. Het herstel mislukt als het percentage mislukte herstelbewerkingen (d.w.w. mislukte implementaties) deze drempelwaarde overschrijdt. |
ManagementGroupsNamespaceType
De naamruimte voor Microsoft Management RP; alleen 'Microsoft.Management' is toegestaan.
Name | Type | Description |
---|---|---|
Microsoft.Management |
string |
Remediation
De hersteldefinitie.
Name | Type | Description |
---|---|---|
id |
string |
De id van het herstel. |
name |
string |
De naam van het herstel. |
properties.correlationId |
string |
De correlatie-id voor herstel. Kan worden gebruikt om gebeurtenissen te vinden die betrekking hebben op het herstel in het activiteitenlogboek. |
properties.createdOn |
string |
Het tijdstip waarop het herstel is gemaakt. |
properties.deploymentStatus |
Het overzicht van de implementatiestatus voor alle implementaties die door het herstel zijn gemaakt. |
|
properties.failureThreshold |
De instellingen voor drempelwaarden voor herstelfouten |
|
properties.filters |
De filters die worden toegepast om te bepalen welke resources moeten worden hersteld. |
|
properties.lastUpdatedOn |
string |
Het tijdstip waarop het herstel voor het laatst is bijgewerkt. |
properties.parallelDeployments |
integer |
Bepaalt hoeveel resources op een bepaald moment moeten worden hersteld. Kan worden gebruikt om het tempo van het herstel te verhogen of te verlagen. Als dit niet wordt opgegeven, wordt de standaardwaarde voor parallelle implementaties gebruikt. |
properties.policyAssignmentId |
string |
De resource-id van de beleidstoewijzing die moet worden hersteld. |
properties.policyDefinitionReferenceId |
string |
De referentie-id van de beleidsdefinitie van de afzonderlijke definitie die moet worden hersteld. Vereist wanneer de beleidstoewijzing die wordt hersteld, een definitie van een beleidsset toewijst. |
properties.provisioningState |
string |
De status van het herstel. Dit verwijst naar de volledige hersteltaak, niet naar afzonderlijke implementaties. Toegestane waarden zijn Evalueren, Geannuleerd, Annuleren, Mislukt, Voltooid of Geslaagd. |
properties.resourceCount |
integer |
Bepaalt het maximum aantal resources dat kan worden hersteld door de hersteltaak. Als dit niet wordt opgegeven, wordt het standaardaantal resources gebruikt. |
properties.resourceDiscoveryMode |
De manier waarop resources worden gedetecteerd die moeten worden hersteld. De standaardinstelling is ExistingNonCompliant als dit niet is opgegeven. |
|
properties.statusMessage |
string |
Het statusbericht voor herstel. Bevat aanvullende informatie over de status van het herstel. |
systemData |
Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy. |
|
type |
string |
Het type herstel. |
RemediationDeploymentSummary
Het overzicht van de implementatiestatus voor alle implementaties die door het herstel zijn gemaakt.
Name | Type | Description |
---|---|---|
failedDeployments |
integer |
Het aantal implementaties dat is vereist voor het herstel dat is mislukt. |
successfulDeployments |
integer |
Het aantal implementaties dat is vereist voor het herstel dat is geslaagd. |
totalDeployments |
integer |
Het aantal implementaties dat is vereist voor het herstel. |
RemediationFilters
De filters die worden toegepast om te bepalen welke resources moeten worden hersteld.
Name | Type | Description |
---|---|---|
locations |
string[] |
De resourcelocaties die worden hersteld. |
RemediationListResult
Lijst met herstelbewerkingen.
Name | Type | Description |
---|---|---|
nextLink |
string |
De URL voor het ophalen van de volgende set resultaten. |
value |
Matrix met hersteldefinities. |
ResourceDiscoveryMode
De manier waarop resources worden gedetecteerd die moeten worden hersteld. De standaardinstelling is ExistingNonCompliant als dit niet is opgegeven.
Name | Type | Description |
---|---|---|
ExistingNonCompliant |
string |
Herstel resources die al niet compatibel zijn. |
ReEvaluateCompliance |
string |
Evalueer de nalevingsstatus van resources opnieuw en herstel vervolgens de resources die niet-compatibel zijn. |
systemData
Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
Het tijdstempel van het maken van resources (UTC). |
createdBy |
string |
De identiteit waarmee de resource is gemaakt. |
createdByType |
Het type identiteit waarmee de resource is gemaakt. |
|
lastModifiedAt |
string |
De tijdstempel van de laatste wijziging van de resource (UTC) |
lastModifiedBy |
string |
De identiteit die de resource het laatst heeft gewijzigd. |
lastModifiedByType |
Het type identiteit dat de resource het laatst heeft gewijzigd. |
TypedErrorInfo
Scenariospecifieke foutdetails.
Name | Type | Description |
---|---|---|
info |
De specifieke foutdetails van het scenario. |
|
type |
string |
Het type opgenomen foutdetails. |