@azure/arm-policy package
Klasy
| PolicyClient |
Interfejsy
| Alias |
Typ aliasu. |
| AliasPath |
Typ ścieżek dla aliasu. |
| AliasPathMetadata |
Metadane ścieżki aliasu. |
| AliasPattern |
Typ wzorca dla ścieżki aliasu. |
| DataEffect |
Definicja efektu danych. |
| DataManifestCustomResourceFunctionDefinition |
Niestandardowa definicja funkcji zasobu. |
| DataManifestResourceFunctionsDefinition |
Zasób funkcjonuje wspierany przez manifest. |
| DataPolicyManifest |
Manifest zasad danych. |
| DataPolicyManifestProperties |
Właściwości manifestu polityki danych. |
| DataPolicyManifestsGetByPolicyModeOptionalParams |
Parametry opcjonalne. |
| DataPolicyManifestsListOptionalParams |
Parametry opcjonalne. |
| DataPolicyManifestsOperations |
Interfejs reprezentujący operacje DataPolicyManifests. |
| ErrorAdditionalInfo |
Dodatkowe informacje o błędzie zarządzania zasobami. |
| ErrorDetail |
Szczegóły błędu. |
| ErrorResponse |
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. |
| ExtensionResource |
Podstawowy zasób rozszerzenia. |
| ExternalEvaluationEndpointInvocationResult |
Wyniki wywołania końcowego punktu oceny zewnętrznej. |
| ExternalEvaluationEndpointSettings |
Ustawienia zewnętrznego punktu końcowego zapewniającego wyniki oceny. |
| ExternalEvaluationEnforcementSettings |
Szczegóły źródła wyników oceny zewnętrznej wymagane przez zasady podczas oceny wymuszania. |
| Identity |
Tożsamość zasobu. Przypisania zasad obsługują maksymalnie jedną tożsamość. Jest to tożsamość przypisana przez system lub tożsamość przypisana przez jednego użytkownika. |
| NonComplianceMessage |
Komunikat opisujący, dlaczego zasób jest niezgodny z zasadami. Jest to wyświetlane w komunikatach o błędach "odmów" i wynikach niezgodności zasobu. |
| Override |
Wartość właściwości zasad zastępuje. |
| PageSettings |
Opcje dla metody byPage |
| PagedAsyncIterableIterator |
Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony. |
| ParameterDefinitionsValue |
Definicja parametru, który można podać do zasad. |
| ParameterDefinitionsValueMetadata |
Ogólne metadane parametru. |
| ParameterValuesValue |
Wartość parametru. |
| PolicyAssignment |
Przypisanie zasad. |
| PolicyAssignmentProperties |
Właściwości związane z przydziałem polisy. |
| PolicyAssignmentUpdate |
Przypisanie zasad dla żądania poprawki. |
| PolicyAssignmentUpdateProperties |
Właściwości przypisywania polityk dla żądania poprawek. |
| PolicyAssignmentsCreateOptionalParams |
Parametry opcjonalne. |
| PolicyAssignmentsDeleteOptionalParams |
Parametry opcjonalne. |
| PolicyAssignmentsGetOptionalParams |
Parametry opcjonalne. |
| PolicyAssignmentsListForManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyAssignmentsListForResourceGroupOptionalParams |
Parametry opcjonalne. |
| PolicyAssignmentsListForResourceOptionalParams |
Parametry opcjonalne. |
| PolicyAssignmentsListOptionalParams |
Parametry opcjonalne. |
| PolicyAssignmentsOperations |
Interfejs reprezentujący operacje PolicyAssignments. |
| PolicyAssignmentsUpdateOptionalParams |
Parametry opcjonalne. |
| PolicyClientOptionalParams |
Parametry opcjonalne dla klienta. |
| PolicyDefinition |
Definicja zasad. |
| PolicyDefinitionGroup |
Grupa definicji zasad. |
| PolicyDefinitionProperties |
Właściwości definicji zasad. |
| PolicyDefinitionReference |
Odwołanie do definicji zasad. |
| PolicyDefinitionVersion |
Identyfikator wersji definicji zasad. |
| PolicyDefinitionVersionListResult |
Odpowiedź operacji listy PolicyDefinitionVersion. |
| PolicyDefinitionVersionProperties |
Właściwości definicji zasad. |
| PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsDeleteAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsDeleteOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsGetAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsGetBuiltInOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsGetOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsListAllAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsListAllBuiltinsOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsListAllOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsListBuiltInOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsListByManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsListOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionVersionsOperations |
Interfejs reprezentujący operacje PolicyDefinitionVersions. |
| PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionsCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionsDeleteAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionsDeleteOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionsGetAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionsGetBuiltInOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionsGetOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionsListBuiltInOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionsListByManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionsListOptionalParams |
Parametry opcjonalne. |
| PolicyDefinitionsOperations |
Interfejs reprezentujący operacje PolicyDefinitions. |
| PolicyLogInfo |
Informacje z logu polityki. |
| PolicySetDefinition |
Definicja zestawu zasad. |
| PolicySetDefinitionProperties |
Właściwości definicji zestawu zasad. |
| PolicySetDefinitionVersion |
Wersja definicji zestawu zasad. |
| PolicySetDefinitionVersionListResult |
Odpowiedź operacji listy PolicySetDefinitionVersion. |
| PolicySetDefinitionVersionProperties |
Właściwości definicji zestawu zasad. |
| PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsDeleteAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsDeleteOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsGetAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsGetBuiltInOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsGetOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsListAllAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsListAllBuiltinsOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsListAllOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsListBuiltInOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsListByManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsListOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionVersionsOperations |
Interfejs reprezentujący operacje PolicySetDefinitionVersions. |
| PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionsCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionsDeleteAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionsDeleteOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionsGetAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionsGetBuiltInOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionsGetOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionsListBuiltInOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionsListByManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionsListOptionalParams |
Parametry opcjonalne. |
| PolicySetDefinitionsOperations |
Interfejs reprezentujący operacje PolicySetDefinitions. |
| PolicyTokenEvaluatedRequestDetails |
Token polityki oceniał szczegóły żądania. |
| PolicyTokenOperation |
Operacja surowca potrzebna do uzyskania tokena. |
| PolicyTokenRequest |
Właściwości żądania tokenów polityki. |
| PolicyTokenResponse |
Właściwości odpowiedzi tokena polityki. |
| PolicyTokensAcquireAtManagementGroupOptionalParams |
Parametry opcjonalne. |
| PolicyTokensAcquireOptionalParams |
Parametry opcjonalne. |
| PolicyTokensOperations |
Interfejs reprezentujący operacje PolicyTokens. |
| ProxyResource |
Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie on miał tagów i lokalizacji |
| Resource |
Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager |
| ResourceSelector |
Selektor zasobów do filtrowania zasad według właściwości zasobów. |
| ResourceTypeAliases |
Definicja aliasów typu zasobu. |
| Selector |
Wyrażenie selektora. |
| SelfServeExemptionSettings |
Ustawienia zwolnień dla samoobsługi dla przydziału polisy. |
| SystemData |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
| UserAssignedIdentitiesValue |
interfejs modelu UserAssignedIdentitiesValue |
Aliasy typu
| AliasPathAttributes |
Atrybuty tokenu, do którego odwołuje się ścieżka aliasu. Znane wartości obsługiwane przez usługę
None: token, do którego odwołuje się ścieżka aliasu, nie ma atrybutów. |
| AliasPathTokenType |
Typ tokenu, do którego odwołuje się ścieżka aliasu. Znane wartości obsługiwane przez usługę
Nieokreślone: nie określono typu tokenu. |
| AliasPatternType |
Typ wzoru aliasów. |
| AliasType |
Typ aliasu. |
| AssignmentType |
Typ przypisania zasad. Możliwe wartości to NotSpecified, System, SystemHidden i Custom. Niezmienne. Znane wartości obsługiwane przez usługę
NotSpecificed: Nieokreślony typ przypisania. |
| AzureSupportedClouds |
Obsługiwane wartości ustawienia chmury jako typ literału ciągu |
| ContinuablePage |
Interfejs opisujący stronę wyników. |
| CreatedByType |
Rodzaj jednostki, która utworzyła zasób. Znane wartości obsługiwane przez usługę
użytkownik: jednostka została utworzona przez użytkownika. |
| EnforcementMode |
Tryb wymuszania przypisania zasad. Możliwe wartości to Domyślne, DoNotEnforce oraz Enroll Znane wartości obsługiwane przez usługę
domyślne: efekt zasad jest wymuszany podczas tworzenia lub aktualizowania zasobów. |
| ExternalEndpointResult |
Wynik zewnętrznego punktu końcowego. Możliwe wartości to Sukces i Niepowodzenie. Znane wartości obsługiwane przez usługę
Sukces: Zewnętrzny punkt końcowy zakończył się sukcesem. |
| OverrideKind |
Rodzaj przesłonięcia. Znane wartości obsługiwane przez usługę
policyEffect: zastąpi typ efektu zasad. |
| ParameterType |
Typ danych parametru. Znane wartości obsługiwane przez usługę
String: Typ parametru stringu. |
| PolicyAction |
Skuteczny wynik oceny polityki oparty jest zarówno na podstawie efektu polityki, jak i wyniku oceny. Możliwe wartości to: Nieznane, Zezwalaj, Audyt, Odrzucaj, Błąd. Znane wartości obsługiwane przez usługę
Nieznane: Skuteczne wyniki oceny polityki są nieznane. |
| PolicyTokenResult |
Rezultat zakończonej operacji pozyskiwania tokenów. Możliwe wartości to Sukces i Niepowodzenie. Znane wartości obsługiwane przez usługę
Sukces: Pozyskanie tokena zakończyło się sukcesem. |
| PolicyType |
Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. Znane wartości obsługiwane przez usługę
NotSpecificed: Nie określony typ definicji polityki. |
| ResourceIdentityType |
Typ tożsamości. Jest to jedyne pole wymagane podczas dodawania tożsamości przypisanej przez system lub użytkownika do zasobu. |
| SelectorKind |
Rodzaj selektora. Znane wartości obsługiwane przez usługę
resourceLocation: rodzaj selektora do filtrowania zasad według lokalizacji zasobu. |
Wyliczenia
| AzureClouds |
Wyliczenie opisujące środowiska chmury platformy Azure. |
| KnownAliasPathAttributes |
Atrybuty tokenu, do którego odwołuje się ścieżka aliasu. |
| KnownAliasPathTokenType |
Typ tokenu, do którego odwołuje się ścieżka aliasu. |
| KnownAssignmentType |
Typ przypisania zasad. Możliwe wartości to NotSpecified, System, SystemHidden i Custom. Niezmienne. |
| KnownCreatedByType |
Rodzaj jednostki, która utworzyła zasób. |
| KnownEnforcementMode |
Tryb wymuszania przypisania zasad. Możliwe wartości to Default, DoNotEnforce i Enroll |
| KnownExternalEndpointResult |
Wynik zewnętrznego punktu końcowego. Możliwe wartości to Sukces i Niepowodzenie. |
| KnownOverrideKind |
Rodzaj przesłonięcia. |
| KnownParameterType |
Typ danych parametru. |
| KnownPolicyAction |
Skuteczny wynik oceny polityki oparty jest zarówno na podstawie efektu polityki, jak i wyniku oceny. Możliwe wartości to: Nieznane, Zezwalaj, Audyt, Odrzucaj, Błąd. |
| KnownPolicyTokenResult |
Rezultat zakończonej operacji pozyskiwania tokenów. Możliwe wartości to Sukces i Niepowodzenie. |
| KnownPolicyType |
Typ definicji zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static. |
| KnownSelectorKind |
Rodzaj selektora. |
| KnownVersions |
Dostępne wersje interfejsu API. Wersja podglądowa (v2026_01_01_preview) zawiera wszystko z najnowszej stabilnej wersji oraz nowe typy zasobów dostępnych wyłącznie w podglądzie:
|
Funkcje
| is |
Funkcja Typeguard dla błędu RestError |
Zmienne
| Rest |
Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem. |
Szczegóły funkcji
isRestError(unknown)
Funkcja Typeguard dla błędu RestError
function isRestError(e: unknown): e is RestError
Parametry
- e
-
unknown
Coś złapanego przez klauzulę catch.
Zwraca
e is RestError
Szczegóły zmiennej
RestError
Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.
RestError: RestErrorConstructor