@azure/arm-policyinsights package

Classes

PolicyInsightsClient

Interfaces

Attestation

An attestation resource.
AttestationEvidence

A piece of evidence supporting the compliance state set in the attestation.
AttestationListResult

List of attestations.
Attestations

Interface representing a Attestations.
AttestationsCreateOrUpdateAtResourceGroupOptionalParams

Optional parameters.
AttestationsCreateOrUpdateAtResourceOptionalParams

Optional parameters.
AttestationsCreateOrUpdateAtSubscriptionOptionalParams

Optional parameters.
AttestationsDeleteAtResourceGroupOptionalParams

Optional parameters.
AttestationsDeleteAtResourceOptionalParams

Optional parameters.
AttestationsDeleteAtSubscriptionOptionalParams

Optional parameters.
AttestationsGetAtResourceGroupOptionalParams

Optional parameters.
AttestationsGetAtResourceOptionalParams

Optional parameters.
AttestationsGetAtSubscriptionOptionalParams

Optional parameters.
AttestationsListForResourceGroupNextOptionalParams

Optional parameters.
AttestationsListForResourceGroupOptionalParams

Optional parameters.
AttestationsListForResourceNextOptionalParams

Optional parameters.
AttestationsListForResourceOptionalParams

Optional parameters.
AttestationsListForSubscriptionNextOptionalParams

Optional parameters.
AttestationsListForSubscriptionOptionalParams

Optional parameters.
CheckManagementGroupRestrictionsRequest

The check policy restrictions parameters describing the resource that is being evaluated.
CheckRestrictionEvaluationDetails

Policy evaluation details.
CheckRestrictionsRequest

The check policy restrictions parameters describing the resource that is being evaluated.
CheckRestrictionsResourceDetails

The information about the resource that will be evaluated.
CheckRestrictionsResult

The result of a check policy restrictions evaluation on a resource.
CheckRestrictionsResultContentEvaluationResult

Evaluation results for the provided partial resource content.
ComplianceDetail

The compliance state rollup.
ComponentEventDetails

Component event details.
ComponentExpressionEvaluationDetails

Evaluation details of policy language expressions.
ComponentPolicyEvaluationDetails

Policy evaluation details.
ComponentPolicyState

Component Policy State record.
ComponentPolicyStates

Interface representing a ComponentPolicyStates.
ComponentPolicyStatesListQueryResultsForPolicyDefinitionOptionalParams

Optional parameters.
ComponentPolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams

Optional parameters.
ComponentPolicyStatesListQueryResultsForResourceGroupOptionalParams

Optional parameters.
ComponentPolicyStatesListQueryResultsForResourceOptionalParams

Optional parameters.
ComponentPolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams

Optional parameters.
ComponentPolicyStatesListQueryResultsForSubscriptionOptionalParams

Optional parameters.
ComponentPolicyStatesQueryResults

Query results.
ComponentStateDetails

Component state details.
ErrorDefinition

Error definition.
ErrorDefinitionAutoGenerated

Error definition.
ErrorDefinitionAutoGenerated2

Error definition.
ErrorResponse

Error response.
ErrorResponseAutoGenerated

Error response.
ErrorResponseAutoGenerated2

Error response.
ExpressionEvaluationDetails

Evaluation details of policy language expressions.
FieldRestriction

The restrictions on a field imposed by a specific policy.
FieldRestrictions

The restrictions that will be placed on a field in the resource by policy.
IfNotExistsEvaluationDetails

Evaluation details of IfNotExists effect.
Operation

Operation definition.
OperationDisplay

Display metadata associated with the operation.
Operations

Interface representing a Operations.
OperationsListOptionalParams

Optional parameters.
OperationsListResults

List of available operations.
PendingField

A field that should be evaluated against Azure Policy to determine restrictions.
PolicyAssignmentSummary

Policy assignment summary.
PolicyDefinitionSummary

Policy definition summary.
PolicyDetails

The policy details.
PolicyEffectDetails

The details of the effect that was applied to the resource.
PolicyEvaluationDetails

Policy evaluation details.
PolicyEvaluationResult

The result of a non-compliant policy evaluation against the given resource content.
PolicyEvent

Policy event record.
PolicyEvents

