@azure/arm-policy package

Classes

PolicyClient

Interfaces

Alias	The alias type.
AliasPath	The type of the paths for alias.
AliasPathMetadata
AliasPattern	The type of the pattern for an alias path.
CloudError	An error response from a policy operation.
DataEffect	The data effect definition.
DataManifestCustomResourceFunctionDefinition	The custom resource function definition.
DataPolicyManifest	The data policy manifest.
DataPolicyManifestListResult	List of data policy manifests.
DataPolicyManifests	Interface representing a DataPolicyManifests.
DataPolicyManifestsGetByPolicyModeOptionalParams	Optional parameters.
DataPolicyManifestsListNextOptionalParams	Optional parameters.
DataPolicyManifestsListOptionalParams	Optional parameters.
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.
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
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.
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.
PolicyExemption	The policy exemption.
PolicyExemptionListResult	List of policy exemptions.
PolicyExemptions	Interface representing a PolicyExemptions.
PolicyExemptionsCreateOrUpdateOptionalParams	Optional parameters.
PolicyExemptionsDeleteOptionalParams	Optional parameters.
PolicyExemptionsGetOptionalParams	Optional parameters.
PolicyExemptionsListForManagementGroupNextOptionalParams	Optional parameters.
PolicyExemptionsListForManagementGroupOptionalParams	Optional parameters.
PolicyExemptionsListForResourceGroupNextOptionalParams	Optional parameters.
PolicyExemptionsListForResourceGroupOptionalParams	Optional parameters.
PolicyExemptionsListForResourceNextOptionalParams	Optional parameters.
PolicyExemptionsListForResourceOptionalParams	Optional parameters.
PolicyExemptionsListNextOptionalParams	Optional parameters.
PolicyExemptionsListOptionalParams	Optional parameters.
PolicySetDefinition	The policy set definition.
PolicySetDefinitionListResult	List of policy set definitions.
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.
ResourceTypeAliases	The resource type aliases definition.
SystemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentitiesValue

Type Aliases

AliasPathAttributes	Defines values for AliasPathAttributes. 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	Defines values for AliasPathTokenType. 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	Defines values for AliasPatternType.
AliasType	Defines values for AliasType.
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
DataPolicyManifestsGetByPolicyModeResponse	Contains response data for the getByPolicyMode operation.
DataPolicyManifestsListNextResponse	Contains response data for the listNext operation.
DataPolicyManifestsListResponse	Contains response data for the list operation.
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.
ExemptionCategory	Defines values for ExemptionCategory. KnownExemptionCategory can be used interchangeably with ExemptionCategory, this enum contains the known values that the service supports. Known values supported by the service Waiver: This category of exemptions usually means the scope is not applicable for the policy. Mitigated: This category of exemptions usually means the mitigation actions have been applied to the scope.
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.
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.
PolicyExemptionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PolicyExemptionsGetResponse	Contains response data for the get operation.
PolicyExemptionsListForManagementGroupNextResponse	Contains response data for the listForManagementGroupNext operation.
PolicyExemptionsListForManagementGroupResponse	Contains response data for the listForManagementGroup operation.
PolicyExemptionsListForResourceGroupNextResponse	Contains response data for the listForResourceGroupNext operation.
PolicyExemptionsListForResourceGroupResponse	Contains response data for the listForResourceGroup operation.
PolicyExemptionsListForResourceNextResponse	Contains response data for the listForResourceNext operation.
PolicyExemptionsListForResourceResponse	Contains response data for the listForResource operation.
PolicyExemptionsListNextResponse	Contains response data for the listNext operation.
PolicyExemptionsListResponse	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.

Enums

KnownAliasPathAttributes	Known values of AliasPathAttributes that the service accepts.
KnownAliasPathTokenType	Known values of AliasPathTokenType that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownEnforcementMode	Known values of EnforcementMode that the service accepts.
KnownExemptionCategory	Known values of ExemptionCategory that the service accepts.
KnownParameterType	Known values of ParameterType that the service accepts.
KnownPolicyType	Known values of PolicyType 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.