Share via

@azure/arm-policy package

  • Reference

Classes

PolicyClient

Interfaces

CloudError

An error response from a policy operation.
ErrorAdditionalInfo

The resource management error additional info.
ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)
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.
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.
PolicyAssignmentListResult

List of policy assignments.
PolicyAssignmentUpdate

The policy assignment for Patch request.
PolicyAssignments

Interface representing a PolicyAssignments.
PolicyAssignmentsCreateByIdOptionalParams

Optional parameters.
PolicyAssignmentsCreateOptionalParams

Optional parameters.
PolicyAssignmentsDeleteByIdOptionalParams

Optional parameters.
PolicyAssignmentsDeleteOptionalParams

Optional parameters.
PolicyAssignmentsGetByIdOptionalParams

Optional parameters.
PolicyAssignmentsGetOptionalParams

Optional parameters.
PolicyAssignmentsListForManagementGroupNextOptionalParams

Optional parameters.
PolicyAssignmentsListForManagementGroupOptionalParams

Optional parameters.
PolicyAssignmentsListForResourceGroupNextOptionalParams

Optional parameters.
PolicyAssignmentsListForResourceGroupOptionalParams

Optional parameters.
PolicyAssignmentsListForResourceNextOptionalParams

Optional parameters.
PolicyAssignmentsListForResourceOptionalParams

Optional parameters.
PolicyAssignmentsListNextOptionalParams

Optional parameters.
PolicyAssignmentsListOptionalParams

Optional parameters.
PolicyAssignmentsUpdateByIdOptionalParams

Optional parameters.
PolicyAssignmentsUpdateOptionalParams

Optional parameters.
PolicyClientOptionalParams

Optional parameters.
PolicyDefinition

The policy definition.
PolicyDefinitionGroup

The policy definition group.
PolicyDefinitionListResult

List of policy definitions.
PolicyDefinitionReference

The policy definition reference.
PolicyDefinitionVersion

The ID of the policy definition version.
PolicyDefinitionVersionListResult

List of policy definition versions.
PolicyDefinitionVersions

Interface representing a PolicyDefinitionVersions.
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.
PolicyDefinitionVersionsListBuiltInNextOptionalParams

Optional parameters.
PolicyDefinitionVersionsListBuiltInOptionalParams

Optional parameters.
PolicyDefinitionVersionsListByManagementGroupNextOptionalParams

Optional parameters.
PolicyDefinitionVersionsListByManagementGroupOptionalParams

Optional parameters.
PolicyDefinitionVersionsListNextOptionalParams

Optional parameters.
PolicyDefinitionVersionsListOptionalParams

Optional parameters.
PolicyDefinitions

Interface representing a PolicyDefinitions.
PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Optional parameters.
PolicyDefinitionsCreateOrUpdateOptionalParams

Optional parameters.
PolicyDefinitionsDeleteAtManagementGroupOptionalParams

Optional parameters.
PolicyDefinitionsDeleteOptionalParams

Optional parameters.
PolicyDefinitionsGetAtManagementGroupOptionalParams

Optional parameters.
PolicyDefinitionsGetBuiltInOptionalParams

Optional parameters.
PolicyDefinitionsGetOptionalParams

Optional parameters.
PolicyDefinitionsListBuiltInNextOptionalParams

Optional parameters.
PolicyDefinitionsListBuiltInOptionalParams

Optional parameters.
PolicyDefinitionsListByManagementGroupNextOptionalParams

Optional parameters.
PolicyDefinitionsListByManagementGroupOptionalParams

Optional parameters.
PolicyDefinitionsListNextOptionalParams

Optional parameters.
PolicyDefinitionsListOptionalParams

Optional parameters.
PolicySetDefinition

The policy set definition.
PolicySetDefinitionListResult

List of policy set definitions.
PolicySetDefinitionVersion

The policy set definition version.
PolicySetDefinitionVersionListResult

List of policy set definition versions.
PolicySetDefinitionVersions

Interface representing a PolicySetDefinitionVersions.
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.
PolicySetDefinitionVersionsListBuiltInNextOptionalParams

Optional parameters.
PolicySetDefinitionVersionsListBuiltInOptionalParams

Optional parameters.
PolicySetDefinitionVersionsListByManagementGroupNextOptionalParams

Optional parameters.
PolicySetDefinitionVersionsListByManagementGroupOptionalParams