Interface representing a PolicyEvents.
PolicyEventsListQueryResultsForManagementGroupNextOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForManagementGroupOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForPolicyDefinitionNextOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForPolicyDefinitionOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForPolicySetDefinitionNextOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForPolicySetDefinitionOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForResourceGroupLevelPolicyAssignmentNextOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForResourceGroupNextOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForResourceGroupOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForResourceNextOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForResourceOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForSubscriptionLevelPolicyAssignmentNextOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForSubscriptionNextOptionalParams

Optional parameters.
PolicyEventsListQueryResultsForSubscriptionOptionalParams

Optional parameters.
PolicyEventsQueryResults

Query results.
PolicyGroupSummary

Policy definition group summary.
PolicyInsightsClientOptionalParams

Optional parameters.
PolicyMetadata

Policy metadata resource definition.
PolicyMetadataCollection

Collection of policy metadata resources.
PolicyMetadataGetResourceOptionalParams

Optional parameters.
PolicyMetadataListNextOptionalParams

Optional parameters.
PolicyMetadataListOptionalParams

Optional parameters.
PolicyMetadataOperations

Interface representing a PolicyMetadataOperations.
PolicyMetadataProperties

The properties of the policy metadata.
PolicyMetadataSlimProperties

The properties of the policy metadata, excluding properties containing large strings
PolicyReference

Resource identifiers for a policy.
PolicyRestrictions

Interface representing a PolicyRestrictions.
PolicyRestrictionsCheckAtManagementGroupScopeOptionalParams

Optional parameters.
PolicyRestrictionsCheckAtResourceGroupScopeOptionalParams

Optional parameters.
PolicyRestrictionsCheckAtSubscriptionScopeOptionalParams

Optional parameters.
PolicyState

Policy state record.
PolicyStates

Interface representing a PolicyStates.
PolicyStatesListQueryResultsForManagementGroupNextOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForManagementGroupOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForPolicyDefinitionNextOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForPolicyDefinitionOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForPolicySetDefinitionNextOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForPolicySetDefinitionOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentNextOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForResourceGroupNextOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForResourceGroupOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForResourceNextOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForResourceOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentNextOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForSubscriptionNextOptionalParams

Optional parameters.
PolicyStatesListQueryResultsForSubscriptionOptionalParams

Optional parameters.
PolicyStatesQueryResults

Query results.
PolicyStatesSummarizeForManagementGroupOptionalParams

Optional parameters.
PolicyStatesSummarizeForPolicyDefinitionOptionalParams

Optional parameters.
PolicyStatesSummarizeForPolicySetDefinitionOptionalParams

Optional parameters.
PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentOptionalParams

Optional parameters.
PolicyStatesSummarizeForResourceGroupOptionalParams

Optional parameters.
PolicyStatesSummarizeForResourceOptionalParams

Optional parameters.
PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams

Optional parameters.
PolicyStatesSummarizeForSubscriptionOptionalParams

Optional parameters.
PolicyStatesTriggerResourceGroupEvaluationOptionalParams

Optional parameters.
PolicyStatesTriggerSubscriptionEvaluationOptionalParams

Optional parameters.
PolicyTrackedResource

Policy tracked resource record.
PolicyTrackedResources

Interface representing a PolicyTrackedResources.
PolicyTrackedResourcesListQueryResultsForManagementGroupNextOptionalParams

Optional parameters.
PolicyTrackedResourcesListQueryResultsForManagementGroupOptionalParams

Optional parameters.
PolicyTrackedResourcesListQueryResultsForResourceGroupNextOptionalParams

Optional parameters.
PolicyTrackedResourcesListQueryResultsForResourceGroupOptionalParams

Optional parameters.
PolicyTrackedResourcesListQueryResultsForResourceNextOptionalParams

Optional parameters.
PolicyTrackedResourcesListQueryResultsForResourceOptionalParams

Optional parameters.
PolicyTrackedResourcesListQueryResultsForSubscriptionNextOptionalParams

Optional parameters.
PolicyTrackedResourcesListQueryResultsForSubscriptionOptionalParams

Optional parameters.
PolicyTrackedResourcesQueryResults

Query results.
QueryFailure

