Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. policyinsights
  5. getRemediationAtResource
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.policyinsights.getRemediationAtResource

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets an existing remediation at resource scope. Azure REST API version: 2021-10-01.

Other available API versions: 2024-10-01.

Using getRemediationAtResource

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRemediationAtResource(args: GetRemediationAtResourceArgs, opts?: InvokeOptions): Promise<GetRemediationAtResourceResult>
function getRemediationAtResourceOutput(args: GetRemediationAtResourceOutputArgs, opts?: InvokeOptions): Output<GetRemediationAtResourceResult>
Copy
def get_remediation_at_resource(remediation_name: Optional[str] = None,
                                resource_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetRemediationAtResourceResult
def get_remediation_at_resource_output(remediation_name: Optional[pulumi.Input[str]] = None,
                                resource_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetRemediationAtResourceResult]
Copy
func LookupRemediationAtResource(ctx *Context, args *LookupRemediationAtResourceArgs, opts ...InvokeOption) (*LookupRemediationAtResourceResult, error)
func LookupRemediationAtResourceOutput(ctx *Context, args *LookupRemediationAtResourceOutputArgs, opts ...InvokeOption) LookupRemediationAtResourceResultOutput
Copy

> Note: This function is named LookupRemediationAtResource in the Go SDK.

public static class GetRemediationAtResource 
{
    public static Task<GetRemediationAtResourceResult> InvokeAsync(GetRemediationAtResourceArgs args, InvokeOptions? opts = null)
    public static Output<GetRemediationAtResourceResult> Invoke(GetRemediationAtResourceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRemediationAtResourceResult> getRemediationAtResource(GetRemediationAtResourceArgs args, InvokeOptions options)
public static Output<GetRemediationAtResourceResult> getRemediationAtResource(GetRemediationAtResourceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:policyinsights:getRemediationAtResource
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

RemediationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the remediation.
ResourceId
This property is required.
Changes to this property will trigger replacement.
string
Resource ID.
RemediationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the remediation.
ResourceId
This property is required.
Changes to this property will trigger replacement.
string
Resource ID.
remediationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the remediation.
resourceId
This property is required.
Changes to this property will trigger replacement.
String
Resource ID.
remediationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the remediation.
resourceId
This property is required.
Changes to this property will trigger replacement.
string
Resource ID.
remediation_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the remediation.
resource_id
This property is required.
Changes to this property will trigger replacement.
str
Resource ID.
remediationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the remediation.
resourceId
This property is required.
Changes to this property will trigger replacement.
String
Resource ID.

getRemediationAtResource Result

The following output properties are available:

CorrelationId string
The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
CreatedOn string
The time at which the remediation was created.
DeploymentStatus Pulumi.AzureNative.PolicyInsights.Outputs.RemediationDeploymentSummaryResponse
The deployment status summary for all deployments created by the remediation.
Id string
The ID of the remediation.
LastUpdatedOn string
The time at which the remediation was last updated.
Name string
The name of the remediation.
ProvisioningState string
The status of the remediation. This refers to the entire remediation task, not individual deployments. Allowed values are Evaluating, Canceled, Cancelling, Failed, Complete, or Succeeded.
StatusMessage string
The remediation status message. Provides additional details regarding the state of the remediation.
SystemData Pulumi.AzureNative.PolicyInsights.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the remediation.
FailureThreshold Pulumi.AzureNative.PolicyInsights.Outputs.RemediationPropertiesResponseFailureThreshold
The remediation failure threshold settings
Filters Pulumi.AzureNative.PolicyInsights.Outputs.RemediationFiltersResponse
The filters that will be applied to determine which resources to remediate.
ParallelDeployments int
Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
PolicyAssignmentId string
The resource ID of the policy assignment that should be remediated.
PolicyDefinitionReferenceId string
The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
ResourceCount int
Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
ResourceDiscoveryMode string
The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
CorrelationId string
The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
CreatedOn string
The time at which the remediation was created.
DeploymentStatus RemediationDeploymentSummaryResponse
The deployment status summary for all deployments created by the remediation.
Id string
The ID of the remediation.
LastUpdatedOn string
The time at which the remediation was last updated.
Name string
The name of the remediation.
ProvisioningState string
The status of the remediation. This refers to the entire remediation task, not individual deployments. Allowed values are Evaluating, Canceled, Cancelling, Failed, Complete, or Succeeded.
StatusMessage string
The remediation status message. Provides additional details regarding the state of the remediation.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the remediation.
FailureThreshold RemediationPropertiesResponseFailureThreshold
The remediation failure threshold settings
Filters RemediationFiltersResponse
The filters that will be applied to determine which resources to remediate.
ParallelDeployments int
Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
PolicyAssignmentId string
The resource ID of the policy assignment that should be remediated.
PolicyDefinitionReferenceId string
The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
ResourceCount int
Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
ResourceDiscoveryMode string
The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
correlationId String
The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
createdOn String
The time at which the remediation was created.
deploymentStatus RemediationDeploymentSummaryResponse
The deployment status summary for all deployments created by the remediation.
id String
The ID of the remediation.
lastUpdatedOn String
The time at which the remediation was last updated.
name String
The name of the remediation.
provisioningState String
The status of the remediation. This refers to the entire remediation task, not individual deployments. Allowed values are Evaluating, Canceled, Cancelling, Failed, Complete, or Succeeded.
statusMessage String
The remediation status message. Provides additional details regarding the state of the remediation.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the remediation.
failureThreshold RemediationPropertiesResponseFailureThreshold
The remediation failure threshold settings
filters RemediationFiltersResponse
The filters that will be applied to determine which resources to remediate.
parallelDeployments Integer
Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
policyAssignmentId String
The resource ID of the policy assignment that should be remediated.
policyDefinitionReferenceId String
The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
resourceCount Integer
Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
resourceDiscoveryMode String
The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
correlationId string
The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
createdOn string
The time at which the remediation was created.
deploymentStatus RemediationDeploymentSummaryResponse
The deployment status summary for all deployments created by the remediation.
id string
The ID of the remediation.
lastUpdatedOn string
The time at which the remediation was last updated.
name string
The name of the remediation.
provisioningState string
The status of the remediation. This refers to the entire remediation task, not individual deployments. Allowed values are Evaluating, Canceled, Cancelling, Failed, Complete, or Succeeded.
statusMessage string
The remediation status message. Provides additional details regarding the state of the remediation.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the remediation.
failureThreshold RemediationPropertiesResponseFailureThreshold
The remediation failure threshold settings
filters RemediationFiltersResponse
The filters that will be applied to determine which resources to remediate.
parallelDeployments number
Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
policyAssignmentId string
The resource ID of the policy assignment that should be remediated.
policyDefinitionReferenceId string
The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
resourceCount number
Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
resourceDiscoveryMode string
The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
correlation_id str
The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
created_on str
The time at which the remediation was created.
deployment_status RemediationDeploymentSummaryResponse
The deployment status summary for all deployments created by the remediation.
id str
The ID of the remediation.
last_updated_on str
The time at which the remediation was last updated.
name str
The name of the remediation.
provisioning_state str
The status of the remediation. This refers to the entire remediation task, not individual deployments. Allowed values are Evaluating, Canceled, Cancelling, Failed, Complete, or Succeeded.
status_message str
The remediation status message. Provides additional details regarding the state of the remediation.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the remediation.
failure_threshold RemediationPropertiesResponseFailureThreshold
The remediation failure threshold settings
filters RemediationFiltersResponse
The filters that will be applied to determine which resources to remediate.
parallel_deployments int
Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
policy_assignment_id str
The resource ID of the policy assignment that should be remediated.
policy_definition_reference_id str
The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
resource_count int
Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
resource_discovery_mode str
The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
correlationId String
The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
createdOn String
The time at which the remediation was created.
deploymentStatus Property Map
The deployment status summary for all deployments created by the remediation.
id String
The ID of the remediation.
lastUpdatedOn String
The time at which the remediation was last updated.
name String
The name of the remediation.
provisioningState String
The status of the remediation. This refers to the entire remediation task, not individual deployments. Allowed values are Evaluating, Canceled, Cancelling, Failed, Complete, or Succeeded.
statusMessage String
The remediation status message. Provides additional details regarding the state of the remediation.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the remediation.
failureThreshold Property Map
The remediation failure threshold settings
filters Property Map
The filters that will be applied to determine which resources to remediate.
parallelDeployments Number
Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
policyAssignmentId String
The resource ID of the policy assignment that should be remediated.
policyDefinitionReferenceId String
The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
resourceCount Number
Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
resourceDiscoveryMode String
The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.

Supporting Types

RemediationDeploymentSummaryResponse

FailedDeployments This property is required. int
The number of deployments required by the remediation that have failed.
SuccessfulDeployments This property is required. int
The number of deployments required by the remediation that have succeeded.
TotalDeployments This property is required. int
The number of deployments required by the remediation.
FailedDeployments This property is required. int
The number of deployments required by the remediation that have failed.
SuccessfulDeployments This property is required. int
The number of deployments required by the remediation that have succeeded.
TotalDeployments This property is required. int
The number of deployments required by the remediation.
failedDeployments This property is required. Integer
The number of deployments required by the remediation that have failed.
successfulDeployments This property is required. Integer
The number of deployments required by the remediation that have succeeded.
totalDeployments This property is required. Integer
The number of deployments required by the remediation.
failedDeployments This property is required. number
The number of deployments required by the remediation that have failed.
successfulDeployments This property is required. number
The number of deployments required by the remediation that have succeeded.
totalDeployments This property is required. number
The number of deployments required by the remediation.
failed_deployments This property is required. int
The number of deployments required by the remediation that have failed.
successful_deployments This property is required. int
The number of deployments required by the remediation that have succeeded.
total_deployments This property is required. int
The number of deployments required by the remediation.
failedDeployments This property is required. Number
The number of deployments required by the remediation that have failed.
successfulDeployments This property is required. Number
The number of deployments required by the remediation that have succeeded.
totalDeployments This property is required. Number
The number of deployments required by the remediation.

RemediationFiltersResponse

Locations List<string>
The resource locations that will be remediated.
Locations []string
The resource locations that will be remediated.
locations List<String>
The resource locations that will be remediated.
locations string[]
The resource locations that will be remediated.
locations Sequence[str]
The resource locations that will be remediated.
locations List<String>
The resource locations that will be remediated.

RemediationPropertiesResponseFailureThreshold

Percentage double
A number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold.
Percentage float64
A number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold.
percentage Double
A number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold.
percentage number
A number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold.
percentage float
A number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold.
percentage Number
A number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native