Optional parameters.
PolicySetDefinitionVersionsListNextOptionalParams

Optional parameters.
PolicySetDefinitionVersionsListOptionalParams

Optional parameters.
PolicySetDefinitions

Interface representing a PolicySetDefinitions.
PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Optional parameters.
PolicySetDefinitionsCreateOrUpdateOptionalParams

Optional parameters.
PolicySetDefinitionsDeleteAtManagementGroupOptionalParams

Optional parameters.
PolicySetDefinitionsDeleteOptionalParams

Optional parameters.
PolicySetDefinitionsGetAtManagementGroupOptionalParams

Optional parameters.
PolicySetDefinitionsGetBuiltInOptionalParams

Optional parameters.
PolicySetDefinitionsGetOptionalParams

Optional parameters.
PolicySetDefinitionsListBuiltInNextOptionalParams

Optional parameters.
PolicySetDefinitionsListBuiltInOptionalParams

Optional parameters.
PolicySetDefinitionsListByManagementGroupNextOptionalParams

Optional parameters.
PolicySetDefinitionsListByManagementGroupOptionalParams

Optional parameters.
PolicySetDefinitionsListNextOptionalParams

Optional parameters.
PolicySetDefinitionsListOptionalParams

Optional parameters.
ResourceSelector

The resource selector to filter policies by resource properties.
Selector

The selector expression.
SystemData

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

Type Aliases

AssignmentType

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

Known values supported by the service

NotSpecified
System
SystemHidden
Custom
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
EnforcementMode

Defines values for EnforcementMode.
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.
OverrideKind

Defines values for OverrideKind.
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

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

Known values supported by the service

String
Array
Object
Boolean
Integer
Float
DateTime
PolicyAssignmentsCreateByIdResponse

Contains response data for the createById operation.
PolicyAssignmentsCreateResponse

Contains response data for the create operation.
PolicyAssignmentsDeleteByIdResponse

Contains response data for the deleteById operation.
PolicyAssignmentsDeleteResponse

Contains response data for the delete operation.
PolicyAssignmentsGetByIdResponse

Contains response data for the getById operation.
PolicyAssignmentsGetResponse

Contains response data for the get operation.
PolicyAssignmentsListForManagementGroupNextResponse

Contains response data for the listForManagementGroupNext operation.
PolicyAssignmentsListForManagementGroupResponse

Contains response data for the listForManagementGroup operation.
PolicyAssignmentsListForResourceGroupNextResponse

Contains response data for the listForResourceGroupNext operation.
PolicyAssignmentsListForResourceGroupResponse

Contains response data for the listForResourceGroup operation.
PolicyAssignmentsListForResourceNextResponse

Contains response data for the listForResourceNext operation.
PolicyAssignmentsListForResourceResponse

Contains response data for the listForResource operation.
PolicyAssignmentsListNextResponse

Contains response data for the listNext operation.
PolicyAssignmentsListResponse

Contains response data for the list operation.
PolicyAssignmentsUpdateByIdResponse

Contains response data for the updateById operation.
PolicyAssignmentsUpdateResponse

Contains response data for the update operation.
PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupResponse

Contains response data for the createOrUpdateAtManagementGroup operation.
PolicyDefinitionVersionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
PolicyDefinitionVersionsGetAtManagementGroupResponse

Contains response data for the getAtManagementGroup operation.
PolicyDefinitionVersionsGetBuiltInResponse

Contains response data for the getBuiltIn operation.
PolicyDefinitionVersionsGetResponse

Contains response data for the get operation.
PolicyDefinitionVersionsListAllAtManagementGroupResponse

Contains response data for the listAllAtManagementGroup operation.
PolicyDefinitionVersionsListAllBuiltinsResponse

Contains response data for the listAllBuiltins operation.
PolicyDefinitionVersionsListAllResponse

Contains response data for the listAll operation.
PolicyDefinitionVersionsListBuiltInNextResponse

Contains response data for the listBuiltInNext operation.
PolicyDefinitionVersionsListBuiltInResponse

Contains response data for the listBuiltIn operation.
PolicyDefinitionVersionsListByManagementGroupNextResponse

Contains response data for the listByManagementGroupNext operation.
PolicyDefinitionVersionsListByManagementGroupResponse

