@azure/arm-policy package

Klassen

PolicyClient

Schnittstellen

Alias	Der Aliastyp.
AliasPath	Der Typ der Pfade für Alias.
AliasPathMetadata	Die Alias-Pfad-Metadaten.
AliasPattern	Der Typ des Musters für einen Aliaspfad.
DataEffect	Die Definition des Dateneffekts.
DataManifestCustomResourceFunctionDefinition	Die Definition der benutzerdefinierten Ressourcenfunktion.
DataManifestResourceFunctionsDefinition	Die Ressourcenfunktionen, die von einem Manifest unterstützt werden.
DataPolicyManifest	Das Datenrichtlinienmanifest.
DataPolicyManifestProperties	Die Eigenschaften der Datenrichtlinie zeigen sich.
DataPolicyManifestsGetByPolicyModeOptionalParams	Optionale Parameter.
DataPolicyManifestsListOptionalParams	Optionale Parameter.
DataPolicyManifestsOperations	Schnittstelle, die eine DataPolicyManifests-Operation darstellt.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben.
ExtensionResource	Die Basiserweiterungsressource.
ExternalEvaluationEndpointInvocationResult	Der externe Evaluationsend-Aufruf ergibt.
ExternalEvaluationEndpointSettings	Die Einstellungen eines externen Endpunkts, der Auswertungsergebnisse bereitstellt.
ExternalEvaluationEnforcementSettings	Die Details der Quelle externer Auswertungsergebnisse, die von der Richtlinie während der Erzwingungsbewertung benötigt werden.
Identity	Identität für die Ressource. Richtlinienzuweisungen unterstützen maximal eine Identität. Dies ist entweder eine vom System zugewiesene Identität oder eine einzelne benutzer zugewiesene Identität.
NonComplianceMessage	Eine Meldung, die beschreibt, warum eine Ressource nicht mit der Richtlinie kompatibel ist. Dies wird in fehlermeldungen "verweigern" und in den nicht konformen Complianceergebnissen der Ressource angezeigt.
Override	Die Außerkraftsetzung des Richtlinieneigenschaftswerts.
PageSettings	Optionen für die byPage-Methode
PagedAsyncIterableIterator	Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.
ParameterDefinitionsValue	Die Definition eines Parameters, der der Richtlinie bereitgestellt werden kann.
ParameterDefinitionsValueMetadata	Allgemeine Metadaten für den Parameter.
ParameterValuesValue	Der Wert eines Parameters.
PolicyAssignment	Die Richtlinienzuweisung.
PolicyAssignmentProperties	Die Eigenschaften der Policenübertragung.
PolicyAssignmentUpdate	Die Richtlinienzuweisung für Patchanforderung.
PolicyAssignmentUpdateProperties	Die Eigenschaften der Richtlinienzuweisung für Patch-Anfragen.
PolicyAssignmentsCreateOptionalParams	Optionale Parameter.
PolicyAssignmentsDeleteOptionalParams	Optionale Parameter.
PolicyAssignmentsGetOptionalParams	Optionale Parameter.
PolicyAssignmentsListForManagementGroupOptionalParams	Optionale Parameter.
PolicyAssignmentsListForResourceGroupOptionalParams	Optionale Parameter.
PolicyAssignmentsListForResourceOptionalParams	Optionale Parameter.
PolicyAssignmentsListOptionalParams	Optionale Parameter.
PolicyAssignmentsOperations	Schnittstelle, die eine PolicyAssignments-Operation darstellt.
PolicyAssignmentsUpdateOptionalParams	Optionale Parameter.
PolicyClientOptionalParams	Optionale Parameter für den Client.
PolicyDefinition	Die Richtliniendefinition.
PolicyDefinitionGroup	Die Richtliniendefinitionsgruppe.
PolicyDefinitionProperties	Die Richtliniendefinitionseigenschaften.
PolicyDefinitionReference	Der Richtliniendefinitionsverweis.
PolicyDefinitionVersion	Die ID der Richtliniendefinitionsversion.
PolicyDefinitionVersionListResult	Die Antwort einer PolicyDefinitionVersion-Listenoperation.
PolicyDefinitionVersionProperties	Die Richtliniendefinitionseigenschaften.
PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsCreateOrUpdateOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsDeleteAtManagementGroupOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsDeleteOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsGetAtManagementGroupOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsGetBuiltInOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsGetOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsListAllAtManagementGroupOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsListAllBuiltinsOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsListAllOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsListBuiltInOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsListByManagementGroupOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsListOptionalParams	Optionale Parameter.
PolicyDefinitionVersionsOperations	Schnittstelle, die eine Operationen von PolicyDefinitionVersions darstellt.
PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams	Optionale Parameter.
PolicyDefinitionsCreateOrUpdateOptionalParams	Optionale Parameter.
PolicyDefinitionsDeleteAtManagementGroupOptionalParams	Optionale Parameter.
PolicyDefinitionsDeleteOptionalParams	Optionale Parameter.
PolicyDefinitionsGetAtManagementGroupOptionalParams	Optionale Parameter.
PolicyDefinitionsGetBuiltInOptionalParams	Optionale Parameter.
PolicyDefinitionsGetOptionalParams	Optionale Parameter.
PolicyDefinitionsListBuiltInOptionalParams	Optionale Parameter.
PolicyDefinitionsListByManagementGroupOptionalParams	Optionale Parameter.
PolicyDefinitionsListOptionalParams	Optionale Parameter.
PolicyDefinitionsOperations	Schnittstelle, die eine Operationen von PolicyDefinitions darstellt.
PolicyLogInfo	Die Infos zum Policenprotokoll.
PolicySetDefinition	Die Richtliniensatzdefinition.
PolicySetDefinitionProperties	Die Eigenschaften der Richtliniensatzdefinition.
PolicySetDefinitionVersion	Die Definitionsversion des Richtliniensatzes.
PolicySetDefinitionVersionListResult	Die Antwort einer PolicySetDefinitionVersion-Listenoperation.
PolicySetDefinitionVersionProperties	Die Eigenschaften der Richtliniensatzdefinition.
PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsCreateOrUpdateOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsDeleteAtManagementGroupOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsDeleteOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsGetAtManagementGroupOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsGetBuiltInOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsGetOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsListAllAtManagementGroupOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsListAllBuiltinsOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsListAllOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsListBuiltInOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsListByManagementGroupOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsListOptionalParams	Optionale Parameter.
PolicySetDefinitionVersionsOperations	Schnittstelle, die eine Operationen von PolicySetDefinitionVersions darstellt.
PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams	Optionale Parameter.
PolicySetDefinitionsCreateOrUpdateOptionalParams	Optionale Parameter.
PolicySetDefinitionsDeleteAtManagementGroupOptionalParams	Optionale Parameter.
PolicySetDefinitionsDeleteOptionalParams	Optionale Parameter.
PolicySetDefinitionsGetAtManagementGroupOptionalParams	Optionale Parameter.
PolicySetDefinitionsGetBuiltInOptionalParams	Optionale Parameter.
PolicySetDefinitionsGetOptionalParams	Optionale Parameter.
PolicySetDefinitionsListBuiltInOptionalParams	Optionale Parameter.
PolicySetDefinitionsListByManagementGroupOptionalParams	Optionale Parameter.
PolicySetDefinitionsListOptionalParams	Optionale Parameter.
PolicySetDefinitionsOperations	Schnittstelle, die eine Operationen von PolicySetDefinitions darstellt.
PolicyTokenEvaluatedRequestDetails	Der Policy-Token bewertete die Details der Anfrage.
PolicyTokenOperation	Die Ressourcenoperation, um ein Token zu erhalten.
PolicyTokenRequest	Die Eigenschaften der Richtlinien-Token-Anfrage.
PolicyTokenResponse	Die Eigenschaften der Politik-Token-Antwort.
PolicyTokensAcquireAtManagementGroupOptionalParams	Optionale Parameter.
PolicyTokensAcquireOptionalParams	Optionale Parameter.
PolicyTokensOperations	Schnittstelle repräsentiert PolicyTokens-Operationen.
ProxyResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort.
Resource	Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden
ResourceSelector	Die Ressourcenauswahl zum Filtern von Richtlinien nach Ressourceneigenschaften.
ResourceTypeAliases	Die Definition von Ressourcentypaliasen.
Selector	Der Selektorausdruck.
SelfServeExemptionSettings	Die Einstellungen für Selbstbedienungsbefreiungen bei einer Police.
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentitiesValue	Modelloberfläche BenutzerZugewiesenIdentitätenWert

