@azure/arm-policy package

Klassen

PolicyClient

Interfaces

Alias

Het aliastype.

AliasPath

Het type paden voor alias.

AliasPathMetadata

De metadata van het alias pad.

AliasPattern

Het type van het patroon voor een aliaspad.

DataEffect

De definitie van het gegevenseffect.

DataManifestCustomResourceFunctionDefinition

De definitie van de aangepaste resourcefunctie.

DataManifestResourceFunctionsDefinition

De resourcefuncties die worden ondersteund door een manifest.

DataPolicyManifest

Het manifest van het gegevensbeleid.

DataPolicyManifestProperties

De eigenschappen van het databeleid manifesteren zich.

DataPolicyManifestsGetByPolicyModeOptionalParams

Optionele parameters.

DataPolicyManifestsListOptionalParams

Optionele parameters.

DataPolicyManifestsOperations

Interface die een DataPolicyManifests-operaties vertegenwoordigt.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen.

ExtensionResource

De bron voor basisextensie.

ExternalEvaluationEndpointInvocationResult

De externe evaluatie-endpoint-aanroep resulteert.

ExternalEvaluationEndpointSettings

De instellingen van een extern eindpunt met evaluatieresultaten.

ExternalEvaluationEnforcementSettings

De details van de bron van externe evaluatieresultaten die door het beleid tijdens de evaluatie van de handhaving zijn vereist.

Identity

Identiteit voor de resource. Beleidstoewijzingen ondersteunen maximaal één identiteit. Dat is een door het systeem toegewezen identiteit of één door de gebruiker toegewezen identiteit.

NonComplianceMessage

Een bericht waarin wordt beschreven waarom een resource niet compatibel is met het beleid. Dit wordt weergegeven in foutberichten 'weigeren' en in de niet-compatibele nalevingsresultaten van de resource.

Override

De waarde van de beleidseigenschap wordt overschreven.

PageSettings

Opties voor de methode byPage

PagedAsyncIterableIterator

Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.

ParameterDefinitionsValue

De definitie van een parameter die aan het beleid kan worden verstrekt.

ParameterDefinitionsValueMetadata

Algemene metagegevens voor de parameter.

ParameterValuesValue

De waarde van een parameter.

PolicyAssignment

De beleidstoewijzing.

PolicyAssignmentProperties

De polisoverdrachtseigenschappen.

PolicyAssignmentUpdate

De beleidstoewijzing voor Patch-aanvraag.

PolicyAssignmentUpdateProperties

De beleidstoewijzingseigenschappen voor Patch-verzoek.

PolicyAssignmentsCreateOptionalParams

Optionele parameters.

PolicyAssignmentsDeleteOptionalParams

Optionele parameters.

PolicyAssignmentsGetOptionalParams

Optionele parameters.

PolicyAssignmentsListForManagementGroupOptionalParams

Optionele parameters.

PolicyAssignmentsListForResourceGroupOptionalParams

Optionele parameters.

PolicyAssignmentsListForResourceOptionalParams

Optionele parameters.

PolicyAssignmentsListOptionalParams

Optionele parameters.

PolicyAssignmentsOperations

Interface die een PolicyAssignments-operatie vertegenwoordigt.

PolicyAssignmentsUpdateOptionalParams

Optionele parameters.

PolicyClientOptionalParams

Optionele parameters voor de client.

PolicyDefinition

De beleidsdefinitie.

PolicyDefinitionGroup

De beleidsdefinitiegroep.

PolicyDefinitionProperties

De eigenschappen van de beleidsdefinitie.

PolicyDefinitionReference

De verwijzing naar de beleidsdefinitie.

PolicyDefinitionVersion

De id van de beleidsdefinitieversie.

PolicyDefinitionVersionListResult

De respons van een PolicyDefinitionVersion-lijstoperatie.

PolicyDefinitionVersionProperties

De eigenschappen van de beleidsdefinitie.

PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams

Optionele parameters.

PolicyDefinitionVersionsCreateOrUpdateOptionalParams

Optionele parameters.

PolicyDefinitionVersionsDeleteAtManagementGroupOptionalParams

Optionele parameters.

PolicyDefinitionVersionsDeleteOptionalParams

Optionele parameters.

PolicyDefinitionVersionsGetAtManagementGroupOptionalParams

Optionele parameters.

PolicyDefinitionVersionsGetBuiltInOptionalParams

Optionele parameters.

