Remediations - Get At Resource

Služba:

Policy

Verze rozhraní API:

2024-10-01

Získá existující nápravu v oboru prostředku.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
remediationName	path	True	string	Název nápravy.
resourceId	path	True	string	ID prostředku.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	Remediation	Načtená náprava.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get remediation at individual resource scope

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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"
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorDefinition	Definice chyby
ErrorResponse	Chybová odpověď.
FailureThreshold	Nastavení prahové hodnoty chyby nápravy
Remediation	Definice nápravy.
RemediationDeploymentSummary	Souhrn stavu nasazení pro všechna nasazení vytvořená nápravou
RemediationFilters	Filtry, které se použijí k určení prostředků, které se mají napravit.
ResourceDiscoveryMode	Způsob, jakým se zjistí prostředky k nápravě. Pokud není zadaný, nastaví se výchozí hodnota ExistingNonCompliant.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
TypedErrorInfo	Podrobnosti o konkrétní chybě scénáře

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorDefinition

Objekt

Definice chyby

Name	Typ	Description
additionalInfo	TypedErrorInfo[]	Další podrobnosti o chybě specifické pro konkrétní scénář
code	string	Kód chyby specifický pro službu, který slouží jako dílčí stav kódu chyby HTTP.
details	ErrorDefinition[]	Podrobnosti o vnitřní chybě.
message	string	Popis chyby
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	ErrorDefinition	Podrobnosti o chybě.

FailureThreshold

Objekt

Nastavení prahové hodnoty chyby nápravy

Name	Typ	Description
percentage	number (float)	Číslo od 0,0 do 1,0 představující prahovou hodnotu procentuálního selhání. Náprava selže, pokud procento neúspěšných operací nápravy (tj. neúspěšných nasazení) překročí tuto prahovou hodnotu.

Remediation

Objekt

Definice nápravy.

Name	Typ	Description
id	string	ID nápravy.
name	string	Název nápravy.
properties.correlationId	string	ID korelace nápravy. Lze použít k vyhledání událostí souvisejících s nápravou v protokolu aktivit.
properties.createdOn	string (date-time)	Čas vytvoření nápravy
properties.deploymentStatus	RemediationDeploymentSummary	Souhrn stavu nasazení pro všechna nasazení vytvořená nápravou
properties.failureThreshold	FailureThreshold	Nastavení prahové hodnoty chyby nápravy
properties.filters	RemediationFilters	Filtry, které se použijí k určení prostředků, které se mají napravit.
properties.lastUpdatedOn	string (date-time)	Čas poslední aktualizace nápravy.
properties.parallelDeployments	integer (int32)	Určuje, kolik prostředků se má v daném okamžiku napravit. Lze použít ke zvýšení nebo snížení tempa nápravy. Pokud není k dispozici, použije se výchozí hodnota paralelních nasazení.
properties.policyAssignmentId	string	ID prostředku přiřazení zásady, které by se mělo napravit.
properties.policyDefinitionReferenceId	string	ID odkazu na definici zásady pro jednotlivé definice, která by se měla napravit. Vyžaduje se, když přiřazení zásady, které se opravuje, přiřadí definici sady zásad.
properties.provisioningState	string	Stav nápravy. To se týká celé úlohy nápravy, nikoli jednotlivých nasazení. Povolené hodnoty jsou vyhodnocení, zrušení, zrušení, selhání, dokončení nebo úspěch.
properties.resourceCount	integer (int32)	Určuje maximální počet prostředků, které lze napravit úlohou nápravy. Pokud není zadaný, použije se výchozí počet prostředků.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	Způsob, jakým se zjistí prostředky k nápravě. Pokud není zadaný, nastaví se výchozí hodnota ExistingNonCompliant.
properties.statusMessage	string	Stavová zpráva nápravy. Poskytuje další podrobnosti týkající se stavu nápravy.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ nápravy.

RemediationDeploymentSummary

Objekt

Souhrn stavu nasazení pro všechna nasazení vytvořená nápravou

Name	Typ	Description
failedDeployments	integer	Počet nasazení vyžadovaných nápravou, která selhala.
successfulDeployments	integer	Počet nasazení vyžadovaných nápravou, která byla úspěšná.
totalDeployments	integer	Počet nasazení vyžadovaných nápravou

RemediationFilters

Objekt

Filtry, které se použijí k určení prostředků, které se mají napravit.

Name	Typ	Description
locations	string[]	Umístění prostředků, která budou remediatována.
resourceIds	string[]	ID prostředků, které budou remediatovány. Může zadat maximálně 100 ID. Tento filtr nelze použít, pokud je funkce ReEvaluateCompliance nastavená na hodnotu ReEvaluateCompliance a v případě zadání nemůže být prázdná.

ResourceDiscoveryMode

Výčet

Způsob, jakým se zjistí prostředky k nápravě. Pokud není zadaný, nastaví se výchozí hodnota ExistingNonCompliant.

Hodnota	Description
ExistingNonCompliant	Opravte prostředky, o kterých už víte, že nedodržují předpisy.
ReEvaluateCompliance	Znovu vyhodnoťte stav dodržování předpisů u prostředků a pak opravte prostředky, u kterých se zjistilo, že nedodržují předpisy. Filtr resourceIds nelze v tomto režimu použít.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

TypedErrorInfo

Objekt

Podrobnosti o konkrétní chybě scénáře

Name	Typ	Description
info		Podrobnosti o konkrétní chybě scénáře.
type	string	Typ zahrnutých podrobností o chybě.