Typaliase

AliasPathAttributes	Die Attribute des Tokens, auf das der Aliaspfad verweist. KnownAliasPathAttributes austauschbar mit AliasPathAttributes verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden None: Das Token, auf das der Aliaspfad verweist, weist keine Attribute auf. modifizierbaren: Das Token, auf das der Aliaspfad verweist, kann durch Richtlinien mit "Modify"-Effekt geändert werden.
AliasPathTokenType	Der Typ des Tokens, auf das der Aliaspfad verweist. KnownAliasPathTokenType austauschbar mit AliasPathTokenType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden NotSpecified: Der Tokentyp ist nicht angegeben. Any: Der Tokentyp kann beliebig sein. Zeichenfolge: Der Tokentyp ist Zeichenfolge. Object: Der Tokentyp ist Objekt. Array-: Der Tokentyp ist Array. Ganze Zahl: Der Tokentyp ist eine ganze Zahl. Zahl: Der Tokentyp ist "Number". boolesche: Der Tokentyp ist boolescher Wert.
AliasPatternType	Die Art des Alias-Musters.
AliasType	Der Typ des Alias.
AssignmentType	Der Typ der Richtlinienzuweisung. Mögliche Werte sind NotSpecified, System, SystemHidden und Custom. Unveränderlich. KnownAssignmentType- austauschbar mit AssignmentType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden NichtSpezifiziert: Der nicht spezifizierte Zuweisungstyp. System: Der Systemzuweisungstyp. SystemHidden: Der versteckte System-Zuweisungstyp. Benutzerdefiniert: Der benutzerdefinierte Zuweisungstyp.
AzureSupportedClouds	Die unterstützten Werte für die Cloud-Einstellung als Zeichenfolgenliteraltyp
ContinuablePage	Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt.
CreatedByType	Die Art der Entität, die die Ressource erstellt hat. KnownCreatedByType austauschbar mit CreatedByType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Benutzer-: Die Entität wurde von einem Benutzer erstellt. Application: Die Entität wurde von einer Anwendung erstellt. ManagedIdentity-: Die Entität wurde durch eine verwaltete Identität erstellt. Key: Die Entität wurde mit einem Schlüssel erstellt.
EnforcementMode	Der Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind Default, DoNotEnforcement und Enroll KnownEnforcementMode- austauschbar mit EnforcementMode verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Standard-: Der Richtlinieneffekt wird während der Ressourcenerstellung oder -aktualisierung erzwungen. DoNotEnforce: Der Richtlinieneffekt wird während der Ressourcenerstellung oder -aktualisierung nicht erzwungen. Anmeldung: Der Policy-Effekt wird während der Ressourcenerstellung oder Aktualisierung nicht durchgesetzt, bis die Ressource oder der Umfang der Ressource in die Zuweisungsinstanz aufgenommen wurde. Die Anmeldung erfolgt nach der Bereitstellung der Policy-Enrollment-Ressource.
ExternalEndpointResult	Das Ergebnis des äußeren Endpunkts. Mögliche Werte sind erfolgreich und gescheitert. KnownExternalEndpointResult kann austauschbar mit ExternalEndpointResult verwendet werden, dieses Enum enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Erfolgreich: Der externe Endpunkt war erfolgreich. Fehlgeschlagen: Der externe Endpunkt ist ausgefallen.
OverrideKind	Die Überschreibungsart. KnownOverrideKind kann austauschbar mit OverrideKind verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden policyEffect: Er überschreibt den Richtlinieneffekttyp. definitionVersion: Es überschreibt den Eigenschaftswert der Definitionsversion der Richtlinienzuweisung.
ParameterType	Der Datentyp des Parameters. KnownParameterType austauschbar mit ParameterType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden String: Der String-Parametertyp. Array: Der Array-Parametertyp. Objekt: Der Objektparametertyp. Boolesch: Der boolesche Parametertyp. Ganzzahl: Der Ganzzahlparametertyp. Float: Der Float-Parametertyp. DateTime: Der Datum-Zeit-Parametertyp.
PolicyAction	Das effektive Ergebnis der politischen Bewertung basiert sowohl auf der politischen Wirkung als auch auf dem Bewertungsergebnis. Mögliche Werte sind Unbekannt, Erlauben, Prüfen, Verweigern, Fehler. KnownPolicyAction kann austauschbar mit PolicyAction verwendet werden, dieses Enum enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Unbekannt: Das effektive Ergebnis der Politikevaluation ist unbekannt. Erlauben: Das wirksame Ergebnis der Politikbewertung ist, die Anfrage zuzulassen. Prüfung: Das effektive Ergebnis der Richtlinienbewertung ist eine Prüfung des Antrags. Ablehnen: Das effektive Ergebnis der politischen Bewertung ist die Ablehnung des Antrags. Fehler: Die Richtlinienbewertung ergab einen Fehler.
PolicyTokenResult	Das Ergebnis der abgeschlossenen Token-Akquisitionsoperation. Mögliche Werte sind erfolgreich und gescheitert. KnownPolicyTokenResult kann austauschbar mit PolicyTokenResult verwendet werden, dieses Enum enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Erfolgreich: Die Token-Übernahme war erfolgreich. Fehlgeschlagen: Die Token-Übernahme gescheitert.
PolicyType	Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. KnownPolicyType- austauschbar mit PolicyType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden NotSpecificified: Der nicht spezifizierte Definitionstyp der Police. BuiltIn: Der eingebaute Definitionstyp der Richtlinien. Benutzerdefiniert: Der Typ der benutzerdefinierten Policendefinition. Statisch: Der Typ der statischen Richtliniendefinition.
ResourceIdentityType	Der Identitätstyp. Dies ist das einzige erforderliche Feld beim Hinzufügen einer System- oder Benutzeridentität zu einer Ressource.
SelectorKind	Die Selektorart. KnownSelectorKind kann austauschbar mit SelectorKind verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden resourceLocation: Die Auswahlart zum Filtern von Richtlinien nach dem Ressourcenspeicherort. resourceType: Die Selektorart zum Filtern von Richtlinien nach dem Ressourcentyp. resourceWithoutLocation: Die Auswahlart zum Filtern von Richtlinien nach der Ressource ohne Speicherort. policyDefinitionReferenceId: Die Selektorart zum Filtern von Richtlinien nach der Richtliniendefinitionsreferenz-ID. resourceRolloutPercentage: Die Auswahlart, um Richtlinien nach dem Ressourcenausrollungsprozentsatz zu filtern. userPrincipalId: Die Auswahlart, um Richtlinien nach der User Principal ID zu filtern. groupPrincipalId: Der Auswahltyp, um Richtlinien nach der Security Group Membership ID zu filtern.

