@azure/arm-policy package

Klasser

PolicyClient

Gränssnitt

Alias

Aliastypen.
AliasPath

Typ av sökvägar för alias.
AliasPathMetadata

Metadata för aliasvägen.
AliasPattern

Typ av mönster för en aliassökväg.
DataEffect

Dataeffektdefinitionen.
DataManifestCustomResourceFunctionDefinition

Den anpassade resursfunktionsdefinitionen.
DataManifestResourceFunctionsDefinition

Resursfunktionerna stöds av ett manifest.
DataPolicyManifest

Dataprincipmanifestet.
DataPolicyManifestProperties

Egenskaperna hos datapolicyn manifesteras.
DataPolicyManifestsGetByPolicyModeOptionalParams

Valfria parametrar.
DataPolicyManifestsListOptionalParams

Valfria parametrar.
DataPolicyManifestsOperations

Gränssnitt som representerar en DataPolicyManifests-operation.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder.
ExtensionResource

Den grundläggande tilläggsresursen.
ExternalEvaluationEndpointInvocationResult

Den externa utvärderingsändpunktsinkallelsen resultat.
ExternalEvaluationEndpointSettings

Inställningarna för en extern slutpunkt som ger utvärderingsresultat.
ExternalEvaluationEnforcementSettings

Information om källan till externa utvärderingsresultat som krävs av principen under tvingande utvärdering.
Identity

Identitet för resursen. Principtilldelningar stöder högst en identitet. Det är antingen en systemtilldelad identitet eller en enda användartilldelad identitet.
NonComplianceMessage

Ett meddelande som beskriver varför en resurs inte är kompatibel med principen. Detta visas i felmeddelanden om neka och på resursens icke-kompatibla efterlevnadsresultat.
Override

Åsidosättning av principegenskapsvärdet.
PageSettings

Alternativ för byPage-metoden
PagedAsyncIterableIterator

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.
ParameterDefinitionsValue

Definitionen av en parameter som kan anges för principen.
ParameterDefinitionsValueMetadata

Allmänna metadata för parametern.
ParameterValuesValue

Värdet för en parameter.
PolicyAssignment

Principtilldelningen.
PolicyAssignmentProperties

Policyöverlåtelseegenskaperna.
PolicyAssignmentUpdate

Principtilldelningen för Patch-begäran.
PolicyAssignmentUpdateProperties

Policytilldelningsegenskaperna för patchförfrågan.
PolicyAssignmentsCreateOptionalParams

Valfria parametrar.
PolicyAssignmentsDeleteOptionalParams

Valfria parametrar.
PolicyAssignmentsGetOptionalParams

Valfria parametrar.
PolicyAssignmentsListForManagementGroupOptionalParams

Valfria parametrar.
PolicyAssignmentsListForResourceGroupOptionalParams

Valfria parametrar.
PolicyAssignmentsListForResourceOptionalParams

Valfria parametrar.
PolicyAssignmentsListOptionalParams

Valfria parametrar.
PolicyAssignmentsOperations

Gränssnitt som representerar en PolicyAssignments-operation.
PolicyAssignmentsUpdateOptionalParams

Valfria parametrar.
PolicyClientOptionalParams

Valfria parametrar för klienten.
PolicyDefinition

Principdefinitionen.
PolicyDefinitionGroup

Principdefinitionsgruppen.
PolicyDefinitionProperties

Egenskaperna för principdefinitionen.
PolicyDefinitionReference

Referensen för principdefinitionen.
PolicyDefinitionVersion

ID för principdefinitionsversionen.
PolicyDefinitionVersionListResult

Svaret från en PolicyDefinitionVersion listoperation.
PolicyDefinitionVersionProperties

Egenskaperna för principdefinitionen.
PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsCreateOrUpdateOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsDeleteAtManagementGroupOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsDeleteOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsGetAtManagementGroupOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsGetBuiltInOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsGetOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsListAllAtManagementGroupOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsListAllBuiltinsOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsListAllOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsListBuiltInOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsListByManagementGroupOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsListOptionalParams

Valfria parametrar.
PolicyDefinitionVersionsOperations

Gränssnitt som representerar en PolicyDefinitionVersions-operation.
PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Valfria parametrar.
PolicyDefinitionsCreateOrUpdateOptionalParams

Valfria parametrar.
PolicyDefinitionsDeleteAtManagementGroupOptionalParams

Valfria parametrar.
PolicyDefinitionsDeleteOptionalParams

Valfria parametrar.
PolicyDefinitionsGetAtManagementGroupOptionalParams

Valfria parametrar.
PolicyDefinitionsGetBuiltInOptionalParams

Valfria parametrar.
PolicyDefinitionsGetOptionalParams

Valfria parametrar.
PolicyDefinitionsListBuiltInOptionalParams

Valfria parametrar.
PolicyDefinitionsListByManagementGroupOptionalParams

Valfria parametrar.
PolicyDefinitionsListOptionalParams

Valfria parametrar.
PolicyDefinitionsOperations

Gränssnitt som representerar en PolicyDefinitions-operation.
PolicyLogInfo

Infon om policyloggen.
PolicySetDefinition

Principuppsättningsdefinitionen.
PolicySetDefinitionProperties

Definitionsegenskaperna för principuppsättningen.
PolicySetDefinitionVersion

Definitionsversionen för principuppsättningen.
PolicySetDefinitionVersionListResult

Svaret på en PolicySetDefinitionVersion-listoperation.
PolicySetDefinitionVersionProperties

Definitionsegenskaperna för principuppsättningen.
PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsCreateOrUpdateOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsDeleteAtManagementGroupOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsDeleteOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsGetAtManagementGroupOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsGetBuiltInOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsGetOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsListAllAtManagementGroupOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsListAllBuiltinsOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsListAllOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsListBuiltInOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsListByManagementGroupOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsListOptionalParams

Valfria parametrar.
PolicySetDefinitionVersionsOperations

Gränssnitt som representerar en PolicySetDefinitionVersions-operation.
PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

Valfria parametrar.
PolicySetDefinitionsCreateOrUpdateOptionalParams

Valfria parametrar.
PolicySetDefinitionsDeleteAtManagementGroupOptionalParams

Valfria parametrar.
PolicySetDefinitionsDeleteOptionalParams

Valfria parametrar.
PolicySetDefinitionsGetAtManagementGroupOptionalParams

Valfria parametrar.
PolicySetDefinitionsGetBuiltInOptionalParams

Valfria parametrar.
PolicySetDefinitionsGetOptionalParams

Valfria parametrar.
PolicySetDefinitionsListBuiltInOptionalParams

Valfria parametrar.
PolicySetDefinitionsListByManagementGroupOptionalParams

Valfria parametrar.
PolicySetDefinitionsListOptionalParams

Valfria parametrar.
PolicySetDefinitionsOperations

Gränssnitt som representerar en PolicySetDefinitions-operation.
PolicyTokenEvaluatedRequestDetails

Policy token utvärderade förfrågningsdetaljer.
PolicyTokenOperation

Resursoperationen för att skaffa en token för.
PolicyTokenRequest

Policytoken-begärandets egenskaper.
PolicyTokenResponse

Policytoken-responsegenskaperna.
PolicyTokensAcquireAtManagementGroupOptionalParams

Valfria parametrar.
PolicyTokensAcquireOptionalParams

Valfria parametrar.
PolicyTokensOperations

Gränssnitt som representerar en PolicyTokens-operation.
ProxyResource

Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats
Resource

Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser
ResourceSelector

Resursväljaren som filtrerar principer efter resursegenskaper.
ResourceTypeAliases

Definitionen av resurstypalias.
Selector

Väljarens uttryck.
SelfServeExemptionSettings

Självbetjäningsundantagsinställningarna för en policyuppdrag.
SystemData

Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentitiesValue

modellgränssnitt AnvändartilldeladeIdentiteterVärde

Typalias

