Remediations - Cancel At Resource Group
Hiermee annuleert u een herstel binnen het bereik van de resourcegroep.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel?api-version=2021-10-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
remediation
|
path | True |
string |
De naam van het herstel. |
resource
|
path | True |
string |
Naam van de resourcegroep. |
subscription
|
path | True |
string |
Microsoft Azure-abonnements-id. |
api-version
|
query | True |
string |
Client-API-versie. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Het herstel dat is geannuleerd. |
|
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
Cancel a remediation at resource group scope
Sample Request
POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/remediations/myRemediation/cancel?api-version=2021-10-01
Sample Response
{
"properties": {
"policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
"provisioningState": "Cancelling",
"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/myRemediation",
"name": "myRemediation",
"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 de drempelwaarde voor herstelfouten |
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. |
Resource |
De manier waarop resources worden gedetecteerd om te herstellen. De standaardinstelling is ExistingNonCompliant als deze 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 |
Interne foutdetails. |
|
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 de drempelwaarde voor herstelfouten
Name | Type | Description |
---|---|---|
percentage |
number |
Een getal tussen 0,0 en 1,0 dat de drempelwaarde voor het percentage fouten aangeeft. Het herstel mislukt als het percentage mislukte herstelbewerkingen (dat wil zeggen mislukte implementaties) deze drempelwaarde overschrijdt. |
Remediation
De hersteldefinitie.
Name | Type | Description |
---|---|---|
id |
string |
De id van het herstel. |
name |
string |
De naam van het herstel. |
properties.correlationId |
string |
De herstelcorrelatie-id. 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 de drempelwaarde 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 er 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 om te herstellen. De standaardinstelling is ExistingNonCompliant als deze niet is opgegeven. |
|
properties.statusMessage |
string |
Het bericht over de herstelstatus. Biedt 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. |
ResourceDiscoveryMode
De manier waarop resources worden gedetecteerd om te herstellen. De standaardinstelling is ExistingNonCompliant als deze 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 |
De tijdstempel van het maken van resources (UTC). |
createdBy |
string |
De identiteit die de resource heeft gemaakt. |
createdByType |
Het type identiteit waarmee de resource is gemaakt. |
|
lastModifiedAt |
string |
Het 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. |