Remediations - Get At Resource

Service:: Policy

Version d'API:: 2024-10-01

Obtient une correction existante au niveau de l’étendue de la ressource.

GET https://management.azure.com/{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}?api-version=2024-10-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
remediationName	path	True	string	Nom de la correction.
resourceId	path	True	string	ID de ressource.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	Remediation	Correction récupérée.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get remediation at individual resource scope

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/Microsoft.PolicyInsights/remediations/storageRemediation?api-version=2024-10-01

Exemple de réponse

Code d’état:: 200

{
  "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": 1,
      "successfulDeployments": 1,
      "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.storage/storageaccounts/storAc1/providers/microsoft.policyinsights/remediations/storageRemediation",
  "name": "storageRemediation",
  "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"
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorDefinition	Définition d’erreur.
ErrorResponse	Réponse d’erreur.
FailureThreshold	Paramètres de seuil d’échec de correction
Remediation	Définition de correction.
RemediationDeploymentSummary	Résumé de l’état du déploiement pour tous les déploiements créés par la correction.
RemediationFilters	Filtres qui seront appliqués pour déterminer les ressources à corriger.
ResourceDiscoveryMode	La façon dont les ressources à corriger sont découvertes. La valeur par défaut est ExistingNonCompliant si elle n’est pas spécifiée.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TypedErrorInfo	Détails d’erreur spécifiques au scénario.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorDefinition

Objet

Définition d’erreur.

Nom	Type	Description
additionalInfo	TypedErrorInfo[]	Détails d’erreur spécifiques au scénario supplémentaire.
code	string	Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
details	ErrorDefinition[]	Détails de l’erreur interne.
message	string	Description de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
error	ErrorDefinition	Détails de l’erreur.

FailureThreshold

Objet

Paramètres de seuil d’échec de correction

Nom	Type	Description
percentage	number (float)	Nombre compris entre 0,0 et 1,0 représentant le seuil d’échec du pourcentage. La correction échoue si le pourcentage d’opérations de correction ayant échoué (c’est-à-dire les déploiements ayant échoué) dépasse ce seuil.

Remediation

Objet

Définition de correction.

Nom	Type	Description
id	string	ID de la correction.
name	string	Nom de la correction.
properties.correlationId	string	ID de corrélation de correction. Permet de rechercher des événements liés à la correction dans le journal d’activité.
properties.createdOn	string (date-time)	Heure à laquelle la correction a été créée.
properties.deploymentStatus	RemediationDeploymentSummary	Résumé de l’état du déploiement pour tous les déploiements créés par la correction.
properties.failureThreshold	FailureThreshold	Paramètres de seuil d’échec de correction
properties.filters	RemediationFilters	Filtres qui seront appliqués pour déterminer les ressources à corriger.
properties.lastUpdatedOn	string (date-time)	Heure à laquelle la correction a été mise à jour pour la dernière fois.
properties.parallelDeployments	integer (int32)	Détermine le nombre de ressources à corriger à un moment donné. Peut être utilisé pour augmenter ou réduire le rythme de la correction. S’il n’est pas fourni, la valeur des déploiements parallèles par défaut est utilisée.
properties.policyAssignmentId	string	ID de ressource de l’affectation de stratégie qui doit être corrigé.
properties.policyDefinitionReferenceId	string	ID de référence de définition de stratégie de la définition individuelle à corriger. Obligatoire lorsque l’attribution de stratégie en cours de correction affecte une définition d’ensemble de stratégies.
properties.provisioningState	string	État de la correction. Cela fait référence à l’ensemble de la tâche de correction, et non à des déploiements individuels. Les valeurs autorisées sont l’évaluation, l’annulation, l’annulation, l’échec, la fin ou la réussite.
properties.resourceCount	integer (int32)	Détermine le nombre maximal de ressources qui peuvent être corrigées par le travail de correction. S’il n’est pas fourni, le nombre de ressources par défaut est utilisé.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	La façon dont les ressources à corriger sont découvertes. La valeur par défaut est ExistingNonCompliant si elle n’est pas spécifiée.
properties.statusMessage	string	Message d’état de correction. Fournit des détails supplémentaires sur l’état de la correction.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la correction.

RemediationDeploymentSummary

Objet

Résumé de l’état du déploiement pour tous les déploiements créés par la correction.

Nom	Type	Description
failedDeployments	integer	Nombre de déploiements requis par la correction ayant échoué.
successfulDeployments	integer	Nombre de déploiements requis par la correction qui a réussi.
totalDeployments	integer	Nombre de déploiements requis par la correction.

RemediationFilters

Objet

Filtres qui seront appliqués pour déterminer les ressources à corriger.

Nom	Type	Description
locations	string[]	Emplacements des ressources qui seront corrigés.
resourceIds	string[]	ID des ressources qui seront corrigées. Peut spécifier au maximum 100 ID. Ce filtre ne peut pas être utilisé lorsque ReEvaluateCompliance est défini sur ReEvaluateCompliance et ne peut pas être vide s’il est fourni.

ResourceDiscoveryMode

Énumération

La façon dont les ressources à corriger sont découvertes. La valeur par défaut est ExistingNonCompliant si elle n’est pas spécifiée.

Valeur	Description
ExistingNonCompliant	Corrigez les ressources qui sont déjà connues pour être non conformes.
ReEvaluateCompliance	Réévaluez l’état de conformité des ressources, puis corrigez les ressources trouvées comme non conformes. Le filtre resourceIds ne peut pas être utilisé dans ce mode.

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

TypedErrorInfo

Objet

Détails d’erreur spécifiques au scénario.

Nom	Type	Description
info		Détails de l’erreur spécifique au scénario.
type	string	Type de détails d’erreur inclus.

Partager via

Remediations - Get At Resource

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Get remediation at individual resource scope

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorDefinition

ErrorResponse

FailureThreshold

Remediation

RemediationDeploymentSummary

RemediationFilters

ResourceDiscoveryMode

systemData

TypedErrorInfo