PolicyDefinitionVersionsGetOptionalParams

Optionele parameters.

PolicyDefinitionVersionsListAllAtManagementGroupOptionalParams

Optionele parameters.

PolicyDefinitionVersionsListAllBuiltinsOptionalParams

Optionele parameters.

PolicyDefinitionVersionsListAllOptionalParams

Optionele parameters.

PolicyDefinitionVersionsListBuiltInOptionalParams

Optionele parameters.

PolicyDefinitionVersionsListByManagementGroupOptionalParams

Optionele parameters.

PolicyDefinitionVersionsListOptionalParams

Optionele parameters.

PolicyDefinitionVersionsOperations

Interface die een PolicyDefinitionVersions-operatie vertegenwoordigt.

PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Optionele parameters.

PolicyDefinitionsCreateOrUpdateOptionalParams

Optionele parameters.

PolicyDefinitionsDeleteAtManagementGroupOptionalParams

Optionele parameters.

PolicyDefinitionsDeleteOptionalParams

Optionele parameters.

PolicyDefinitionsGetAtManagementGroupOptionalParams

Optionele parameters.

PolicyDefinitionsGetBuiltInOptionalParams

Optionele parameters.

PolicyDefinitionsGetOptionalParams

Optionele parameters.

PolicyDefinitionsListBuiltInOptionalParams

Optionele parameters.

PolicyDefinitionsListByManagementGroupOptionalParams

Optionele parameters.

PolicyDefinitionsListOptionalParams

Optionele parameters.

PolicyDefinitionsOperations

Interface die een PolicyDefinitions-operatie vertegenwoordigt.

PolicyLogInfo

De informatie over het polislogboek.

PolicySetDefinition

De definitie van de beleidsset.

PolicySetDefinitionProperties

De definitie-eigenschappen van de beleidsset.

PolicySetDefinitionVersion

De definitieversie van de beleidsset.

PolicySetDefinitionVersionListResult

De respons van een PolicySetDefinitionVersion-lijstoperatie.

PolicySetDefinitionVersionProperties

De definitie-eigenschappen van de beleidsset.

PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsCreateOrUpdateOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsDeleteAtManagementGroupOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsDeleteOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsGetAtManagementGroupOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsGetBuiltInOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsGetOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsListAllAtManagementGroupOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsListAllBuiltinsOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsListAllOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsListBuiltInOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsListByManagementGroupOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsListOptionalParams

Optionele parameters.

PolicySetDefinitionVersionsOperations

Interface die een PolicySetDefinitionVersions-operatie vertegenwoordigt.

PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Optionele parameters.

PolicySetDefinitionsCreateOrUpdateOptionalParams

Optionele parameters.

PolicySetDefinitionsDeleteAtManagementGroupOptionalParams

Optionele parameters.

PolicySetDefinitionsDeleteOptionalParams

Optionele parameters.

PolicySetDefinitionsGetAtManagementGroupOptionalParams

Optionele parameters.

PolicySetDefinitionsGetBuiltInOptionalParams

Optionele parameters.

PolicySetDefinitionsGetOptionalParams

Optionele parameters.

PolicySetDefinitionsListBuiltInOptionalParams

Optionele parameters.

PolicySetDefinitionsListByManagementGroupOptionalParams

Optionele parameters.

PolicySetDefinitionsListOptionalParams

Optionele parameters.

PolicySetDefinitionsOperations

Interface die een PolicySetDefinitions-operaties vertegenwoordigt.

PolicyTokenEvaluatedRequestDetails

Het beleidstoken evalueerde de verzoekdetails.

PolicyTokenOperation

De resource-operatie om een token voor te verkrijgen.

PolicyTokenRequest

De eigenschappen van het beleidstokenverzoek.

PolicyTokenResponse

De beleidstokenrespons-eigenschappen.

PolicyTokensAcquireAtManagementGroupOptionalParams

Optionele parameters.

PolicyTokensAcquireOptionalParams

Optionele parameters.

PolicyTokensOperations

Interface die een PolicyTokens-operatie vertegenwoordigt.

ProxyResource

De definitie van het resourcemodel voor een Azure Resource Manager-proxyresource. Het heeft geen tags en een locatie

Resource

Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources

ResourceSelector

De resourceselector voor het filteren van beleidsregels op resource-eigenschappen.

ResourceTypeAliases

De definitie van de alias van het resourcetype.

Selector

De selector-expressie.

SelfServeExemptionSettings

