@azure/arm-policyinsights package

Classes

Interfaces

Attestation	An attestation resource.
AttestationEvidence	A piece of evidence supporting the compliance state set in the attestation.
AttestationProperties	The properties of an attestation resource.
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.
AttestationsListForResourceGroupOptionalParams	Optional parameters.
AttestationsListForResourceGroupQueryOptions	model interface AttestationsListForResourceGroupQueryOptions
AttestationsListForResourceOptionalParams	Optional parameters.
AttestationsListForResourceQueryOptions	model interface AttestationsListForResourceQueryOptions
AttestationsListForSubscriptionOptionalParams	Optional parameters.
AttestationsListForSubscriptionQueryOptions	model interface AttestationsListForSubscriptionQueryOptions
AttestationsOperations	Interface representing a Attestations operations.
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.
ComponentPolicyStatesListQueryResultsForPolicyDefinitionOptionalParams	Optional parameters.
ComponentPolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams	Optional parameters.
ComponentPolicyStatesListQueryResultsForResourceGroupOptionalParams	Optional parameters.
ComponentPolicyStatesListQueryResultsForResourceOptionalParams	Optional parameters.
ComponentPolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams	Optional parameters.
ComponentPolicyStatesListQueryResultsForSubscriptionOptionalParams	Optional parameters.
ComponentPolicyStatesOperations	Interface representing a ComponentPolicyStates operations.
ComponentPolicyStatesQueryResults	Query results.
ComponentStateDetails	Component state details.
ErrorDefinition	Error definition.
ErrorResponse	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.
OperationsListOptionalParams	Optional parameters.
OperationsListResults	List of available operations.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
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.
PolicyEventsListQueryResultsForManagementGroupOptionalParams	Optional parameters.
PolicyEventsListQueryResultsForManagementGroupQueryOptions	model interface PolicyEventsListQueryResultsForManagementGroupQueryOptions
PolicyEventsListQueryResultsForPolicyDefinitionOptionalParams	Optional parameters.
PolicyEventsListQueryResultsForPolicyDefinitionQueryOptions	model interface PolicyEventsListQueryResultsForPolicyDefinitionQueryOptions
PolicyEventsListQueryResultsForPolicySetDefinitionOptionalParams	Optional parameters.
PolicyEventsListQueryResultsForPolicySetDefinitionQueryOptions	model interface PolicyEventsListQueryResultsForPolicySetDefinitionQueryOptions
PolicyEventsListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams	Optional parameters.
PolicyEventsListQueryResultsForResourceGroupLevelPolicyAssignmentQueryOptions	model interface PolicyEventsListQueryResultsForResourceGroupLevelPolicyAssignmentQueryOptions
PolicyEventsListQueryResultsForResourceGroupOptionalParams	Optional parameters.
PolicyEventsListQueryResultsForResourceGroupQueryOptions	model interface PolicyEventsListQueryResultsForResourceGroupQueryOptions
PolicyEventsListQueryResultsForResourceOptionalParams	Optional parameters.
PolicyEventsListQueryResultsForResourceQueryOptions	model interface PolicyEventsListQueryResultsForResourceQueryOptions
PolicyEventsListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams	Optional parameters.
PolicyEventsListQueryResultsForSubscriptionLevelPolicyAssignmentQueryOptions	model interface PolicyEventsListQueryResultsForSubscriptionLevelPolicyAssignmentQueryOptions
PolicyEventsListQueryResultsForSubscriptionOptionalParams	Optional parameters.
PolicyEventsListQueryResultsForSubscriptionQueryOptions	model interface PolicyEventsListQueryResultsForSubscriptionQueryOptions
PolicyEventsOperations	Interface representing a PolicyEvents operations.
PolicyGroupSummary	Policy definition group summary.
PolicyInsightsClientOptionalParams	Optional parameters for the client.
PolicyMetadata	Policy metadata resource definition.
PolicyMetadataListQueryOptions	model interface PolicyMetadataListQueryOptions
PolicyMetadataOperationsGetResourceOptionalParams	Optional parameters.
PolicyMetadataOperationsListOptionalParams	Optional parameters.
PolicyMetadataOperationsOperations	Interface representing a PolicyMetadataOperations operations.
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.
PolicyRestrictionsCheckAtManagementGroupScopeOptionalParams	Optional parameters.
PolicyRestrictionsCheckAtResourceGroupScopeOptionalParams	Optional parameters.
PolicyRestrictionsCheckAtSubscriptionScopeOptionalParams	Optional parameters.
PolicyRestrictionsOperations	Interface representing a PolicyRestrictions operations.
PolicyState	Policy state record.
PolicyStatesListQueryResultsForManagementGroupOptionalParams	Optional parameters.
PolicyStatesListQueryResultsForManagementGroupQueryOptions	model interface PolicyStatesListQueryResultsForManagementGroupQueryOptions
PolicyStatesListQueryResultsForPolicyDefinitionOptionalParams	Optional parameters.
PolicyStatesListQueryResultsForPolicyDefinitionQueryOptions	model interface PolicyStatesListQueryResultsForPolicyDefinitionQueryOptions
PolicyStatesListQueryResultsForPolicySetDefinitionOptionalParams	Optional parameters.
PolicyStatesListQueryResultsForPolicySetDefinitionQueryOptions	model interface PolicyStatesListQueryResultsForPolicySetDefinitionQueryOptions
PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentOptionalParams	Optional parameters.
PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentQueryOptions	model interface PolicyStatesListQueryResultsForResourceGroupLevelPolicyAssignmentQueryOptions
PolicyStatesListQueryResultsForResourceGroupOptionalParams	Optional parameters.
PolicyStatesListQueryResultsForResourceGroupQueryOptions	model interface PolicyStatesListQueryResultsForResourceGroupQueryOptions
PolicyStatesListQueryResultsForResourceOptionalParams	Optional parameters.
PolicyStatesListQueryResultsForResourceQueryOptions	model interface PolicyStatesListQueryResultsForResourceQueryOptions
PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentOptionalParams	Optional parameters.
PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentQueryOptions	model interface PolicyStatesListQueryResultsForSubscriptionLevelPolicyAssignmentQueryOptions
PolicyStatesListQueryResultsForSubscriptionOptionalParams	Optional parameters.
PolicyStatesListQueryResultsForSubscriptionQueryOptions	model interface PolicyStatesListQueryResultsForSubscriptionQueryOptions
PolicyStatesOperations	Interface representing a PolicyStates operations.
PolicyStatesSummarizeForManagementGroupOptionalParams	Optional parameters.
PolicyStatesSummarizeForManagementGroupQueryOptions	model interface PolicyStatesSummarizeForManagementGroupQueryOptions
PolicyStatesSummarizeForPolicyDefinitionOptionalParams	Optional parameters.
PolicyStatesSummarizeForPolicyDefinitionQueryOptions	model interface PolicyStatesSummarizeForPolicyDefinitionQueryOptions
PolicyStatesSummarizeForPolicySetDefinitionOptionalParams	Optional parameters.
PolicyStatesSummarizeForPolicySetDefinitionQueryOptions	model interface PolicyStatesSummarizeForPolicySetDefinitionQueryOptions
PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentOptionalParams	Optional parameters.
PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentQueryOptions	model interface PolicyStatesSummarizeForResourceGroupLevelPolicyAssignmentQueryOptions
PolicyStatesSummarizeForResourceGroupOptionalParams	Optional parameters.
PolicyStatesSummarizeForResourceGroupQueryOptions	model interface PolicyStatesSummarizeForResourceGroupQueryOptions
PolicyStatesSummarizeForResourceOptionalParams	Optional parameters.
PolicyStatesSummarizeForResourceQueryOptions	model interface PolicyStatesSummarizeForResourceQueryOptions
PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentOptionalParams	Optional parameters.
PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentQueryOptions	model interface PolicyStatesSummarizeForSubscriptionLevelPolicyAssignmentQueryOptions
PolicyStatesSummarizeForSubscriptionOptionalParams	Optional parameters.
PolicyStatesSummarizeForSubscriptionQueryOptions	model interface PolicyStatesSummarizeForSubscriptionQueryOptions
PolicyStatesTriggerResourceGroupEvaluationOptionalParams	Optional parameters.
PolicyStatesTriggerSubscriptionEvaluationOptionalParams	Optional parameters.
PolicyTrackedResource	Policy tracked resource record.
PolicyTrackedResourcesListQueryResultsForManagementGroupOptionalParams	Optional parameters.
PolicyTrackedResourcesListQueryResultsForManagementGroupQueryOptions	model interface PolicyTrackedResourcesListQueryResultsForManagementGroupQueryOptions
PolicyTrackedResourcesListQueryResultsForResourceGroupOptionalParams	Optional parameters.
PolicyTrackedResourcesListQueryResultsForResourceGroupQueryOptions	model interface PolicyTrackedResourcesListQueryResultsForResourceGroupQueryOptions
PolicyTrackedResourcesListQueryResultsForResourceOptionalParams	Optional parameters.
PolicyTrackedResourcesListQueryResultsForResourceQueryOptions	model interface PolicyTrackedResourcesListQueryResultsForResourceQueryOptions
PolicyTrackedResourcesListQueryResultsForSubscriptionOptionalParams	Optional parameters.
PolicyTrackedResourcesListQueryResultsForSubscriptionQueryOptions	model interface PolicyTrackedResourcesListQueryResultsForSubscriptionQueryOptions
PolicyTrackedResourcesOperations	Interface representing a PolicyTrackedResources operations.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
QueryFailure	Error response.
QueryFailureError	Error definition.
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.
RemediationFilters	The filters that will be applied to determine which resources to remediate.
RemediationProperties	The remediation properties.
RemediationPropertiesFailureThreshold	The remediation failure threshold settings
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.
RemediationsListDeploymentsAtManagementGroupOptionalParams	Optional parameters.
RemediationsListDeploymentsAtManagementGroupQueryOptions	model interface RemediationsListDeploymentsAtManagementGroupQueryOptions
RemediationsListDeploymentsAtResourceGroupOptionalParams	Optional parameters.
RemediationsListDeploymentsAtResourceGroupQueryOptions	model interface RemediationsListDeploymentsAtResourceGroupQueryOptions
RemediationsListDeploymentsAtResourceOptionalParams	Optional parameters.
RemediationsListDeploymentsAtResourceQueryOptions	model interface RemediationsListDeploymentsAtResourceQueryOptions
RemediationsListDeploymentsAtSubscriptionOptionalParams	Optional parameters.
RemediationsListDeploymentsAtSubscriptionQueryOptions	model interface RemediationsListDeploymentsAtSubscriptionQueryOptions
RemediationsListForManagementGroupOptionalParams	Optional parameters.
RemediationsListForManagementGroupQueryOptions	model interface RemediationsListForManagementGroupQueryOptions
RemediationsListForResourceGroupOptionalParams	Optional parameters.
RemediationsListForResourceGroupQueryOptions	model interface RemediationsListForResourceGroupQueryOptions
RemediationsListForResourceOptionalParams	Optional parameters.
RemediationsListForResourceQueryOptions	model interface RemediationsListForResourceQueryOptions
RemediationsListForSubscriptionOptionalParams	Optional parameters.
RemediationsListForSubscriptionQueryOptions	model interface RemediationsListForSubscriptionQueryOptions
RemediationsOperations	Interface representing a Remediations operations.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SimplePollerLike	A simple poller that can be used to poll a long running operation.
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

