Remediations - List For Management Group
Obtém todas as correções para o grupo de gerenciamento.
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
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
management
|
path | True |
string |
ID do grupo de gerenciamento. |
management
|
path | True |
O namespace para o RP de Gerenciamento da Microsoft; somente "Microsoft.Management" é permitido. |
|
api-version
|
query | True |
string |
Versão da API do cliente. |
$filter
|
query |
string |
Expressão de filtro OData. |
|
$top
|
query |
integer int32 |
Número máximo de registros a serem retornados. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
As correções recuperadas. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
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"
}
}
]
}
Definições
Nome | Description |
---|---|
created |
O tipo de identidade que criou o recurso. |
Error |
Definição de erro. |
Error |
Resposta de erro. |
Failure |
As configurações de limite de falha de correção |
Management |
O namespace para o RP de Gerenciamento da Microsoft; somente "Microsoft.Management" é permitido. |
Remediation |
A definição de correção. |
Remediation |
A implantação status resumo de todas as implantações criadas pela correção. |
Remediation |
Os filtros que serão aplicados para determinar quais recursos corrigir. |
Remediation |
Lista de correções. |
Resource |
A maneira como os recursos a serem corrigidos são descobertos. O padrão será ExistingNonCompliant se não for especificado. |
system |
Metadados relativos à criação e à última modificação do recurso. |
Typed |
Detalhes de erro específicos do cenário. |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDefinition
Definição de erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
Detalhes de erro específicos do cenário adicional. |
|
code |
string |
Código de erro específico do serviço que serve como substatus para o código de erro HTTP. |
details |
Detalhes do erro interno. |
|
message |
string |
Descrição do erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
Os detalhes do erro. |
FailureThreshold
As configurações de limite de falha de correção
Nome | Tipo | Description |
---|---|---|
percentage |
number |
Um número entre 0,0 e 1,0 que representa o limite de falha percentual. A correção falhará se o percentual de operações de correção com falha (ou seja, implantações com falha) exceder esse limite. |
ManagementGroupsNamespaceType
O namespace para o RP de Gerenciamento da Microsoft; somente "Microsoft.Management" é permitido.
Nome | Tipo | Description |
---|---|---|
Microsoft.Management |
string |
Remediation
A definição de correção.
Nome | Tipo | Description |
---|---|---|
id |
string |
A ID da correção. |
name |
string |
O nome da correção. |
properties.correlationId |
string |
A ID de correlação de correção. Pode ser usado para localizar eventos relacionados à correção no log de atividades. |
properties.createdOn |
string |
O momento em que a correção foi criada. |
properties.deploymentStatus |
A implantação status resumo de todas as implantações criadas pela correção. |
|
properties.failureThreshold |
As configurações de limite de falha de correção |
|
properties.filters |
Os filtros que serão aplicados para determinar quais recursos corrigir. |
|
properties.lastUpdatedOn |
string |
A hora em que a correção foi atualizada pela última vez. |
properties.parallelDeployments |
integer |
Determina quantos recursos serão corrigidos a qualquer momento. Pode ser usado para aumentar ou reduzir o ritmo da correção. Se não for fornecido, o valor de implantações paralelas padrão será usado. |
properties.policyAssignmentId |
string |
A ID do recurso da atribuição de política que deve ser corrigida. |
properties.policyDefinitionReferenceId |
string |
A ID de referência de definição de política da definição individual que deve ser corrigida. Necessário quando a atribuição de política que está sendo corrigida atribui uma definição de conjunto de políticas. |
properties.provisioningState |
string |
O status da correção. Isso se refere a toda a tarefa de correção, não a implantações individuais. Os valores permitidos são Avaliação, Cancelamento, Cancelamento, Falha, Conclusão ou Êxito. |
properties.resourceCount |
integer |
Determina o número máximo de recursos que podem ser corrigidos pelo trabalho de correção. Se não for fornecido, a contagem de recursos padrão será usada. |
properties.resourceDiscoveryMode |
A maneira como os recursos a serem corrigidos são descobertos. O padrão será ExistingNonCompliant se não for especificado. |
|
properties.statusMessage |
string |
A mensagem de correção status. Fornece detalhes adicionais sobre o estado da correção. |
systemData |
Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy. |
|
type |
string |
O tipo da correção. |
RemediationDeploymentSummary
A implantação status resumo de todas as implantações criadas pela correção.
Nome | Tipo | Description |
---|---|---|
failedDeployments |
integer |
O número de implantações exigidas pela correção que falhou. |
successfulDeployments |
integer |
O número de implantações exigidas pela correção que foi bem-sucedida. |
totalDeployments |
integer |
O número de implantações exigidas pela correção. |
RemediationFilters
Os filtros que serão aplicados para determinar quais recursos corrigir.
Nome | Tipo | Description |
---|---|---|
locations |
string[] |
Os locais de recurso que serão corrigidos. |
RemediationListResult
Lista de correções.
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
A URL para obter o próximo conjunto de resultados. |
value |
Matriz de definições de correção. |
ResourceDiscoveryMode
A maneira como os recursos a serem corrigidos são descobertos. O padrão será ExistingNonCompliant se não for especificado.
Nome | Tipo | Description |
---|---|---|
ExistingNonCompliant |
string |
Corrija os recursos que já são conhecidos por não estarem em conformidade. |
ReEvaluateCompliance |
string |
Avalie novamente o estado de conformidade dos recursos e corrija os recursos considerados incompatíveis. |
systemData
Metadados relativos à criação e à última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |
TypedErrorInfo
Detalhes de erro específicos do cenário.
Nome | Tipo | Description |
---|---|---|
info |
Detalhes de erro específicos do cenário. |
|
type |
string |
O tipo de detalhes de erro incluídos. |