De instellingen voor zelfbedieningsvrijstelling voor een polisopdracht.

SystemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

UserAssignedIdentitiesValue

modelinterface UserAssignedIdentitiesValue

Type-aliassen

AliasPathAttributes

De kenmerken van het token waarnaar het aliaspad verwijst.
KnownAliasPathAttributes kunnen door elkaar worden gebruikt met AliasPathAttributes, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Geen: het token waarnaar het aliaspad verwijst, heeft geen kenmerken.
wijzigbare: het token waarnaar het aliaspad verwijst, kan worden gewijzigd door beleid met het effect Wijzigen.

AliasPathTokenType

Het type token waarnaar het aliaspad verwijst.
KnownAliasPathTokenType kan door elkaar worden gebruikt met AliasPathTokenType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

NotSpecified: het tokentype is niet opgegeven.
Elk: het tokentype kan van alles zijn.
tekenreeks: het tokentype is tekenreeks.
Object: het tokentype is object.
matrix: het tokentype is matrix.
geheel getal: het tokentype is een geheel getal.
getal: het tokentype is getal.
Booleaanse: het tokentype is booleaanse waarde.

AliasPatternType

Het type alias-patroon.

AliasType

Het type alias.

AssignmentType

Het type beleidstoewijzing. Mogelijke waarden zijn NotSpecified, System, SystemHidden en Custom. Onveranderlijk.
KnownAssignmentType kan door elkaar worden gebruikt met AssignmentType, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

NotSpecificified: Het niet gespecificeerde toewijzingstype.
Systeem: Het type systeemtoewijzing.
SystemHidden: Het type verborgen toewijzing van het systeem.
Aangepast: Het type aangepaste opdracht.

AzureSupportedClouds

De ondersteunde waarden voor cloudinstelling als een letterlijk tekenreekstype

ContinuablePage

Een interface die een pagina met resultaten beschrijft.

CreatedByType

Het type entiteit dat de resource heeft gemaakt.
KnownCreatedByType kan door elkaar worden gebruikt met CreatedByType, bevat deze enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Gebruiker: de entiteit is gemaakt door een gebruiker.
application: de entiteit is gemaakt door een toepassing.
ManagedIdentity-: de entiteit is gemaakt door een beheerde identiteit.
Sleutel: de entiteit is gemaakt door een sleutel.

EnforcementMode

De afdwingingsmodus voor beleidstoewijzing. Mogelijke waarden zijn Default, DoNotEnforcement en Enroll
KnownEnforcementMode kan door elkaar worden gebruikt met EnforcementMode, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

standaard: het beleidseffect wordt afgedwongen tijdens het maken of bijwerken van resources.
DoNotEnforce-: het beleidseffect wordt niet afgedwongen tijdens het maken of bijwerken van resources.
Inschrijven: Het beleidseffect wordt niet afgedwongen tijdens het aanmaken of updaten van een resource totdat de resource of scope van de resource is ingeschreven in de toewijzingsinstantie. Inschrijving vindt plaats bij de inzet van de beleidsinschrijvingsbron.

ExternalEndpointResult

Het resultaat van het externe eindpunt. Mogelijke waarden zijn Geslaagd en Mislukt.
KnownExternalEndpointResult kan door elkaar worden gebruikt met ExternalEndpointResult; deze enum bevat de bekende waarden die de dienst ondersteunt.

Bekende waarden die door de service worden ondersteund

Geslaagd: Het externe eindpunt is geslaagd.
Mislukt: Het externe eindpunt faalde.

OverrideKind

Het onderdrukkingstype.
KnownOverrideKind kan door elkaar worden gebruikt met OverrideKind. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

policyEffect: het beleidseffecttype wordt overschreven.
definitionVersion: de waarde van de definition version-eigenschap van de beleidstoewijzing wordt overschreven.

ParameterType

Het gegevenstype van de parameter.
KnownParameterType kan door elkaar worden gebruikt met ParameterType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

String: Het type stringparameter.
Array: Het type arrayparameter.
Object: Het type objectparameter.
Booleaans: Het type booleaanse parameter.
Integer: Het type gehele parameter.
Float: Het type floatparameter.
DateTime: Het type datum-tijdparameter.

PolicyAction

Het effectieve resultaat van de beleidsevaluatie is gebaseerd op zowel het beleidseffect als het evaluatieresultaat. Mogelijke waarden zijn Onbekend, Toestaan, Controleren, Weigeren, Fout.
KnownPolicyAction kan door elkaar worden gebruikt met PolicyAction; dit enum bevat de bekende waarden die de dienst ondersteunt.

