@azure/arm-policy package

Classes

PolicyClient

Interfaces

Alias	The alias type.
AliasPath	The type of the paths for alias.
AliasPathMetadata	The alias path metadata.
AliasPattern	The type of the pattern for an alias path.
DataEffect	The data effect definition.
DataManifestCustomResourceFunctionDefinition	The custom resource function definition.
DataManifestResourceFunctionsDefinition	The resource functions supported by a manifest.
DataPolicyManifest	The data policy manifest.
DataPolicyManifestProperties	The properties of the data policy manifest.
DataPolicyManifestsGetByPolicyModeOptionalParams	Optional parameters.
DataPolicyManifestsListOptionalParams	Optional parameters.
DataPolicyManifestsOperations	Interface representing a DataPolicyManifests operations.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExtensionResource	The base extension resource.
ExternalEvaluationEndpointInvocationResult	The external evaluation endpoint invocation results.
ExternalEvaluationEndpointSettings	The settings of an external endpoint providing evaluation results.
ExternalEvaluationEnforcementSettings	The details of the source of external evaluation results required by the policy during enforcement evaluation.
Identity	Identity for the resource. Policy assignments support a maximum of one identity. That is either a system assigned identity or a single user assigned identity.
NonComplianceMessage	A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results.
Override	The policy property value override.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ParameterDefinitionsValue	The definition of a parameter that can be provided to the policy.
ParameterDefinitionsValueMetadata	General metadata for the parameter.
ParameterValuesValue	The value of a parameter.
PolicyAssignment	The policy assignment.
PolicyAssignmentProperties	The policy assignment properties.
PolicyAssignmentUpdate	The policy assignment for Patch request.
PolicyAssignmentUpdateProperties	The policy assignment properties for Patch request.
PolicyAssignmentsCreateOptionalParams	Optional parameters.
PolicyAssignmentsDeleteOptionalParams	Optional parameters.
PolicyAssignmentsGetOptionalParams	Optional parameters.
PolicyAssignmentsListForManagementGroupOptionalParams	Optional parameters.
PolicyAssignmentsListForResourceGroupOptionalParams	Optional parameters.
PolicyAssignmentsListForResourceOptionalParams	Optional parameters.
PolicyAssignmentsListOptionalParams	Optional parameters.
PolicyAssignmentsOperations	Interface representing a PolicyAssignments operations.
PolicyAssignmentsUpdateOptionalParams	Optional parameters.
PolicyClientOptionalParams	Optional parameters for the client.
PolicyDefinition	The policy definition.
PolicyDefinitionGroup	The policy definition group.
PolicyDefinitionProperties	The policy definition properties.
PolicyDefinitionReference	The policy definition reference.
PolicyDefinitionVersion	The ID of the policy definition version.
PolicyDefinitionVersionListResult	The response of a PolicyDefinitionVersion list operation.
PolicyDefinitionVersionProperties	The policy definition properties.
PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams	Optional parameters.
PolicyDefinitionVersionsCreateOrUpdateOptionalParams	Optional parameters.
PolicyDefinitionVersionsDeleteAtManagementGroupOptionalParams	Optional parameters.
PolicyDefinitionVersionsDeleteOptionalParams	Optional parameters.
PolicyDefinitionVersionsGetAtManagementGroupOptionalParams	Optional parameters.
PolicyDefinitionVersionsGetBuiltInOptionalParams	Optional parameters.
PolicyDefinitionVersionsGetOptionalParams	Optional parameters.
PolicyDefinitionVersionsListAllAtManagementGroupOptionalParams	Optional parameters.
PolicyDefinitionVersionsListAllBuiltinsOptionalParams	Optional parameters.
PolicyDefinitionVersionsListAllOptionalParams	Optional parameters.
PolicyDefinitionVersionsListBuiltInOptionalParams	Optional parameters.
PolicyDefinitionVersionsListByManagementGroupOptionalParams	Optional parameters.
PolicyDefinitionVersionsListOptionalParams	Optional parameters.
PolicyDefinitionVersionsOperations	Interface representing a PolicyDefinitionVersions operations.
PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams	Optional parameters.
PolicyDefinitionsCreateOrUpdateOptionalParams	Optional parameters.
PolicyDefinitionsDeleteAtManagementGroupOptionalParams	Optional parameters.
PolicyDefinitionsDeleteOptionalParams	Optional parameters.
PolicyDefinitionsGetAtManagementGroupOptionalParams	Optional parameters.
PolicyDefinitionsGetBuiltInOptionalParams	Optional parameters.
PolicyDefinitionsGetOptionalParams	Optional parameters.
PolicyDefinitionsListBuiltInOptionalParams	Optional parameters.
PolicyDefinitionsListByManagementGroupOptionalParams	Optional parameters.
PolicyDefinitionsListOptionalParams	Optional parameters.
PolicyDefinitionsOperations	Interface representing a PolicyDefinitions operations.
PolicyLogInfo	The policy log info.
PolicySetDefinition	The policy set definition.
PolicySetDefinitionProperties	The policy set definition properties.
PolicySetDefinitionVersion	The policy set definition version.
PolicySetDefinitionVersionListResult	The response of a PolicySetDefinitionVersion list operation.
PolicySetDefinitionVersionProperties	The policy set definition properties.
PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams	Optional parameters.
PolicySetDefinitionVersionsCreateOrUpdateOptionalParams	Optional parameters.
PolicySetDefinitionVersionsDeleteAtManagementGroupOptionalParams	Optional parameters.
PolicySetDefinitionVersionsDeleteOptionalParams	Optional parameters.
PolicySetDefinitionVersionsGetAtManagementGroupOptionalParams	Optional parameters.
PolicySetDefinitionVersionsGetBuiltInOptionalParams	Optional parameters.
PolicySetDefinitionVersionsGetOptionalParams	Optional parameters.
PolicySetDefinitionVersionsListAllAtManagementGroupOptionalParams	Optional parameters.
PolicySetDefinitionVersionsListAllBuiltinsOptionalParams	Optional parameters.
PolicySetDefinitionVersionsListAllOptionalParams	Optional parameters.
PolicySetDefinitionVersionsListBuiltInOptionalParams	Optional parameters.
PolicySetDefinitionVersionsListByManagementGroupOptionalParams	Optional parameters.
PolicySetDefinitionVersionsListOptionalParams	Optional parameters.
PolicySetDefinitionVersionsOperations	Interface representing a PolicySetDefinitionVersions operations.
PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams	Optional parameters.
PolicySetDefinitionsCreateOrUpdateOptionalParams	Optional parameters.
PolicySetDefinitionsDeleteAtManagementGroupOptionalParams	Optional parameters.
PolicySetDefinitionsDeleteOptionalParams	Optional parameters.
PolicySetDefinitionsGetAtManagementGroupOptionalParams	Optional parameters.
PolicySetDefinitionsGetBuiltInOptionalParams	Optional parameters.
PolicySetDefinitionsGetOptionalParams	Optional parameters.
PolicySetDefinitionsListBuiltInOptionalParams	Optional parameters.
PolicySetDefinitionsListByManagementGroupOptionalParams	Optional parameters.
PolicySetDefinitionsListOptionalParams	Optional parameters.
PolicySetDefinitionsOperations	Interface representing a PolicySetDefinitions operations.
PolicyTokenEvaluatedRequestDetails	The policy token evaluated request details.
PolicyTokenOperation	The resource operation to acquire a token for.
PolicyTokenRequest	The policy token request properties.
PolicyTokenResponse	The policy token response properties.
PolicyTokensAcquireAtManagementGroupOptionalParams	Optional parameters.
PolicyTokensAcquireOptionalParams	Optional parameters.
PolicyTokensOperations	Interface representing a PolicyTokens operations.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceSelector	The resource selector to filter policies by resource properties.
ResourceTypeAliases	The resource type aliases definition.
Selector	The selector expression.
SelfServeExemptionSettings	The self-serve exemption settings for a policy assignment.
SystemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentitiesValue	model interface UserAssignedIdentitiesValue

