Remediations - Get At Resource

Usługa:: Policy

Wersja interfejsu API:: 2024-10-01

Pobiera istniejące korygowanie w zakresie zasobów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
remediationName	path	True	string	Nazwa korygowania.
resourceId	path	True	string	Identyfikator zasobu.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Remediation	Pobrane korygowanie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get remediation at individual resource scope

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorDefinition	Definicja błędu.
ErrorResponse	Odpowiedź na błąd.
FailureThreshold	Ustawienia progu niepowodzenia korygowania
Remediation	Definicja korygowania.
RemediationDeploymentSummary	Podsumowanie stanu wdrożenia dla wszystkich wdrożeń utworzonych przez korygowanie.
RemediationFilters	Filtry, które zostaną zastosowane w celu określenia, które zasoby mają zostać skorygowane.
ResourceDiscoveryMode	Sposób odnajdowania zasobów do skorygowania. Wartość domyślna to ExistingNonCompliant, jeśli nie zostanie określona.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TypedErrorInfo	Szczegóły błędu specyficzne dla scenariusza.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorDefinition

Objekt

Definicja błędu.

Nazwa	Typ	Opis
additionalInfo	TypedErrorInfo[]	Dodatkowe szczegóły błędu specyficzne dla scenariusza.
code	string	Kod błędu specyficzny dla usługi, który służy jako podstatu kodu błędu HTTP.
details	ErrorDefinition[]	Szczegóły błędu wewnętrznego.
message	string	Opis błędu.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	ErrorDefinition	Szczegóły błędu.

FailureThreshold

Objekt

Ustawienia progu niepowodzenia korygowania

Nazwa	Typ	Opis
percentage	number (float)	Liczba z zakresu od 0,0 do 1,0 reprezentująca próg niepowodzenia procentowego. Korygowanie zakończy się niepowodzeniem, jeśli wartość procentowa nieudanych operacji korygowania (tj. nieudanych wdrożeń) przekroczy ten próg.

Remediation

Objekt

Definicja korygowania.

Nazwa	Typ	Opis
id	string	Identyfikator korygowania.
name	string	Nazwa korygowania.
properties.correlationId	string	Identyfikator korelacji korygowania. Może służyć do znajdowania zdarzeń związanych z korygowaniem w dzienniku aktywności.
properties.createdOn	string (date-time)	Godzina utworzenia korygowania.
properties.deploymentStatus	RemediationDeploymentSummary	Podsumowanie stanu wdrożenia dla wszystkich wdrożeń utworzonych przez korygowanie.
properties.failureThreshold	FailureThreshold	Ustawienia progu niepowodzenia korygowania
properties.filters	RemediationFilters	Filtry, które zostaną zastosowane w celu określenia, które zasoby mają zostać skorygowane.
properties.lastUpdatedOn	string (date-time)	Czas ostatniej aktualizacji korygowania.
properties.parallelDeployments	integer (int32)	Określa liczbę zasobów do skorygowania w danym momencie. Może służyć do zwiększenia lub zmniejszenia tempa korygowania. Jeśli nie zostanie podana, zostanie użyta domyślna wartość wdrożeń równoległych.
properties.policyAssignmentId	string	Identyfikator zasobu przypisania zasad, który powinien zostać skorygowany.
properties.policyDefinitionReferenceId	string	Identyfikator odwołania definicji zasad dla pojedynczej definicji, która powinna zostać skorygowana. Wymagane, gdy przypisanie zasad jest korygowane, przypisuje definicję zestawu zasad.
properties.provisioningState	string	Stan korygowania. Dotyczy to całego zadania korygowania, a nie poszczególnych wdrożeń. Dozwolone wartości to Ocena, Anulowanie, Anulowanie, Niepowodzenie, Zakończenie lub Powodzenie.
properties.resourceCount	integer (int32)	Określa maksymalną liczbę zasobów, które można skorygować za pomocą zadania korygowania. Jeśli nie zostanie podana, zostanie użyta domyślna liczba zasobów.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	Sposób odnajdowania zasobów do skorygowania. Wartość domyślna to ExistingNonCompliant, jeśli nie zostanie określona.
properties.statusMessage	string	Komunikat o stanie korygowania. Zawiera dodatkowe szczegóły dotyczące stanu korygowania.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ korygowania.

RemediationDeploymentSummary

Objekt

Podsumowanie stanu wdrożenia dla wszystkich wdrożeń utworzonych przez korygowanie.

Nazwa	Typ	Opis
failedDeployments	integer	Liczba wdrożeń wymaganych przez korygowanie, które zakończyły się niepowodzeniem.
successfulDeployments	integer	Liczba wdrożeń wymaganych przez korygowanie, które zakończyły się pomyślnie.
totalDeployments	integer	Liczba wdrożeń wymaganych przez korygowanie.

RemediationFilters

Objekt

Filtry, które zostaną zastosowane w celu określenia, które zasoby mają zostać skorygowane.

Nazwa	Typ	Opis
locations	string[]	Lokalizacje zasobów, które zostaną skorygowane.
resourceIds	string[]	Identyfikatory zasobów, które zostaną skorygowane. Może określać co najwyżej 100 identyfikatorów. Nie można użyć tego filtru, gdy właściwość ReEvaluateCompliance jest ustawiona na Wartość ReEvaluateCompliance i nie może być pusta, jeśli zostanie podana wartość .

ResourceDiscoveryMode

Wyliczenie

Sposób odnajdowania zasobów do skorygowania. Wartość domyślna to ExistingNonCompliant, jeśli nie zostanie określona.

Wartość	Opis
ExistingNonCompliant	Koryguj zasoby, które są już znane jako niezgodne.
ReEvaluateCompliance	Ponownie oceń stan zgodności zasobów, a następnie koryguj zasoby, które nie są zgodne. Filtr resourceIds nie może być używany w tym trybie.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

TypedErrorInfo

Objekt

Szczegóły błędu specyficzne dla scenariusza.

Nazwa	Typ	Opis
info		Szczegóły błędu specyficzne dla scenariusza.
type	string	Typ dołączonych szczegółów błędu.

Udostępnij za pośrednictwem

Remediations - Get At Resource

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Get remediation at individual resource scope

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

createdByType

ErrorDefinition

ErrorResponse

FailureThreshold

Remediation

RemediationDeploymentSummary

RemediationFilters

ResourceDiscoveryMode

systemData

TypedErrorInfo