AzureSupportedClouds	The supported values for cloud setting as a string literal type
ComplianceState	The compliance state that should be set on the resource. 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.
ComponentPolicyStatesResource	Type of ComponentPolicyStatesResource
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
FieldRestrictionResult	The type of restriction that is imposed on the field. 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.
PolicyEventsResourceType	Type of PolicyEventsResourceType
PolicyStatesResource	Type of PolicyStatesResource
PolicyStatesSummaryResourceType	Type of PolicyStatesSummaryResourceType
PolicyTrackedResourcesResourceType	Type of PolicyTrackedResourcesResourceType
ResourceDiscoveryMode	The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. KnownResourceDiscoveryMode can be used interchangeably with ResourceDiscoveryMode, this enum contains the known values that the service supports. Known values supported by the service ExistingNonCompliant: Remediate resources that are already known to be non-compliant. ReEvaluateCompliance: Re-evaluate the compliance state of resources and then remediate the resources found to be non-compliant. The resourceIds filter cannot be used in this mode.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownComplianceState	The compliance state that should be set on the resource.
KnownComponentPolicyStatesResource	Known values of ComponentPolicyStatesResource that the service accepts.
KnownCreatedByType	The kind of entity that created the resource.
KnownFieldRestrictionResult	The type of restriction that is imposed on the field.
KnownPolicyEventsResourceType	Known values of PolicyEventsResourceType that the service accepts.
KnownPolicyStatesResource	Known values of PolicyStatesResource that the service accepts.
KnownPolicyStatesSummaryResourceType	Known values of PolicyStatesSummaryResourceType that the service accepts.
KnownPolicyTrackedResourcesResourceType	Known values of PolicyTrackedResourcesResourceType that the service accepts.
KnownResourceDiscoveryMode	The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(PolicyInsightsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(PolicyInsightsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: PolicyInsightsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: PolicyInsightsClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-policyinsights package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(PolicyInsightsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type

Feedback