Package com.azure.resourcemanager.policyinsights.models

Interface Remediation

public interface Remediation
An immutable client-side representation of Remediation.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData value.

    • policyAssignmentId

      String policyAssignmentId()
      Gets the policyAssignmentId property: The resource ID of the policy assignment that should be remediated.
      Returns:
      the policyAssignmentId value.

    • policyDefinitionReferenceId

      String policyDefinitionReferenceId()
      Gets the policyDefinitionReferenceId property: 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.
      Returns:
      the policyDefinitionReferenceId value.

    • resourceDiscoveryMode

      ResourceDiscoveryMode resourceDiscoveryMode()
      Gets the resourceDiscoveryMode property: The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
      Returns:
      the resourceDiscoveryMode value.

    • provisioningState

      String provisioningState()
      Gets the provisioningState property: The status of the remediation.
      Returns:
      the provisioningState value.

    • createdOn

      OffsetDateTime createdOn()
      Gets the createdOn property: The time at which the remediation was created.
      Returns:
      the createdOn value.

    • lastUpdatedOn

      OffsetDateTime lastUpdatedOn()
      Gets the lastUpdatedOn property: The time at which the remediation was last updated.
      Returns:
      the lastUpdatedOn value.

    • filters

      RemediationFilters filters()
      Gets the filters property: The filters that will be applied to determine which resources to remediate.
      Returns:
      the filters value.

    • deploymentStatus

      RemediationDeploymentSummary deploymentStatus()
      Gets the deploymentStatus property: The deployment status summary for all deployments created by the remediation.
      Returns:
      the deploymentStatus value.

    • statusMessage

      String statusMessage()
      Gets the statusMessage property: The remediation status message. Provides additional details regarding the state of the remediation.
      Returns:
      the statusMessage value.

    • correlationId

      String correlationId()
      Gets the correlationId property: The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
      Returns:
      the correlationId value.

    • resourceCount

      Integer resourceCount()
      Gets the resourceCount property: Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
      Returns:
      the resourceCount value.

    • parallelDeployments

      Integer parallelDeployments()
      Gets the parallelDeployments property: 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.
      Returns:
      the parallelDeployments value.

    • failureThreshold

      RemediationPropertiesFailureThreshold failureThreshold()
      Gets the failureThreshold property: The remediation failure threshold settings.
      Returns:
      the failureThreshold value.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      RemediationInner innerModel()
      Gets the inner com.azure.resourcemanager.policyinsights.fluent.models.RemediationInner object.
      Returns:
      the inner object.

    • update

      Remediation.Update update()
      Begins update for the Remediation resource.
      Returns:
      the stage of resource update.

    • refresh

      Remediation refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      Remediation refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • listDeploymentsAtResourceGroup

      com.azure.core.http.rest.PagedIterable<RemediationDeployment> listDeploymentsAtResourceGroup()
      Gets all deployments for a remediation at resource group scope.
      Returns:
      all deployments for a remediation at resource group scope as paginated response with PagedIterable.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listDeploymentsAtResourceGroup

      com.azure.core.http.rest.PagedIterable<RemediationDeployment> listDeploymentsAtResourceGroup(Integer top, com.azure.core.util.Context context)
      Gets all deployments for a remediation at resource group scope.
      Parameters:
      top - Maximum number of records to return.
      context - The context to associate with this operation.
      Returns:
      all deployments for a remediation at resource group scope as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • cancelAtResourceGroupWithResponse

      com.azure.core.http.rest.Response<Remediation> cancelAtResourceGroupWithResponse(com.azure.core.util.Context context)
      Cancels a remediation at resource group scope.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the remediation definition along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • cancelAtResourceGroup

      Remediation cancelAtResourceGroup()
      Cancels a remediation at resource group scope.
      Returns:
      the remediation definition.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.