Remediations - Get At Subscription
Obtém uma remediação existente no âmbito da subscrição.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}?api-version=2021-10-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
remediation
|
path | True |
string |
O nome da remediação. |
subscription
|
path | True |
string |
ID da subscrição do Microsoft Azure. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
A remediação obtida. |
|
Other Status Codes |
Resposta de erro que descreve a razão pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
Get remediation at subscription scope
Sample Request
GET https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/Microsoft.PolicyInsights/remediations/storageRemediation?api-version=2021-10-01
Sample Response
{
"properties": {
"policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/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": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/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 |
---|---|
created |
O tipo de identidade que criou o recurso. |
Error |
Definição de erro. |
Error |
Resposta de erro. |
Failure |
As definições do limiar de falha de remediação |
Remediation |
A definição de remediação. |
Remediation |
O resumo do estado de implementação de todas as implementações criadas pela remediação. |
Remediation |
Os filtros que serão aplicados para determinar que recursos remediar. |
Resource |
A forma como os recursos a remediar são detetados. A predefinição é ExistingNonCompliant se não for especificada. |
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.
Name | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDefinition
Definição de erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
Detalhes de erros específicos de cenários adicionais. |
|
code |
string |
Código de erro específico do serviço que serve como o subtatus para o código de erro HTTP. |
details |
Detalhes de erro internos. |
|
message |
string |
Descrição do erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro.
Name | Tipo | Description |
---|---|---|
error |
Os detalhes do erro. |
FailureThreshold
As definições do limiar de falha de remediação
Name | Tipo | Description |
---|---|---|
percentage |
number |
Um número entre 0,0 e 1,0 que representa o limiar de falha percentual. A remediação falhará se a percentagem de operações de remediação falhadas (ou seja, implementações falhadas) exceder este limiar. |
Remediation
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 |
O ID de correlação de remediação. Pode ser utilizado para encontrar eventos relacionados com a remediação no registo de atividades. |
properties.createdOn |
string |
O momento em que a remediação foi criada. |
properties.deploymentStatus |
O resumo do estado de implementação de todas as implementações criadas pela remediação. |
|
properties.failureThreshold |
As definições do limiar de falha de remediação |
|
properties.filters |
Os filtros que serão aplicados para determinar que recursos remediar. |
|
properties.lastUpdatedOn |
string |
O momento em que a remediação foi atualizada pela última vez. |
properties.parallelDeployments |
integer |
Determina o número de recursos a remediar a qualquer momento. Pode ser utilizado para aumentar ou reduzir o ritmo da remediação. Se não for fornecido, é utilizado o valor de implementações paralelas predefinido. |
properties.policyAssignmentId |
string |
O ID do recurso da atribuição de política que deve ser remediado. |
properties.policyDefinitionReferenceId |
string |
O ID de referência da definição de política da definição individual que deve ser remediado. Necessário quando a atribuição de política a ser remediada atribui uma definição de conjunto de políticas. |
properties.provisioningState |
string |
O estado da remediação. Isto refere-se a toda a tarefa de remediação e não a implementações individuais. Os valores permitidos são Avaliar, Cancelar, Cancelar, Falhar, Concluir ou Com Êxito. |
properties.resourceCount |
integer |
Determina o número máximo de recursos que podem ser remediados pela tarefa de remediação. Se não for fornecido, é utilizada a contagem de recursos predefinida. |
properties.resourceDiscoveryMode |
A forma como os recursos a remediar são detetados. A predefinição é ExistingNonCompliant se não for especificada. |
|
properties.statusMessage |
string |
A mensagem de estado de remediação. Fornece detalhes adicionais sobre o estado da remediação. |
systemData |
O Azure Resource Manager metadados que contêm informações createdBy e modifiedBy. |
|
type |
string |
O tipo de remediação. |
RemediationDeploymentSummary
O resumo do estado de implementação de todas as implementações criadas pela remediação.
Name | Tipo | Description |
---|---|---|
failedDeployments |
integer |
O número de implementações necessárias pela remediação que falharam. |
successfulDeployments |
integer |
O número de implementações necessárias pela remediação que foram bem-sucedidas. |
totalDeployments |
integer |
O número de implementações necessárias para a remediação. |
RemediationFilters
Os filtros que serão aplicados para determinar que recursos remediar.
Name | Tipo | Description |
---|---|---|
locations |
string[] |
As localizações dos recursos que serão remediadas. |
ResourceDiscoveryMode
A forma como os recursos a remediar são detetados. A predefinição é ExistingNonCompliant se não for especificada.
Name | Tipo | Description |
---|---|---|
ExistingNonCompliant |
string |
Remediar recursos que já são conhecidos por não estarem em conformidade. |
ReEvaluateCompliance |
string |
Revalie o estado de conformidade dos recursos e, em seguida, remediar os recursos considerados não conformes. |
systemData
Metadados relativos à criação e última modificação do recurso.
Name | 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.
Name | Tipo | Description |
---|---|---|
info |
Os detalhes de erro específicos do cenário. |
|
type |
string |
O tipo de detalhes de erro incluídos. |