Contains response data for the listByManagementGroup operation.
PolicyDefinitionVersionsListNextResponse

Contains response data for the listNext operation.
PolicyDefinitionVersionsListResponse

Contains response data for the list operation.
PolicyDefinitionsCreateOrUpdateAtManagementGroupResponse

Contains response data for the createOrUpdateAtManagementGroup operation.
PolicyDefinitionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
PolicyDefinitionsGetAtManagementGroupResponse

Contains response data for the getAtManagementGroup operation.
PolicyDefinitionsGetBuiltInResponse

Contains response data for the getBuiltIn operation.
PolicyDefinitionsGetResponse

Contains response data for the get operation.
PolicyDefinitionsListBuiltInNextResponse

Contains response data for the listBuiltInNext operation.
PolicyDefinitionsListBuiltInResponse

Contains response data for the listBuiltIn operation.
PolicyDefinitionsListByManagementGroupNextResponse

Contains response data for the listByManagementGroupNext operation.
PolicyDefinitionsListByManagementGroupResponse

Contains response data for the listByManagementGroup operation.
PolicyDefinitionsListNextResponse

Contains response data for the listNext operation.
PolicyDefinitionsListResponse

Contains response data for the list operation.
PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupResponse

Contains response data for the createOrUpdateAtManagementGroup operation.
PolicySetDefinitionVersionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
PolicySetDefinitionVersionsGetAtManagementGroupResponse

Contains response data for the getAtManagementGroup operation.
PolicySetDefinitionVersionsGetBuiltInResponse

Contains response data for the getBuiltIn operation.
PolicySetDefinitionVersionsGetResponse

Contains response data for the get operation.
PolicySetDefinitionVersionsListAllAtManagementGroupResponse

Contains response data for the listAllAtManagementGroup operation.
PolicySetDefinitionVersionsListAllBuiltinsResponse

Contains response data for the listAllBuiltins operation.
PolicySetDefinitionVersionsListAllResponse

Contains response data for the listAll operation.
PolicySetDefinitionVersionsListBuiltInNextResponse

Contains response data for the listBuiltInNext operation.
PolicySetDefinitionVersionsListBuiltInResponse

Contains response data for the listBuiltIn operation.
PolicySetDefinitionVersionsListByManagementGroupNextResponse

Contains response data for the listByManagementGroupNext operation.
PolicySetDefinitionVersionsListByManagementGroupResponse

Contains response data for the listByManagementGroup operation.
PolicySetDefinitionVersionsListNextResponse

Contains response data for the listNext operation.
PolicySetDefinitionVersionsListResponse

Contains response data for the list operation.
PolicySetDefinitionsCreateOrUpdateAtManagementGroupResponse

Contains response data for the createOrUpdateAtManagementGroup operation.
PolicySetDefinitionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
PolicySetDefinitionsGetAtManagementGroupResponse

Contains response data for the getAtManagementGroup operation.
PolicySetDefinitionsGetBuiltInResponse

Contains response data for the getBuiltIn operation.
PolicySetDefinitionsGetResponse

Contains response data for the get operation.
PolicySetDefinitionsListBuiltInNextResponse

Contains response data for the listBuiltInNext operation.
PolicySetDefinitionsListBuiltInResponse

Contains response data for the listBuiltIn operation.
PolicySetDefinitionsListByManagementGroupNextResponse

Contains response data for the listByManagementGroupNext operation.
PolicySetDefinitionsListByManagementGroupResponse

Contains response data for the listByManagementGroup operation.
PolicySetDefinitionsListNextResponse

Contains response data for the listNext operation.
PolicySetDefinitionsListResponse

Contains response data for the list operation.
PolicyType

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

Known values supported by the service

NotSpecified
BuiltIn
Custom
Static
ResourceIdentityType

Defines values for ResourceIdentityType.
SelectorKind

Defines values for SelectorKind.
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.

Enums

KnownAssignmentType

Known values of AssignmentType that the service accepts.
KnownCreatedByType

Known values of CreatedByType that the service accepts.
KnownEnforcementMode

Known values of EnforcementMode that the service accepts.
KnownOverrideKind

Known values of OverrideKind that the service accepts.
KnownParameterType

Known values of ParameterType that the service accepts.
KnownPolicyType

Known values of PolicyType that the service accepts.
KnownSelectorKind

Known values of SelectorKind that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.