Remediations - List For Management Group

Pobiera wszystkie korygowania dla grupy zarządzania.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations?api-version=2021-10-01
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations?$top={$top}&$filter={$filter}&api-version=2021-10-01

Parametry identyfikatora URI

Name In Required Type Description
managementGroupId
path True
  • string

Identyfikator grupy zarządzania.

managementGroupsNamespace
path True

Przestrzeń nazw dla dostawcy zasobów zarządzania firmy Microsoft; dozwolone jest tylko "Microsoft.Management".

api-version
query True
  • string

Wersja interfejsu API klienta.

$filter
query
  • string

Wyrażenie filtru OData.

$top
query
  • integer
int32

Maksymalna liczba rekordów do zwrócenia.

Odpowiedzi

Name Type Description
200 OK

Pobrane korygowania.

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

List remediations at management group scope
List remediations at management group scope with query parameters

List remediations at management group scope

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/financeMg/providers/Microsoft.PolicyInsights/remediations?api-version=2021-10-01

Sample Response

{
  "value": [
    {
      "properties": {
        "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/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": 2,
          "successfulDeployments": 2,
          "failedDeployments": 0
        },
        "statusMessage": "Remediation extended status",
        "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6",
        "resourceCount": 42,
        "parallelDeployments": 6,
        "failureThreshold": {
          "percentage": 0.1
        }
      },
      "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "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"
      }
    },
    {
      "properties": {
        "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
        "provisioningState": "Succeeded",
        "createdOn": "2018-09-13T21:49:16.4638131Z",
        "lastUpdatedOn": "2018-09-13T21:50:18.4647478Z",
        "resourceDiscoveryMode": "ExistingNonCompliant",
        "deploymentStatus": {
          "totalDeployments": 2,
          "successfulDeployments": 2,
          "failedDeployments": 0
        },
        "statusMessage": "Remediation extended status",
        "correlationId": "957378d3-a143-421e-8b0e-3048dff01932"
      },
      "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/0866f0cc-6cb3-422c-9fb6-a4e3e2266da8",
      "name": "0866f0cc-6cb3-422c-9fb6-a4e3e2266da8",
      "type": "Microsoft.PolicyInsights/remediations",
      "systemData": {
        "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
        "createdByType": "User",
        "createdAt": "2018-09-13T21:49:16.4638131Z",
        "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2018-09-13T21:50:18.4647478Z"
      }
    }
  ]
}

List remediations at management group scope with query parameters

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/financeMg/providers/Microsoft.PolicyInsights/remediations?$top=1&$filter=PolicyAssignmentId eq '/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5'&api-version=2021-10-01

Sample Response

{
  "value": [
    {
      "properties": {
        "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/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": 2,
          "successfulDeployments": 2,
          "failedDeployments": 0
        },
        "statusMessage": "Remediation extended status",
        "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6",
        "resourceCount": 42,
        "parallelDeployments": 6,
        "failureThreshold": {
          "percentage": 0.1
        }
      },
      "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "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

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

ManagementGroupsNamespaceType

Przestrzeń nazw dla dostawcy zasobów zarządzania firmy Microsoft; dozwolone jest tylko "Microsoft.Management".

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.

RemediationListResult

Lista korygowań.

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

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorDefinition

Definicja błędu.

Name Type Description
additionalInfo

Dodatkowe szczegóły błędu specyficzne dla scenariusza.

code
  • string

Kod błędu specyficzny dla usługi, który służy jako stan podrzędny kodu błędu HTTP.

details

Szczegóły błędu wewnętrznego.

message
  • string

Opis błędu.

target
  • string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd.

Name Type Description
error

Szczegóły błędu.

FailureThreshold

Ustawienia progu niepowodzenia korygowania

Name Type Description
percentage
  • number

Liczba z zakresu od 0,0 do 1,0 reprezentująca próg awarii procentowej. Korygowanie zakończy się niepowodzeniem, jeśli wartość procentowa nieudanych operacji korygowania (tj. nieudane wdrożenia) przekroczy ten próg.

ManagementGroupsNamespaceType

Przestrzeń nazw dla dostawcy zasobów zarządzania firmy Microsoft; dozwolone jest tylko "Microsoft.Management".

Name Type Description
Microsoft.Management
  • string

Remediation

Definicja korygowania.

Name Type Description
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

Godzina utworzenia korygowania.

properties.deploymentStatus

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

properties.failureThreshold

Ustawienia progu niepowodzenia korygowania

properties.filters

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

properties.lastUpdatedOn
  • string

Czas ostatniej aktualizacji korygowania.

properties.parallelDeployments
  • integer

Określa liczbę zasobów do skorygowania w danym momencie. Może służyć do zwiększania lub zmniejszania 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 należy skorygować.

properties.policyDefinitionReferenceId
  • string

Identyfikator odwołania definicji zasad dla pojedynczej definicji, która powinna zostać skorygowana. Wymagane, gdy korygowane przypisanie zasad przypisuje definicję zestawu zasad.

properties.provisioningState
  • string

Stan korygowania.

properties.resourceCount
  • integer

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

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

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

type
  • string

Typ korygowania.

RemediationDeploymentSummary

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

Name Type Description
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

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

Name Type Description
locations
  • string[]

Lokalizacje zasobów, które zostaną skorygowane.

RemediationListResult

Lista korygowań.

Name Type Description
nextLink
  • string

Adres URL umożliwiający uzyskanie następnego zestawu wyników.

value

Tablica definicji korygowania.

ResourceDiscoveryMode

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

Name Type Description
ExistingNonCompliant
  • string

Koryguj zasoby, które są już znane jako niezgodne.

ReEvaluateCompliance
  • string

Ponownie oceń stan zgodności zasobów, a następnie koryguj zasoby uznane za niezgodne.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Name Type Description
createdAt
  • string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy
  • string

Tożsamość, która utworzyła zasób.

createdByType

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

lastModifiedAt
  • string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy
  • string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

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

TypedErrorInfo

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

Name Type Description
info

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

type
  • string

Typ dołączonych szczegółów błędu.