Remediations - List For Management Group
Lekéri a felügyeleti csoport összes szervizelését.
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
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
management
|
path | True |
string |
Felügyeleti csoport azonosítója. |
management
|
path | True |
A Microsoft Management RP névtere; Csak a "Microsoft.Management" engedélyezett. |
|
api-version
|
query | True |
string |
Client API-verzió. |
$filter
|
query |
string |
OData szűrőkifejezés. |
|
$top
|
query |
integer int32 |
A visszaadandó rekordok maximális száma. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A lekért szervizelések. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
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 | felhasználói fiók megszemélyesítése |
Példák
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"
}
}
]
}
Definíciók
Name | Description |
---|---|
created |
Az erőforrást létrehozó identitás típusa. |
Error |
Hibadefiníció. |
Error |
Hibaválasz. |
Failure |
A szervizelési hiba küszöbértékének beállításai |
Management |
A Microsoft Management RP névtere; Csak a "Microsoft.Management" engedélyezett. |
Remediation |
A szervizelési definíció. |
Remediation |
A szervizelés által létrehozott összes üzemelő példány üzembehelyezési állapotának összegzése. |
Remediation |
A szervizelendő erőforrások meghatározásához alkalmazott szűrők. |
Remediation |
A szervizelések listája. |
Resource |
A szervizelendő erőforrások felderítése. Ha nincs megadva, alapértelmezés szerint ExistingNonCompliant lesz. |
system |
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
Typed |
Esetspecifikus hiba részletei. |
createdByType
Az erőforrást létrehozó identitás típusa.
Name | Típus | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDefinition
Hibadefiníció.
Name | Típus | Description |
---|---|---|
additionalInfo |
További esetspecifikus hibaadatok. |
|
code |
string |
Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál. |
details |
Belső hiba részletei. |
|
message |
string |
A hiba leírása. |
target |
string |
A hiba célja. |
ErrorResponse
Hibaválasz.
Name | Típus | Description |
---|---|---|
error |
A hiba részletei. |
FailureThreshold
A szervizelési hiba küszöbértékének beállításai
Name | Típus | Description |
---|---|---|
percentage |
number |
A hiba küszöbértékét jelölő 0,0 és 1,0 közötti szám. A szervizelés sikertelen lesz, ha a sikertelen szervizelési műveletek (például a sikertelen üzembe helyezések) százalékos aránya meghaladja ezt a küszöbértéket. |
ManagementGroupsNamespaceType
A Microsoft Management RP névtere; Csak a "Microsoft.Management" engedélyezett.
Name | Típus | Description |
---|---|---|
Microsoft.Management |
string |
Remediation
A szervizelési definíció.
Name | Típus | Description |
---|---|---|
id |
string |
A szervizelés azonosítója. |
name |
string |
A szervizelés neve. |
properties.correlationId |
string |
A szervizelési korrelációs azonosító. A szervizeléssel kapcsolatos események megkeresésére használható a tevékenységnaplóban. |
properties.createdOn |
string |
A szervizelés létrehozásának időpontja. |
properties.deploymentStatus |
A szervizelés által létrehozott összes üzemelő példány üzembehelyezési állapotának összegzése. |
|
properties.failureThreshold |
A szervizelési hiba küszöbértékének beállításai |
|
properties.filters |
A szervizelendő erőforrások meghatározásához alkalmazott szűrők. |
|
properties.lastUpdatedOn |
string |
A szervizelés utolsó frissítésének időpontja. |
properties.parallelDeployments |
integer |
Meghatározza, hogy egy adott időpontban hány erőforrást kell szervizelni. A szervizelés ütemének növelésére vagy csökkentésére használható. Ha nincs megadva, a rendszer az alapértelmezett párhuzamos üzembe helyezési értéket használja. |
properties.policyAssignmentId |
string |
A szervizelendő szabályzat-hozzárendelés erőforrás-azonosítója. |
properties.policyDefinitionReferenceId |
string |
A szervizelendő egyéni definíció szabályzatdefiníció-hivatkozási azonosítója. Kötelező, ha a szervizelés alatt álló szabályzat-hozzárendelés hozzárendel egy szabályzatkészlet-definíciót. |
properties.provisioningState |
string |
A szervizelés állapota. Ez a teljes szervizelési feladatra vonatkozik, nem az egyes üzemelő példányokra. Az engedélyezett értékek a Következők: Kiértékelés, Megszakítva, Megszakítva, Sikertelen, Befejezve vagy Sikeres. |
properties.resourceCount |
integer |
Meghatározza a szervizelési feladat által orvosolható erőforrások maximális számát. Ha nincs megadva, a rendszer az alapértelmezett erőforrásszámot használja. |
properties.resourceDiscoveryMode |
A szervizelendő erőforrások felderítése. Ha nincs megadva, alapértelmezés szerint ExistingNonCompliant lesz. |
|
properties.statusMessage |
string |
A szervizelési állapotüzenet. További részleteket tartalmaz a szervizelés állapotáról. |
systemData |
Az Azure Resource Manager createdBy és modifiedBy adatokat tartalmazó metaadatokat. |
|
type |
string |
A szervizelés típusa. |
RemediationDeploymentSummary
A szervizelés által létrehozott összes üzemelő példány üzembehelyezési állapotának összegzése.
Name | Típus | Description |
---|---|---|
failedDeployments |
integer |
A sikertelen szervizeléshez szükséges üzemelő példányok száma. |
successfulDeployments |
integer |
A sikeres szervizeléshez szükséges üzemelő példányok száma. |
totalDeployments |
integer |
A szervizeléshez szükséges üzemelő példányok száma. |
RemediationFilters
A szervizelendő erőforrások meghatározásához alkalmazott szűrők.
Name | Típus | Description |
---|---|---|
locations |
string[] |
A szervizelendő erőforráshelyek. |
RemediationListResult
A szervizelések listája.
Name | Típus | Description |
---|---|---|
nextLink |
string |
A következő találatkészlet lekéréséhez tartozó URL-cím. |
value |
A szervizelési definíciók tömbje. |
ResourceDiscoveryMode
A szervizelendő erőforrások felderítése. Ha nincs megadva, alapértelmezés szerint ExistingNonCompliant lesz.
Name | Típus | Description |
---|---|---|
ExistingNonCompliant |
string |
A már ismerten nem megfelelő erőforrások szervizelése. |
ReEvaluateCompliance |
string |
Értékelje újra az erőforrások megfelelőségi állapotát, majd javítsa ki a nem megfelelőnek talált erőforrásokat. |
systemData
Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Name | Típus | Description |
---|---|---|
createdAt |
string |
Az erőforrás-létrehozás időbélyege (UTC). |
createdBy |
string |
Az erőforrást létrehozó identitás. |
createdByType |
Az erőforrást létrehozó identitás típusa. |
|
lastModifiedAt |
string |
Az erőforrás utolsó módosításának időbélyege (UTC) |
lastModifiedBy |
string |
Az erőforrást utoljára módosító identitás. |
lastModifiedByType |
Az erőforrást legutóbb módosító identitás típusa. |
TypedErrorInfo
Esetspecifikus hiba részletei.
Name | Típus | Description |
---|---|---|
info |
A forgatókönyv konkrét hibaadatai. |
|
type |
string |
A belefoglalt hiba részleteinek típusa. |