Remediations - Get At Resource

Serviço:: Policy

Versão da API:: 2024-10-01

Obtém uma correção existente no escopo do recurso.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
remediationName	path	True	string	O nome da remediação.
resourceId	path	True	string	ID do recurso.
api-version	query	True	string	Versão da API do cliente.

Respostas

Name	Tipo	Description
200 OK	Remediation	A remediação recuperada.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get remediation at individual resource scope

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
  }
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorDefinition	Definição de erro.
ErrorResponse	Resposta de erro.
FailureThreshold	As configurações de limite de falha de correção
Remediation	A definição de remediação.
RemediationDeploymentSummary	O resumo do status da implantação para todas as implantações criadas pela correção.
RemediationFilters	Os filtros que serão aplicados para determinar quais recursos corrigir.
ResourceDiscoveryMode	A forma como os recursos para remediar são descobertos. O padrão é ExistingNonCompliant se não for especificado.
systemData	Metadados referentes à criação e última modificação do recurso.
TypedErrorInfo	Detalhes do erro específico do cenário.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorDefinition

Object

Definição de erro.

Name	Tipo	Description
additionalInfo	TypedErrorInfo[]	Detalhes adicionais do erro específico do cenário.
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	ErrorDefinition[]	Detalhes do erro interno.
message	string	Descrição do erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
error	ErrorDefinition	Os detalhes do erro.

FailureThreshold

Object

As configurações de limite de falha de correção

Name	Tipo	Description
percentage	number (float)	Um número entre 0,0 e 1,0 que representa o limiar percentual de falha. A correção falhará se a porcentagem de operações de correção com falha (ou seja, implantações com falha) exceder esse limite.

Remediation

Object

A definição de remediação.

Name	Tipo	Description
id	string	O ID da remediação.
name	string	O nome da remediação.
properties.correlationId	string	A correlação de remediação Id. Pode ser usado para encontrar eventos relacionados à correção no log de atividades.
properties.createdOn	string (date-time)	O momento em que a remediação foi criada.
properties.deploymentStatus	RemediationDeploymentSummary	O resumo do status da implantação para todas as implantações criadas pela correção.
properties.failureThreshold	FailureThreshold	As configurações de limite de falha de correção
properties.filters	RemediationFilters	Os filtros que serão aplicados para determinar quais recursos corrigir.
properties.lastUpdatedOn	string (date-time)	O momento em que a correção foi atualizada pela última vez.
properties.parallelDeployments	integer (int32)	Determina quantos recursos devem ser corrigidos em um determinado momento. Pode ser usado para aumentar ou reduzir o ritmo da remediação. Se não for fornecido, o valor padrão de implantações paralelas será usado.
properties.policyAssignmentId	string	A ID do recurso da atribuição de política que deve ser corrigida.
properties.policyDefinitionReferenceId	string	O ID de referência da 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 remediada atribui uma definição de conjunto de políticas.
properties.provisioningState	string	O status da remediação. Isso se refere a toda a tarefa de correção, não a implantações individuais. Os valores permitidos são Avaliando, Cancelado, Cancelando, Falhado, Concluído ou Bem-sucedido.
properties.resourceCount	integer (int32)	Determina o número máximo de recursos que podem ser remediados pelo trabalho de correção. Se não for fornecida, a contagem de recursos padrão será usada.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	A forma como os recursos para remediar são descobertos. O padrão é ExistingNonCompliant se não for especificado.
properties.statusMessage	string	A mensagem de status da correção. Fornece detalhes adicionais sobre o estado da remediação.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo de remediação.

RemediationDeploymentSummary

Object

O resumo do status da implantação para todas as implantações criadas pela correção.

Name	Tipo	Description
failedDeployments	integer	O número de implantações exigidas pela correção que falharam.
successfulDeployments	integer	O número de implantações exigidas pela correção que foram bem-sucedidas.
totalDeployments	integer	O número de implantações exigidas pela correção.

RemediationFilters

Object

Os filtros que serão aplicados para determinar quais recursos corrigir.

Name	Tipo	Description
locations	string[]	Os locais de recursos que serão corrigidos.
resourceIds	string[]	As IDs dos recursos que serão corrigidos. Pode especificar no máximo 100 IDs. Esse filtro não pode ser usado quando ReEvaluateCompliance está definido como ReEvaluateCompliance e não pode ser vazio se fornecido.

ResourceDiscoveryMode

Enumeração

A forma como os recursos para remediar são descobertos. O padrão é ExistingNonCompliant se não for especificado.

Valor	Description
ExistingNonCompliant	Corrija recursos que já são conhecidos por não estarem em conformidade.
ReEvaluateCompliance	Reavalie o estado de conformidade dos recursos e, em seguida, corrija os recursos considerados não conformes. O filtro resourceIds não pode ser usado neste modo.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TypedErrorInfo

Object

Detalhes do erro específico do cenário.

Name	Tipo	Description
info		Os detalhes do erro específico do cenário.
type	string	O tipo de detalhes de erro incluídos.

Partilhar via

Remediations - Get At Resource

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Get remediation at individual resource scope

Pedido de amostra

Resposta da amostra

Definições

createdByType

ErrorDefinition

ErrorResponse

FailureThreshold

Remediation

RemediationDeploymentSummary

RemediationFilters

ResourceDiscoveryMode

systemData

TypedErrorInfo