Remediations - Get At Resource

Servizio:: Policy

Versione API:: 2024-10-01

Ottiene una correzione esistente nell'ambito della risorsa.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
remediationName	path	True	string	Nome della correzione.
resourceId	path	True	string	ID risorsa.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	Remediation	Correzione recuperata.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get remediation at individual resource scope

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorDefinition	Definizione di errore.
ErrorResponse	Risposta di errore.
FailureThreshold	Impostazioni di soglia degli errori di correzione
Remediation	Definizione di correzione.
RemediationDeploymentSummary	Riepilogo dello stato della distribuzione per tutte le distribuzioni create dalla correzione.
RemediationFilters	Filtri che verranno applicati per determinare le risorse da correggere.
ResourceDiscoveryMode	Viene individuato il modo in cui vengono individuate le risorse da correggere. Il valore predefinito è ExistingNonCompliant se non specificato.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
TypedErrorInfo	Dettagli degli errori specifici dello scenario.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorDefinition

Oggetto

Definizione di errore.

Nome	Tipo	Descrizione
additionalInfo	TypedErrorInfo[]	Dettagli aggiuntivi sugli errori specifici dello scenario.
code	string	Codice di errore specifico del servizio che funge da stato secondario per il codice di errore HTTP.
details	ErrorDefinition[]	Dettagli dell'errore interno.
message	string	Descrizione dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
error	ErrorDefinition	Dettagli dell'errore.

FailureThreshold

Oggetto

Impostazioni di soglia degli errori di correzione

Nome	Tipo	Descrizione
percentage	number (float)	Numero compreso tra 0,0 e 1,0 che rappresenta la soglia di errore percentuale. La correzione avrà esito negativo se la percentuale di operazioni di correzione non riuscite (ad esempio distribuzioni non riuscite) supera questa soglia.

Remediation

Oggetto

Definizione di correzione.

Nome	Tipo	Descrizione
id	string	ID della correzione.
name	string	Nome della correzione.
properties.correlationId	string	ID correlazione di correzione. Può essere usato per trovare eventi correlati alla correzione nel log attività.
properties.createdOn	string (date-time)	Ora in cui è stata creata la correzione.
properties.deploymentStatus	RemediationDeploymentSummary	Riepilogo dello stato della distribuzione per tutte le distribuzioni create dalla correzione.
properties.failureThreshold	FailureThreshold	Impostazioni di soglia degli errori di correzione
properties.filters	RemediationFilters	Filtri che verranno applicati per determinare le risorse da correggere.
properties.lastUpdatedOn	string (date-time)	Ora dell'ultimo aggiornamento della correzione.
properties.parallelDeployments	integer (int32)	Determina il numero di risorse da correggere in un determinato momento. Può essere usato per aumentare o ridurre il ritmo della correzione. Se non specificato, viene usato il valore predefinito delle distribuzioni parallele.
properties.policyAssignmentId	string	ID risorsa dell'assegnazione di criteri da correggere.
properties.policyDefinitionReferenceId	string	ID di riferimento della definizione dei criteri della singola definizione da correggere. Obbligatorio quando l'assegnazione dei criteri da correggere assegna una definizione del set di criteri.
properties.provisioningState	string	Stato della correzione. Questo si riferisce all'intera attività di correzione, non alle singole distribuzioni. I valori consentiti sono Valutazione, Annullamento, Annullamento, Operazione non riuscita, Completamento o Operazione riuscita.
properties.resourceCount	integer (int32)	Determina il numero massimo di risorse che è possibile correggere dal processo di correzione. Se non specificato, viene usato il numero di risorse predefinito.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	Viene individuato il modo in cui vengono individuate le risorse da correggere. Il valore predefinito è ExistingNonCompliant se non specificato.
properties.statusMessage	string	Messaggio di stato di correzione. Fornisce dettagli aggiuntivi sullo stato della correzione.
systemData	systemData	Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
type	string	Tipo della correzione.

RemediationDeploymentSummary

Oggetto

Riepilogo dello stato della distribuzione per tutte le distribuzioni create dalla correzione.

Nome	Tipo	Descrizione
failedDeployments	integer	Numero di distribuzioni richieste dalla correzione non riuscita.
successfulDeployments	integer	Numero di distribuzioni richieste dalla correzione completata.
totalDeployments	integer	Numero di distribuzioni richieste dalla correzione.

RemediationFilters

Oggetto

Filtri che verranno applicati per determinare le risorse da correggere.

Nome	Tipo	Descrizione
locations	string[]	Percorsi delle risorse che verranno corretti.
resourceIds	string[]	ID delle risorse che verranno risolte. Può specificare al massimo 100 ID. Questo filtro non può essere usato quando ReEvaluateCompliance è impostato su ReEvaluateCompliance e non può essere vuoto se specificato.

ResourceDiscoveryMode

Enumerazione

Viene individuato il modo in cui vengono individuate le risorse da correggere. Il valore predefinito è ExistingNonCompliant se non specificato.

Valore	Descrizione
ExistingNonCompliant	Correggere le risorse già note come non conformi.
ReEvaluateCompliance	Rivalutare lo stato di conformità delle risorse e quindi correggere le risorse rilevate come non conformi. Il filtro resourceIds non può essere utilizzato in questa modalità.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

TypedErrorInfo

Oggetto

Dettagli degli errori specifici dello scenario.

Nome	Tipo	Descrizione
info		Dettagli dell'errore specifici dello scenario.
type	string	Tipo di dettagli dell'errore inclusi.

Condividi tramite

Remediations - Get At Resource

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Get remediation at individual resource scope

Esempio di richiesta

Risposta di esempio

Definizioni

createdByType

ErrorDefinition

ErrorResponse

FailureThreshold

Remediation

RemediationDeploymentSummary

RemediationFilters

ResourceDiscoveryMode

systemData

TypedErrorInfo