Enumerationen

AzureClouds	Eine Enumeration zur Beschreibung von Azure Cloud-Umgebungen.
KnownAliasPathAttributes	Die Attribute des Tokens, auf das der Aliaspfad verweist.
KnownAliasPathTokenType	Der Typ des Tokens, auf das der Aliaspfad verweist.
KnownAssignmentType	Der Typ der Richtlinienzuweisung. Mögliche Werte sind NotSpecified, System, SystemHidden und Custom. Unveränderlich.
KnownCreatedByType	Die Art der Entität, die die Ressource erstellt hat.
KnownEnforcementMode	Der Erzwingungsmodus für die Richtlinienzuweisung. Mögliche Werte sind "Default", "DoNotEnforce" und "Enroll".
KnownExternalEndpointResult	Das Ergebnis des äußeren Endpunkts. Mögliche Werte sind erfolgreich und gescheitert.
KnownOverrideKind	Die Überschreibungsart.
KnownParameterType	Der Datentyp des Parameters.
KnownPolicyAction	Das effektive Ergebnis der politischen Bewertung basiert sowohl auf der politischen Wirkung als auch auf dem Bewertungsergebnis. Mögliche Werte sind Unbekannt, Erlauben, Prüfen, Verweigern, Fehler.
KnownPolicyTokenResult	Das Ergebnis der abgeschlossenen Token-Akquisitionsoperation. Mögliche Werte sind erfolgreich und gescheitert.
KnownPolicyType	Der Typ der Richtliniendefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static.
KnownSelectorKind	Die Selektorart.
KnownVersions	Die verfügbaren API-Versionen. Die Vorschauversion (v2026_01_01_preview) umfasst alles von der neuesten stabilen Version bis zu neuen, nur vorschaubaren Ressourcentypen: PolicyExemption, Variable, VariableValue (markiert mit

Functions

isRestError(unknown)

Typeguard für RestError

Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

Details zur Funktion

isRestError(unknown)

Typeguard für RestError

function isRestError(e: unknown): e is RestError

Parameter

e

unknown

Etwas, das von einer Catch-Klausel abgefangen wird.

Gibt zurück

e is RestError

Details zu Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

RestError: RestErrorConstructor

Typ

RestErrorConstructor