Error response.
QueryFailureError

Error definition.
QueryOptions

Parameter group
Remediation

The remediation definition.
RemediationDeployment

Details of a single deployment created by the remediation.
RemediationDeploymentSummary

The deployment status summary for all deployments created by the remediation.
RemediationDeploymentsListResult

List of deployments for a remediation.
RemediationFilters

The filters that will be applied to determine which resources to remediate.
RemediationListResult

List of remediations.
RemediationPropertiesFailureThreshold

The remediation failure threshold settings
Remediations

Interface representing a Remediations.
RemediationsCancelAtManagementGroupOptionalParams

Optional parameters.
RemediationsCancelAtResourceGroupOptionalParams

Optional parameters.
RemediationsCancelAtResourceOptionalParams

Optional parameters.
RemediationsCancelAtSubscriptionOptionalParams

Optional parameters.
RemediationsCreateOrUpdateAtManagementGroupOptionalParams

Optional parameters.
RemediationsCreateOrUpdateAtResourceGroupOptionalParams

Optional parameters.
RemediationsCreateOrUpdateAtResourceOptionalParams

Optional parameters.
RemediationsCreateOrUpdateAtSubscriptionOptionalParams

Optional parameters.
RemediationsDeleteAtManagementGroupOptionalParams

Optional parameters.
RemediationsDeleteAtResourceGroupOptionalParams

Optional parameters.
RemediationsDeleteAtResourceOptionalParams

Optional parameters.
RemediationsDeleteAtSubscriptionOptionalParams

Optional parameters.
RemediationsGetAtManagementGroupOptionalParams

Optional parameters.
RemediationsGetAtResourceGroupOptionalParams

Optional parameters.
RemediationsGetAtResourceOptionalParams

Optional parameters.
RemediationsGetAtSubscriptionOptionalParams

Optional parameters.
RemediationsListDeploymentsAtManagementGroupNextOptionalParams

Optional parameters.
RemediationsListDeploymentsAtManagementGroupOptionalParams

Optional parameters.
RemediationsListDeploymentsAtResourceGroupNextOptionalParams

Optional parameters.
RemediationsListDeploymentsAtResourceGroupOptionalParams

Optional parameters.
RemediationsListDeploymentsAtResourceNextOptionalParams

Optional parameters.
RemediationsListDeploymentsAtResourceOptionalParams

Optional parameters.
RemediationsListDeploymentsAtSubscriptionNextOptionalParams

Optional parameters.
RemediationsListDeploymentsAtSubscriptionOptionalParams

Optional parameters.
RemediationsListForManagementGroupNextOptionalParams

Optional parameters.
RemediationsListForManagementGroupOptionalParams

Optional parameters.
RemediationsListForResourceGroupNextOptionalParams

Optional parameters.
RemediationsListForResourceGroupOptionalParams

Optional parameters.
RemediationsListForResourceNextOptionalParams

Optional parameters.
RemediationsListForResourceOptionalParams

Optional parameters.
RemediationsListForSubscriptionNextOptionalParams

Optional parameters.
RemediationsListForSubscriptionOptionalParams

Optional parameters.
Resource

Common fields that are returned in the response for all Azure Resource Manager resources
SlimPolicyMetadata

Slim version of policy metadata resource definition, excluding properties with large strings
SummarizeResults

Summarize action results.
Summary

Summary results.
SummaryResults

Compliance summary on a particular summary level.
SystemData

Metadata pertaining to creation and last modification of the resource.
TrackedResourceModificationDetails

The details of the policy triggered deployment that created or modified the tracked resource.
TypedErrorInfo

Scenario specific error details.

Type Aliases

AttestationsCreateOrUpdateAtResourceGroupResponse

Contains response data for the createOrUpdateAtResourceGroup operation.
AttestationsCreateOrUpdateAtResourceResponse

Contains response data for the createOrUpdateAtResource operation.
AttestationsCreateOrUpdateAtSubscriptionResponse

Contains response data for the createOrUpdateAtSubscription operation.
AttestationsGetAtResourceGroupResponse

Contains response data for the getAtResourceGroup operation.
AttestationsGetAtResourceResponse

Contains response data for the getAtResource operation.
AttestationsGetAtSubscriptionResponse