Type Aliases

AliasPathAttributes	The attributes of the token that the alias path is referring to. KnownAliasPathAttributes can be used interchangeably with AliasPathAttributes, this enum contains the known values that the service supports. Known values supported by the service None: The token that the alias path is referring to has no attributes. Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect.
AliasPathTokenType	The type of the token that the alias path is referring to. KnownAliasPathTokenType can be used interchangeably with AliasPathTokenType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The token type is not specified. Any: The token type can be anything. String: The token type is string. Object: The token type is object. Array: The token type is array. Integer: The token type is integer. Number: The token type is number. Boolean: The token type is boolean.
AliasPatternType	The type of alias pattern.
AliasType	The type of the alias.
AssignmentType	The type of policy assignment. Possible values are NotSpecified, System, SystemHidden, and Custom. Immutable. KnownAssignmentType can be used interchangeably with AssignmentType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The not specified assignment type. System: The system assignment type. SystemHidden: The system hidden assignment type. Custom: The custom assignment type.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
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.
EnforcementMode	The policy assignment enforcement mode. Possible values are Default, DoNotEnforce, and Enroll KnownEnforcementMode can be used interchangeably with EnforcementMode, this enum contains the known values that the service supports. Known values supported by the service Default: The policy effect is enforced during resource creation or update. DoNotEnforce: The policy effect is not enforced during resource creation or update. Enroll: The policy effect is not enforced during resource creation or update until the resource or scope of the resource is enrolled to the assignment instance. Enrollment occurs upon deployment of the policy enrollment resource.
ExternalEndpointResult	The result of the external endpoint. Possible values are Succeeded and Failed. KnownExternalEndpointResult can be used interchangeably with ExternalEndpointResult, this enum contains the known values that the service supports. Known values supported by the service Succeeded: The external endpoint succeeded. Failed: The external endpoint failed.
OverrideKind	The override kind. KnownOverrideKind can be used interchangeably with OverrideKind, this enum contains the known values that the service supports. Known values supported by the service policyEffect: It will override the policy effect type. definitionVersion: It will override the definition version property value of the policy assignment.
ParameterType	The data type of the parameter. KnownParameterType can be used interchangeably with ParameterType, this enum contains the known values that the service supports. Known values supported by the service String: The string parameter type. Array: The array parameter type. Object: The object parameter type. Boolean: The boolean parameter type. Integer: The integer parameter type. Float: The float parameter type. DateTime: The date-time parameter type.
PolicyAction	The effective outcome of the policy evaluation based on both the policy effect and evaluation result. Possible values are Unknown, Allow, Audit, Deny, Error. KnownPolicyAction can be used interchangeably with PolicyAction, this enum contains the known values that the service supports. Known values supported by the service Unknown: The effective outcome of policy evaluation is unknown. Allow: The effective outcome of policy evaluation is to allow the request. Audit: The effective outcome of policy evaluation is to audit the request. Deny: The effective outcome of policy evaluation is to deny the request. Error: The policy evaluation resulted in an error.
PolicyTokenResult	The result of the completed token acquisition operation. Possible values are Succeeded and Failed. KnownPolicyTokenResult can be used interchangeably with PolicyTokenResult, this enum contains the known values that the service supports. Known values supported by the service Succeeded: The token acquisition succeeded. Failed: The token acquisition failed.
PolicyType	The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. KnownPolicyType can be used interchangeably with PolicyType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The not specified policy definition type. BuiltIn: The built in policy definition type. Custom: The custom policy definition type. Static: The static policy definition type.
ResourceIdentityType	The identity type. This is the only required field when adding a system or user assigned identity to a resource.
SelectorKind	The selector kind. KnownSelectorKind can be used interchangeably with SelectorKind, this enum contains the known values that the service supports. Known values supported by the service resourceLocation: The selector kind to filter policies by the resource location. resourceType: The selector kind to filter policies by the resource type. resourceWithoutLocation: The selector kind to filter policies by the resource without location. policyDefinitionReferenceId: The selector kind to filter policies by the policy definition reference ID. resourceRolloutPercentage: The selector kind to filter policies by the resource rollout percentage. userPrincipalId: The selector kind to filter policies by the user principal ID. groupPrincipalId: The selector kind to filter policies by the security group membership ID.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAliasPathAttributes	The attributes of the token that the alias path is referring to.
KnownAliasPathTokenType	The type of the token that the alias path is referring to.
KnownAssignmentType	The type of policy assignment. Possible values are NotSpecified, System, SystemHidden, and Custom. Immutable.
KnownCreatedByType	The kind of entity that created the resource.
KnownEnforcementMode	The policy assignment enforcement mode. Possible values are Default, DoNotEnforce, and Enroll
KnownExternalEndpointResult	The result of the external endpoint. Possible values are Succeeded and Failed.
KnownOverrideKind	The override kind.
KnownParameterType	The data type of the parameter.
KnownPolicyAction	The effective outcome of the policy evaluation based on both the policy effect and evaluation result. Possible values are Unknown, Allow, Audit, Deny, Error.
KnownPolicyTokenResult	The result of the completed token acquisition operation. Possible values are Succeeded and Failed.
KnownPolicyType	The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
KnownSelectorKind	The selector kind.
KnownVersions	The available API versions. The preview version (v2026_01_01_preview) includes everything from the latest stable version plus new preview-only resource types: PolicyExemption, Variable, VariableValue (marked with

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor