@azure/arm-policy package

類別

PolicyClient

介面

Alias	別名類型。
AliasPath	別名的路徑類型。
AliasPathMetadata	別名路徑的元資料。
AliasPattern	別名路徑的模式類型。
DataEffect	數據效果定義。
DataManifestCustomResourceFunctionDefinition	自訂資源函式定義。
DataManifestResourceFunctionsDefinition	資源功能由清單支援。
DataPolicyManifest	數據原則指令清單。
DataPolicyManifestProperties	資料政策的特性會顯現。
DataPolicyManifestsGetByPolicyModeOptionalParams	選擇性參數。
DataPolicyManifestsListOptionalParams	選擇性參數。
DataPolicyManifestsOperations	介面代表 DataPolicyManifests 操作。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。
ExtensionResource	基底延伸模組資源。
ExternalEvaluationEndpointInvocationResult	外部評估端點調用結果。
ExternalEvaluationEndpointSettings	提供評估結果的外部端點設定。
ExternalEvaluationEnforcementSettings	原則在強制評估期間所需的外部評估結果來源詳細數據。
Identity	資源的身分識別。 原則指派最多支援一個身分識別。 這是系統指派的身分識別或單一使用者指派的身分識別。
NonComplianceMessage	描述資源不符合原則之原因的訊息。 這會顯示在「拒絕」錯誤訊息和資源不符合規範的合規性結果中。
Override	原則屬性值覆寫。
PageSettings	byPage 方法的選項
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
ParameterDefinitionsValue	可提供給原則的參數定義。
ParameterDefinitionsValueMetadata	參數的一般元數據。
ParameterValuesValue	參數的值。
PolicyAssignment	原則指派。
PolicyAssignmentProperties	保單指派屬性。
PolicyAssignmentUpdate	Patch 要求的原則指派。
PolicyAssignmentUpdateProperties	Patch 請求的政策指派屬性。
PolicyAssignmentsCreateOptionalParams	選擇性參數。
PolicyAssignmentsDeleteOptionalParams	選擇性參數。
PolicyAssignmentsGetOptionalParams	選擇性參數。
PolicyAssignmentsListForManagementGroupOptionalParams	選擇性參數。
PolicyAssignmentsListForResourceGroupOptionalParams	選擇性參數。
PolicyAssignmentsListForResourceOptionalParams	選擇性參數。
PolicyAssignmentsListOptionalParams	選擇性參數。
PolicyAssignmentsOperations	介面代表 PolicyAssignments 操作。
PolicyAssignmentsUpdateOptionalParams	選擇性參數。
PolicyClientOptionalParams	用戶端的選擇性參數。
PolicyDefinition	原則定義。
PolicyDefinitionGroup	原則定義群組。
PolicyDefinitionProperties	原則定義屬性。
PolicyDefinitionReference	原則定義參考。
PolicyDefinitionVersion	原則定義版本的標識碼。
PolicyDefinitionVersionListResult	PolicyDefinitionVersion 清單操作的回應。
PolicyDefinitionVersionProperties	原則定義屬性。
PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams	選擇性參數。
PolicyDefinitionVersionsCreateOrUpdateOptionalParams	選擇性參數。
PolicyDefinitionVersionsDeleteAtManagementGroupOptionalParams	選擇性參數。
PolicyDefinitionVersionsDeleteOptionalParams	選擇性參數。
PolicyDefinitionVersionsGetAtManagementGroupOptionalParams	選擇性參數。
PolicyDefinitionVersionsGetBuiltInOptionalParams	選擇性參數。
PolicyDefinitionVersionsGetOptionalParams	選擇性參數。
PolicyDefinitionVersionsListAllAtManagementGroupOptionalParams	選擇性參數。
PolicyDefinitionVersionsListAllBuiltinsOptionalParams	選擇性參數。
PolicyDefinitionVersionsListAllOptionalParams	選擇性參數。
PolicyDefinitionVersionsListBuiltInOptionalParams	選擇性參數。
PolicyDefinitionVersionsListByManagementGroupOptionalParams	選擇性參數。
PolicyDefinitionVersionsListOptionalParams	選擇性參數。
PolicyDefinitionVersionsOperations	介面代表 PolicyDefinitionVersions 操作。
PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams	選擇性參數。
PolicyDefinitionsCreateOrUpdateOptionalParams	選擇性參數。
PolicyDefinitionsDeleteAtManagementGroupOptionalParams	選擇性參數。
PolicyDefinitionsDeleteOptionalParams	選擇性參數。
PolicyDefinitionsGetAtManagementGroupOptionalParams	選擇性參數。
PolicyDefinitionsGetBuiltInOptionalParams	選擇性參數。
PolicyDefinitionsGetOptionalParams	選擇性參數。
PolicyDefinitionsListBuiltInOptionalParams	選擇性參數。
PolicyDefinitionsListByManagementGroupOptionalParams	選擇性參數。
PolicyDefinitionsListOptionalParams	選擇性參數。
PolicyDefinitionsOperations	介面代表 PolicyDefinitions 操作。
PolicyLogInfo	保單記錄資訊。
PolicySetDefinition	原則集定義。
PolicySetDefinitionProperties	原則集定義屬性。
PolicySetDefinitionVersion	原則集定義版本。
PolicySetDefinitionVersionListResult	PolicySetDefinitionVersion 清單操作的回應。
PolicySetDefinitionVersionProperties	原則集定義屬性。
PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams	選擇性參數。
PolicySetDefinitionVersionsCreateOrUpdateOptionalParams	選擇性參數。
PolicySetDefinitionVersionsDeleteAtManagementGroupOptionalParams	選擇性參數。
PolicySetDefinitionVersionsDeleteOptionalParams	選擇性參數。
PolicySetDefinitionVersionsGetAtManagementGroupOptionalParams	選擇性參數。
PolicySetDefinitionVersionsGetBuiltInOptionalParams	選擇性參數。
PolicySetDefinitionVersionsGetOptionalParams	選擇性參數。
PolicySetDefinitionVersionsListAllAtManagementGroupOptionalParams	選擇性參數。
PolicySetDefinitionVersionsListAllBuiltinsOptionalParams	選擇性參數。
PolicySetDefinitionVersionsListAllOptionalParams	選擇性參數。
PolicySetDefinitionVersionsListBuiltInOptionalParams	選擇性參數。
PolicySetDefinitionVersionsListByManagementGroupOptionalParams	選擇性參數。
PolicySetDefinitionVersionsListOptionalParams	選擇性參數。
PolicySetDefinitionVersionsOperations	介面代表 PolicySetDefinitionVersions 操作。
PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams	選擇性參數。
PolicySetDefinitionsCreateOrUpdateOptionalParams	選擇性參數。
PolicySetDefinitionsDeleteAtManagementGroupOptionalParams	選擇性參數。
PolicySetDefinitionsDeleteOptionalParams	選擇性參數。
PolicySetDefinitionsGetAtManagementGroupOptionalParams	選擇性參數。
PolicySetDefinitionsGetBuiltInOptionalParams	選擇性參數。
PolicySetDefinitionsGetOptionalParams	選擇性參數。
PolicySetDefinitionsListBuiltInOptionalParams	選擇性參數。
PolicySetDefinitionsListByManagementGroupOptionalParams	選擇性參數。
PolicySetDefinitionsListOptionalParams	選擇性參數。
PolicySetDefinitionsOperations	介面代表 PolicySetDefinitions 操作。
PolicyTokenEvaluatedRequestDetails	政策權杖會評估請求細節。
PolicyTokenOperation	資源操作，用來取得一個令牌。
PolicyTokenRequest	政策令牌請求屬性。
PolicyTokenResponse	政策代幣回應屬性。
PolicyTokensAcquireAtManagementGroupOptionalParams	選擇性參數。
PolicyTokensAcquireOptionalParams	選擇性參數。
PolicyTokensOperations	介面代表 PolicyTokens 操作。
ProxyResource	Azure Resource Manager Proxy 資源的資源模型定義。 它不會有標記和位置
Resource	回應中針對所有 Azure Resource Manager 資源傳回的常見欄位
ResourceSelector	依資源屬性篩選原則的資源選取器。
ResourceTypeAliases	資源類型別名定義。
Selector	選取器表達式。
SelfServeExemptionSettings	保單指派的自助豁免設定。
SystemData	與建立和上次修改資源相關的元數據。
UserAssignedIdentitiesValue	model interface UserAssignedIdentitiesValue

類型別名

AliasPathAttributes	別名路徑所參考之令牌的屬性。 KnownAliasPathAttributes 可以與 AliasPathAttributes 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 None：別名路徑所參考的令牌沒有屬性。 可修改：別名路徑所參考的令牌可由具有 'modify' 效果的原則修改。
AliasPathTokenType	別名路徑所參考之令牌的類型。 KnownAliasPathTokenType 可以與 AliasPathTokenType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 NotSpecified：未指定令牌類型。 任何：令牌類型可以是任何專案。 String：Token 類型為 string。 Object：Token 類型為 object。 Array：Token 類型為 array。 整數：令牌類型為整數。 數位：令牌類型為 number。 布爾值：令牌類型為布爾值。
AliasPatternType	別名的類型。
AliasType	別名的類型。
AssignmentType	原則指派的類型。 可能的值為 NotSpecified、System、SystemHidden 和 Custom。 不可改變。 KnownAssignmentType 可以與 AssignmentType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 NotSpecified：未指定的指派類型。 系統：系統指派類型。 SystemHidden：系統隱藏的指派類型。 自訂：自訂分配類型。
AzureSupportedClouds	雲端設定為字串常值類型的支援值
ContinuablePage	描述結果頁面的介面。
CreatedByType	建立資源的實體種類。 KnownCreatedByType 可以與 CreatedByType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用者：實體是由使用者建立的。 應用程式：實體是由應用程式所建立。 ManagedIdentity：實體是由受控識別所建立。 金鑰：實體是由金鑰所建立。
EnforcementMode	原則指派強制模式。 可能的值包括 Default、DoNotEnforce 和 Enroll KnownEnforcementMode 可以與 EnforcementMode 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 預設：在資源建立或更新期間會強制執行原則效果。 DoNotEnforce：在資源建立或更新期間不會強制執行原則效果。 註冊：在資源建立或更新時，政策效果不會強制執行，直到資源或資源範圍被註冊到指派實例。 註冊發生於保單註冊資源部署時。
ExternalEndpointResult	這是外部終點的結果。 可能的數值為成功與失敗。 KnownExternalEndpointResult 可與 ExternalEndpointResult 互換使用，此列舉包含服務所支援的已知值。 服務支援的已知值 成功：外部終端成功。 失敗：外部終端故障。
OverrideKind	覆寫種類。 KnownOverrideKind 可以與 OverrideKind 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 policyEffect：它會覆寫原則效果類型。 definitionVersion：它將替代策略分配的定義版本屬性值。
ParameterType	參數的數據類型。 KnownParameterType 可以與 ParameterType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 String：字串參數類型。 陣列：陣列參數類型。 物件：物件參數類型。 布林值：布林參數型態。 整數：整數參數類型。 Float：float 參數類型。 DateTime：日期-時間參數類型。
PolicyAction	基於政策效果與評估結果的政策評估有效結果。 可能的值有未知、允許、稽核、拒絕、錯誤。 KnownPolicyAction 可與 PolicyAction 互換使用，此枚舉包含服務所支援的已知值。 服務支援的已知值 未知：政策評估的有效結果尚不明朗。 允許：政策評估的有效結果是允許該請求。 稽核：政策評估的有效結果是稽核申請。 否認：政策評估的有效結果是拒絕該請求。 錯誤：政策評估結果出錯。
PolicyTokenResult	這是完成代幣取得作業的成果。 可能的數值為成功與失敗。 KnownPolicyTokenResult 可與 PolicyTokenResult 互換使用，此枚舉包含服務所支援的已知值。 服務支援的已知值 成功：代幣取得成功。 失敗：代幣取得失敗。
PolicyType	原則定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。 KnownPolicyType 可以與 PolicyType 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 NotSpecified：未指定的政策定義類型。 BuiltIn：內建的政策定義類型。 自訂：自訂政策定義類型。 靜態：靜態政策定義類型。
ResourceIdentityType	識別類型。 將系統或使用者指派的身分識別新增至資源時，這是唯一的必要字段。
SelectorKind	選取器種類。 KnownSelectorKind 可以與 SelectorKind 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 resourceLocation：依資源位置篩選原則的選取器種類。 resourceType：依資源類型篩選原則的選取器種類。 resourceWithoutLocation：依沒有位置的資源篩選原則的選取器種類。 policyDefinitionReferenceId：依原則定義參考標識符篩選原則的選取器種類。 resourceRolloutPercentage：選擇器類型，用來依資源展開百分比篩選政策。 userPrincipalId：選擇器類型，用來依使用者主體 ID 過濾政策。 groupPrincipalId：用來篩選策略的選擇器類型，可依據安全群組成員 ID 進行篩選。

列舉

AzureClouds	描述 Azure 雲端環境的列舉。
KnownAliasPathAttributes	別名路徑所參考之令牌的屬性。
KnownAliasPathTokenType	別名路徑所參考之令牌的類型。
KnownAssignmentType	原則指派的類型。 可能的值為 NotSpecified、System、SystemHidden 和 Custom。 不可改變。
KnownCreatedByType	建立資源的實體種類。
KnownEnforcementMode	原則指派強制模式。 可能的值為 Default、DoNotEnforce 和 Enroll
KnownExternalEndpointResult	這是外部終點的結果。 可能的數值為成功與失敗。
KnownOverrideKind	覆寫種類。
KnownParameterType	參數的數據類型。
KnownPolicyAction	基於政策效果與評估結果的政策評估有效結果。 可能的值有未知、允許、稽核、拒絕、錯誤。
KnownPolicyTokenResult	這是完成代幣取得作業的成果。 可能的數值為成功與失敗。
KnownPolicyType	原則定義的類型。 可能的值為 NotSpecified、BuiltIn、Custom 和 Static。
KnownSelectorKind	選取器種類。
KnownVersions	可用的 API 版本。 預覽版（v2026_01_01_preview）包含了最新穩定版的所有內容，以及新的僅預覽資源類型： PolicyExemption、Variable、VariableValue（標記為

函式

isRestError(unknown)

RestError 的 Typeguard

變數

RestError

失敗管線要求的自定義錯誤類型。

函式詳細資料

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e is RestError

參數

e

unknown

catch 子句攔截到的東西。

傳回

e is RestError

變數詳細資料

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型

RestErrorConstructor