Contains response data for the getAtSubscription operation.
AttestationsListForResourceGroupNextResponse

Contains response data for the listForResourceGroupNext operation.
AttestationsListForResourceGroupResponse

Contains response data for the listForResourceGroup operation.
AttestationsListForResourceNextResponse

Contains response data for the listForResourceNext operation.
AttestationsListForResourceResponse

Contains response data for the listForResource operation.
AttestationsListForSubscriptionNextResponse

Contains response data for the listForSubscriptionNext operation.
AttestationsListForSubscriptionResponse

Contains response data for the listForSubscription operation.
ComplianceState

Defines values for ComplianceState.
KnownComplianceState can be used interchangeably with ComplianceState, this enum contains the known values that the service supports.

Known values supported by the service

Compliant: The resource is in compliance with the policy.
NonCompliant: The resource is not in compliance with the policy.
Unknown: The compliance state of the resource is not known.
ComponentPolicyStatesListQueryResultsForPolicyDefinitionResponse

Contains response data for the listQueryResultsForPolicyDefinition operation.
ComponentPolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentResponse

Contains response data for the listQueryResultsForResourceGroupLevelPolicyAssignment operation.
ComponentPolicyStatesListQueryResultsForResourceGroupResponse

Contains response data for the listQueryResultsForResourceGroup operation.
ComponentPolicyStatesListQueryResultsForResourceResponse

Contains response data for the listQueryResultsForResource operation.
ComponentPolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentResponse

Contains response data for the listQueryResultsForSubscriptionLevelPolicyAssignment operation.
ComponentPolicyStatesListQueryResultsForSubscriptionResponse

Contains response data for the listQueryResultsForSubscription operation.
ComponentPolicyStatesResource

Defines values for ComponentPolicyStatesResource.
KnownComponentPolicyStatesResource can be used interchangeably with ComponentPolicyStatesResource, this enum contains the known values that the service supports.

Known values supported by the service

latest
CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key
FieldRestrictionResult

Defines values for FieldRestrictionResult.
KnownFieldRestrictionResult can be used interchangeably with FieldRestrictionResult, this enum contains the known values that the service supports.

Known values supported by the service

Required: The field and/or values are required by policy.
Removed: The field will be removed by policy.
Deny: The field and/or values will be denied by policy.
Audit: The field and/or values will be audited by policy.
OperationsListResponse

Contains response data for the list operation.
PolicyEventsListQueryResultsForManagementGroupNextResponse

Contains response data for the listQueryResultsForManagementGroupNext operation.
PolicyEventsListQueryResultsForManagementGroupResponse

Contains response data for the listQueryResultsForManagementGroup operation.
PolicyEventsListQueryResultsForPolicyDefinitionNextResponse

Contains response data for the listQueryResultsForPolicyDefinitionNext operation.
PolicyEventsListQueryResultsForPolicyDefinitionResponse

Contains response data for the listQueryResultsForPolicyDefinition operation.
PolicyEventsListQueryResultsForPolicySetDefinitionNextResponse

Contains response data for the listQueryResultsForPolicySetDefinitionNext operation.
PolicyEventsListQueryResultsForPolicySetDefinitionResponse

Contains response data for the listQueryResultsForPolicySetDefinition operation.
PolicyEventsListQueryResultsForResourceGroupLevelPolicyAssignmentNextResponse

Contains response data for the listQueryResultsForResourceGroupLevelPolicyAssignmentNext operation.
PolicyEventsListQueryResultsForResourceGroupLevelPolicyAssignmentResponse

Contains response data for the listQueryResultsForResourceGroupLevelPolicyAssignment operation.
PolicyEventsListQueryResultsForResourceGroupNextResponse

Contains response data for the listQueryResultsForResourceGroupNext operation.
PolicyEventsListQueryResultsForResourceGroupResponse

Contains response data for the listQueryResultsForResourceGroup operation.
PolicyEventsListQueryResultsForResourceNextResponse

Contains response data for the listQueryResultsForResourceNext operation.
PolicyEventsListQueryResultsForResourceResponse

Contains response data for the listQueryResultsForResource operation.
PolicyEventsListQueryResultsForSubscriptionLevelPolicyAssignmentNextResponse