AliasPathAttributes

Attributen för token som aliassökvägen refererar till.
KnownAliasPathAttributes kan användas utbytbart med AliasPathAttributes innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

None: Token som aliassökvägen refererar till har inga attribut.
Ändringsbar: Den token som aliassökvägen refererar till kan ändras av principer med "ändra"-effekt.
AliasPathTokenType

Typen av token som aliassökvägen refererar till.
KnownAliasPathTokenType kan användas utbytbart med AliasPathTokenType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

NotSpecified: Tokentypen har inte angetts.
Alla: Tokentypen kan vara vad som helst.
String: Tokentypen är sträng.
Object: Tokentypen är objekt.
Array: Tokentypen är matris.
Heltal: Tokentypen är heltal.
Number: Tokentypen är tal.
boolesk: Tokentypen är boolesk.
AliasPatternType

Typen av aliasmönster.
AliasType

Typ av alias.
AssignmentType

Typ av principtilldelning. Möjliga värden är NotSpecified, System, SystemHidden och Custom. Oföränderliga.
KnownAssignmentType- kan användas utbytbart med AssignmentType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

NotSpecificified: Den ej specificerade uppdragstypen.
System: Systemtilldelningstypen.
SystemHidden: Systemens dolda tilldelningstyp.
Skräddarsydd: Den anpassade uppdragstypen.
AzureSupportedClouds

De värden som stöds för molninställningen som en strängliteraltyp
ContinuablePage

Ett gränssnitt som beskriver en resultatsida.
CreatedByType

Den typ av entitet som skapade resursen.
KnownCreatedByType- kan användas utbytbart med CreateByType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Användare: Entiteten skapades av en användare.
Application: Entiteten skapades av ett program.
ManagedIdentity: Entiteten skapades av en hanterad identitet.
Nyckel: Entiteten skapades av en nyckel.
EnforcementMode

Tvingande läge för principtilldelning. Möjliga värden är Default, DoNotEnforcement och Enroll
KnownEnforcementMode kan användas utbytbart med EnforcementMode innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Standard: Principeffekten tillämpas när resursen skapas eller uppdateras.
DoNotEnforce: Principeffekten tillämpas inte när resursen skapas eller uppdateras.
Registrering: Policyeffekten tillämpas inte vid resursskapande eller uppdatering förrän resursen eller resursens omfattning är registrerad i tilldelningsinstansen. Registrering sker vid användning av policy-inskrivningsresursen.
ExternalEndpointResult

Resultatet av det yttre ändpunkten. Möjliga värden är Lyckade och Misslyckade.
KnownExternalEndpointResult kan användas omväxlande med ExternalEndpointResult, denna enum innehåller de kända värden som tjänsten stödjer.

Kända värden som stöds av tjänsten

Lyckades: Det yttre slutmålet lyckades.
Misslyckades: Den externa ändpunkten misslyckades.
OverrideKind

Åsidosättningstyp.
KnownOverrideKind kan användas utbytbart med OverrideKind, den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

policyEffect: Den åsidosätter principeffekttypen.
definitionVersion: Det åsidosätter egenskapsvärdet för definitionsversionen för principtilldelningen.
ParameterType

Parameterns datatyp.
KnownParameterType- kan användas omväxlande med ParameterType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Sträng: Strängparametertypen.
Array: Array-parametertypen.
Objekt: Objektparametertypen.
Boolesk: Den booleska parametertypen.
Heltal: Heltalsparametertypen.
Float: Flytta-parametertypen.
DateTime: Datum-tids-parametertypen.
PolicyAction

Det effektiva resultatet av policyutvärderingen baseras både på policyeffekten och utvärderingsresultatet. Möjliga värden är Okänd, Tillåt, Granskning, Neka, Fel.
KnownPolicyAction kan användas omväxlande med PolicyAction, detta enum innehåller de kända värden som tjänsten stödjer.

Kända värden som stöds av tjänsten

