@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.69 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* The remediation definition.
*
* Uses Azure REST API version 2024-10-01. In version 2.x of the Azure Native provider, it used API version 2021-10-01.
*
* Other available API versions: 2021-10-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native policyinsights [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class RemediationAtSubscription extends pulumi.CustomResource {
/**
* Get an existing RemediationAtSubscription resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): RemediationAtSubscription;
/**
* Returns true if the given object is an instance of RemediationAtSubscription. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is RemediationAtSubscription;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
*/
readonly correlationId: pulumi.Output<string>;
/**
* The time at which the remediation was created.
*/
readonly createdOn: pulumi.Output<string>;
/**
* The deployment status summary for all deployments created by the remediation.
*/
readonly deploymentStatus: pulumi.Output<outputs.policyinsights.RemediationDeploymentSummaryResponse>;
/**
* The remediation failure threshold settings
*/
readonly failureThreshold: pulumi.Output<outputs.policyinsights.RemediationPropertiesResponseFailureThreshold | undefined>;
/**
* The filters that will be applied to determine which resources to remediate.
*/
readonly filters: pulumi.Output<outputs.policyinsights.RemediationFiltersResponse | undefined>;
/**
* The time at which the remediation was last updated.
*/
readonly lastUpdatedOn: pulumi.Output<string>;
/**
* The name of the remediation.
*/
readonly name: pulumi.Output<string>;
/**
* 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.
*/
readonly parallelDeployments: pulumi.Output<number | undefined>;
/**
* The resource ID of the policy assignment that should be remediated.
*/
readonly policyAssignmentId: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly policyDefinitionReferenceId: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
*/
readonly resourceCount: pulumi.Output<number | undefined>;
/**
* The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
*/
readonly resourceDiscoveryMode: pulumi.Output<string | undefined>;
/**
* The remediation status message. Provides additional details regarding the state of the remediation.
*/
readonly statusMessage: pulumi.Output<string>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.policyinsights.SystemDataResponse>;
/**
* The type of the remediation.
*/
readonly type: pulumi.Output<string>;
/**
* Create a RemediationAtSubscription resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: RemediationAtSubscriptionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a RemediationAtSubscription resource.
*/
export interface RemediationAtSubscriptionArgs {
/**
* The remediation failure threshold settings
*/
failureThreshold?: pulumi.Input<inputs.policyinsights.RemediationPropertiesFailureThresholdArgs>;
/**
* The filters that will be applied to determine which resources to remediate.
*/
filters?: pulumi.Input<inputs.policyinsights.RemediationFiltersArgs>;
/**
* 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.
*/
parallelDeployments?: pulumi.Input<number>;
/**
* The resource ID of the policy assignment that should be remediated.
*/
policyAssignmentId?: pulumi.Input<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.
*/
policyDefinitionReferenceId?: pulumi.Input<string>;
/**
* The name of the remediation.
*/
remediationName?: pulumi.Input<string>;
/**
* Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
*/
resourceCount?: pulumi.Input<number>;
/**
* The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
*/
resourceDiscoveryMode?: pulumi.Input<string | enums.policyinsights.ResourceDiscoveryMode>;
}