Contains response data for the listQueryResultsForSubscriptionLevelPolicyAssignmentNext operation.
PolicyEventsListQueryResultsForSubscriptionLevelPolicyAssignmentResponse

Contains response data for the listQueryResultsForSubscriptionLevelPolicyAssignment operation.
PolicyEventsListQueryResultsForSubscriptionNextResponse

Contains response data for the listQueryResultsForSubscriptionNext operation.
PolicyEventsListQueryResultsForSubscriptionResponse

Contains response data for the listQueryResultsForSubscription operation.
PolicyEventsResourceType

Defines values for PolicyEventsResourceType.
KnownPolicyEventsResourceType can be used interchangeably with PolicyEventsResourceType, this enum contains the known values that the service supports.

Known values supported by the service

default
PolicyMetadataGetResourceResponse

Contains response data for the getResource operation.
PolicyMetadataListNextResponse

Contains response data for the listNext operation.
PolicyMetadataListResponse

Contains response data for the list operation.
PolicyRestrictionsCheckAtManagementGroupScopeResponse

Contains response data for the checkAtManagementGroupScope operation.
PolicyRestrictionsCheckAtResourceGroupScopeResponse

Contains response data for the checkAtResourceGroupScope operation.
PolicyRestrictionsCheckAtSubscriptionScopeResponse

Contains response data for the checkAtSubscriptionScope operation.
PolicyStatesListQueryResultsForManagementGroupNextResponse

Contains response data for the listQueryResultsForManagementGroupNext operation.
PolicyStatesListQueryResultsForManagementGroupResponse

Contains response data for the listQueryResultsForManagementGroup operation.
PolicyStatesListQueryResultsForPolicyDefinitionNextResponse

Contains response data for the listQueryResultsForPolicyDefinitionNext operation.
PolicyStatesListQueryResultsForPolicyDefinitionResponse

Contains response data for the listQueryResultsForPolicyDefinition operation.
PolicyStatesListQueryResultsForPolicySetDefinitionNextResponse

Contains response data for the listQueryResultsForPolicySetDefinitionNext operation.
PolicyStatesListQueryResultsForPolicySetDefinitionResponse

Contains response data for the listQueryResultsForPolicySetDefinition operation.
PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentNextResponse

Contains response data for the listQueryResultsForResourceGroupLevelPolicyAssignmentNext operation.
PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentResponse

Contains response data for the listQueryResultsForResourceGroupLevelPolicyAssignment operation.
PolicyStatesListQueryResultsForResourceGroupNextResponse

Contains response data for the listQueryResultsForResourceGroupNext operation.
PolicyStatesListQueryResultsForResourceGroupResponse

Contains response data for the listQueryResultsForResourceGroup operation.
PolicyStatesListQueryResultsForResourceNextResponse

Contains response data for the listQueryResultsForResourceNext operation.
PolicyStatesListQueryResultsForResourceResponse

Contains response data for the listQueryResultsForResource operation.
PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentNextResponse

Contains response data for the listQueryResultsForSubscriptionLevelPolicyAssignmentNext operation.
PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentResponse

Contains response data for the listQueryResultsForSubscriptionLevelPolicyAssignment operation.
PolicyStatesListQueryResultsForSubscriptionNextResponse

Contains response data for the listQueryResultsForSubscriptionNext operation.
PolicyStatesListQueryResultsForSubscriptionResponse

Contains response data for the listQueryResultsForSubscription operation.
PolicyStatesResource

Defines values for PolicyStatesResource.
KnownPolicyStatesResource can be used interchangeably with PolicyStatesResource, this enum contains the known values that the service supports.

Known values supported by the service

default
latest
PolicyStatesSummarizeForManagementGroupResponse

Contains response data for the summarizeForManagementGroup operation.
PolicyStatesSummarizeForPolicyDefinitionResponse

Contains response data for the summarizeForPolicyDefinition operation.
PolicyStatesSummarizeForPolicySetDefinitionResponse

Contains response data for the summarizeForPolicySetDefinition operation.
PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentResponse

Contains response data for the summarizeForResourceGroupLevelPolicyAssignment operation.
PolicyStatesSummarizeForResourceGroupResponse

Contains response data for the summarizeForResourceGroup operation.