Okänd: Det effektiva resultatet av policyutvärdering är okänt.
Tillåt: Det effektiva resultatet av policyutvärdering är att godkänna begäran.
Revision: Det effektiva resultatet av policyutvärdering är att granska begäran.
Neka: Det effektiva resultatet av policyutvärdering är att neka begäran.
Fel: Policyutvärderingen resulterade i ett fel.
PolicyTokenResult

Resultatet av den slutförda tokeninköpsoperationen. Möjliga värden är Lyckade och Misslyckade.
KnownPolicyTokenResult kan användas omväxlande med PolicyTokenResult, denna enum innehåller de kända värden som tjänsten stödjer.

Kända värden som stöds av tjänsten

Lyckades: Det token-förvärvet lyckades.
Misslyckades: Tokenförvärvet misslyckades.
PolicyType

Typen av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
KnownPolicyType- kan användas omväxlande med PolicyType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

NotSpecificified: Den ej specificerade policydefinitionstypen.
BuiltIn: Den inbyggda policydefinitionstypen.
Skräddarsydd: Den anpassade policydefinitionstypen.
Statisk: Den statiska policydefinitionstypen.
ResourceIdentityType

Identitetstypen. Det här är det enda obligatoriska fältet när du lägger till en system- eller användartilldelad identitet till en resurs.
SelectorKind

Väljarens typ.
KnownSelectorKind kan användas utbytbart med SelectorKind, den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

resourceLocation: Väljarens typ för att filtrera principer efter resursplatsen.
resourceType: Väljarens typ för att filtrera principer efter resurstyp.
resourceWithoutLocation: Väljarens typ för att filtrera principer efter resursen utan plats.
policyDefinitionReferenceId: Väljarens typ för att filtrera principer efter principdefinitionens referens-ID.
resourceRolloutPercentage: Den väljartyp som filtrerar policyer efter resursutrullningsprocent.
userPrincipalId: Väljarformen för att filtrera policyer efter användarens principal-ID.
groupPrincipalId: Väljarformen för att filtrera policyer efter säkerhetsgruppens medlems-ID.

Uppräkningar

AzureClouds

En uppräkning för att beskriva Azure Cloud-miljöer.
KnownAliasPathAttributes

Attributen för token som aliassökvägen refererar till.
KnownAliasPathTokenType

Typen av token som aliassökvägen refererar till.
KnownAssignmentType

Typ av principtilldelning. Möjliga värden är NotSpecified, System, SystemHidden och Custom. Oföränderliga.
KnownCreatedByType

Den typ av entitet som skapade resursen.
KnownEnforcementMode

Tvingande läge för principtilldelning. Möjliga värden är Standard, DoNotEnforce och Registrera
KnownExternalEndpointResult

Resultatet av det yttre ändpunkten. Möjliga värden är Lyckade och Misslyckade.
KnownOverrideKind

Åsidosättningstyp.
KnownParameterType

Parameterns datatyp.
KnownPolicyAction

Det effektiva resultatet av policyutvärderingen baseras både på policyeffekten och utvärderingsresultatet. Möjliga värden är Okänd, Tillåt, Granskning, Neka, Fel.
KnownPolicyTokenResult

Resultatet av den slutförda tokeninköpsoperationen. Möjliga värden är Lyckade och Misslyckade.
KnownPolicyType

Typen av principdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
KnownSelectorKind

Väljarens typ.
KnownVersions

Tillgängliga API-versioner.

Förhandsversionen (v2026_01_01_preview) innehåller allt från den senaste stabila versionen plus nya resurstyper som endast kan användas för förhandsvisning:

  • PolicyExemption, Variable, VariableValue (markerad med

Funktioner

isRestError(unknown)

Typeguard för RestError

Variabler

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

Funktionsinformation

isRestError(unknown)

Typeguard för RestError

function isRestError(e: unknown): e is RestError

Parametrar

e

unknown

Något som fångas av en fångstklausul.

Returer

e is RestError

Variabelinformation

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

RestError: RestErrorConstructor

Typ

RestErrorConstructor