Bekende waarden die door de service worden ondersteund

Onbekend: Het effectieve resultaat van beleidsevaluatie is onbekend.
Toestaan: Het effectieve resultaat van beleidsevaluatie is het toestaan van het verzoek.
Audit: Het effectieve resultaat van beleidsevaluatie is het auditen van het verzoek.
Weigeren: Het effectieve resultaat van beleidsevaluatie is het afwijzen van het verzoek.
Fout: De beleidsevaluatie resulteerde in een fout.

PolicyTokenResult

Het resultaat van de voltooide tokenacquisitie. Mogelijke waarden zijn Geslaagd en Mislukt.
KnownPolicyTokenResult kan door elkaar worden gebruikt met PolicyTokenResult; deze enum bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Geslaagd: De tokenovername is geslaagd.
Mislukt: De token-acquisitie mislukte.

PolicyType

Het type beleidsdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.
KnownPolicyType kan door elkaar worden gebruikt met PolicyType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

NotSpecificed: Het niet-gespecificeerde type beleidsdefinitie.
BuiltIn: Het ingebouwde type beleidsdefinitie.
Aangepast: Het type aangepaste polisdefinitie.
Statisch: Het type statische beleidsdefinitie.

ResourceIdentityType

Het identiteitstype. Dit is het enige vereiste veld bij het toevoegen van een door het systeem of de gebruiker toegewezen identiteit aan een resource.

SelectorKind

De soort selector.
KnownSelectorKind kan door elkaar worden gebruikt met SelectorKind, deze enum bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

resourceLocation: het type selector voor het filteren van beleid op de resourcelocatie.
resourceType: het type selector om beleidsregels te filteren op het resourcetype.
resourceWithoutLocation: het type selector om beleid te filteren op de resource zonder locatie.
policyDefinitionReferenceId: het type selector voor het filteren van beleid op basis van de referentie-id van de beleidsdefinitie.
resourceRolloutPercentage: Het selectortype om beleid te filteren op het percentage van resource-uitrol.
userPrincipalId: Het selectortype om beleidsregels te filteren op de user principal ID.
groupPrincipalId: Het selectortype om beleid te filteren op de beveiligingsgroeplidmaatschaps-ID.

Enums

AzureClouds

Een enum om Azure Cloud-omgevingen te beschrijven.

KnownAliasPathAttributes

De kenmerken van het token waarnaar het aliaspad verwijst.

KnownAliasPathTokenType

Het type token waarnaar het aliaspad verwijst.

KnownAssignmentType

Het type beleidstoewijzing. Mogelijke waarden zijn NotSpecified, System, SystemHidden en Custom. Onveranderlijk.

KnownCreatedByType

Het type entiteit dat de resource heeft gemaakt.

KnownEnforcementMode

De afdwingingsmodus voor beleidstoewijzing. Mogelijke waarden zijn Standaard, DoNotEnforce en Inschrijven

KnownExternalEndpointResult

Het resultaat van het externe eindpunt. Mogelijke waarden zijn Geslaagd en Mislukt.

KnownOverrideKind

Het onderdrukkingstype.

KnownParameterType

Het gegevenstype van de parameter.

KnownPolicyAction

Het effectieve resultaat van de beleidsevaluatie is gebaseerd op zowel het beleidseffect als het evaluatieresultaat. Mogelijke waarden zijn Onbekend, Toestaan, Controleren, Weigeren, Fout.

KnownPolicyTokenResult

Het resultaat van de voltooide tokenacquisitie. Mogelijke waarden zijn Geslaagd en Mislukt.

KnownPolicyType

Het type beleidsdefinitie. Mogelijke waarden zijn NotSpecified, BuiltIn, Custom en Static.

KnownSelectorKind

De soort selector.

KnownVersions

De beschikbare API-versies.

De previewversie (v2026_01_01_preview) bevat alles van de nieuwste stabiele versie plus nieuwe preview-only brontypen:

  • PolicyExemption, Variabele, VariabeleWaarde (gemarkeerd met

Functies

isRestError(unknown)

Typeguard voor RestError

Variabelen

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

Functiedetails

isRestError(unknown)

Typeguard voor RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Iets betrapt door een catch-component.

Retouren

e is RestError

Variabele details

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

RestError: RestErrorConstructor

Type