@azure/arm-azurestackhci package
介面
類型別名
| AccessLevel |
遠端支援存取層級 服務支援的已知值
診斷:僅允許遠端診斷操作。 |
| ActionType |
可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。 服務支援的已知值內部:動作適用於僅限內部的 API。 |
| ArcExtensionState |
Arc Extension 安裝狀態。 服務支援的已知值
未指定:未指定弧延伸狀態。 |
| ArcSettingAggregateState |
Arc 代理在這個 HCI 叢集中各節點的總體狀態。 服務支援的已知值
未指定狀態:未指定總體狀態。 |
| AvailabilityType |
說明更新內容如何提供下載。 這會決定更新是本地來源、線上倉庫,還是需要用戶通知。 服務支援的已知值
本地:更新內容可在環境中本地取得。 |
| AzureSupportedClouds |
雲端設定為字串常值類型的支援值 |
| ClusterNodeType |
指定叢集中所有節點的硬體供應商類型。 表示節點是由 Microsoft 或第三方廠商提供。 服務支援的已知值
第一方:叢集中的所有節點均由 Microsoft 提供與管理。 |
| ClusterPattern |
HCI 叢集支援的儲存模式 服務支援的已知值
標準:標準叢集。 |
| ComplianceAssignmentType |
代表資源的合規指派類型。 服務支援的已知值
稽核:報告機器狀態,但不做任何更改。 |
| ComplianceStatus |
代表資源的合規狀態。 服務支援的已知值
合規:資源是合規的 |
| ConnectivityStatus |
叢集資源的整體連接狀態。 顯示叢集是否已連接 Azure、部分連接,或近期未曾通訊。 服務支援的已知值
NotYetRegistered:叢集尚未在 Azure 註冊。 |
| ContinuablePage |
描述結果頁面的介面。 |
| CreatedByType |
建立資源的實體類型。 服務支援的已知值
使用者:實體是由使用者建立的。 |
| DeploymentMode |
部署模式以觸發工作。 服務支援的已知值
驗證:驗證叢集的 ECE 動作部署。 |
| DeviceKind |
邊緣裝置類型。 服務支援的已知值HCI:具備 Arc 功能的邊緣裝置,搭配 HCI 作業系統。 |
| DeviceLogCollectionStatus |
代表日誌收集操作的狀態。 服務支援的已知值
NotStarted:日誌收集作業尚未啟動。 |
| DeviceState |
邊緣裝置狀態。 服務支援的已知值
未指定:未指定邊緣裝置狀態。 |
| DiagnosticLevel |
叢集發出的診斷數據所需層級。 服務支援的已知值
關閉:不會發出診斷數據。 |
| DnsServerConfig |
指定 DNS 伺服器的配置方式以用於基礎設施網路。 允許的值為「UseDnsServer」以使用提供的 DNS 伺服器,以及「UseForwarder」以使用 DNS 轉發器。 服務支援的已知值
UseDnsServer:使用提供的 DNS 伺服器來建立基礎設施網路。 |
| EceSecrets |
允許企業雲引擎(ECE)部署秘密名稱。 服務支援的已知值
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. |
| EdgeDeviceJobUnion |
EdgeDeviceJobUnion 的別名 |
| EdgeDeviceKind |
邊緣裝置類型。 服務支援的已知值HCI:具備 Arc 功能的邊緣裝置,搭配 HCI 作業系統。 |
| EdgeDeviceUnion |
EdgeDeviceUnion 的別名 |
| ExtensionAggregateState |
此 HCI 叢集中跨節點的 Arc 擴展整合狀態。 這反映了擴充部署與所有節點運作的整體狀態。 服務支援的已知值
未指定狀態:未指定總體狀態。 |
| ExtensionManagedBy |
顯示擴充功能是由使用者管理還是由 Azure 管理。 服務支援的已知值
使用者:擴充功能由使用者管理。 |
| HardwareClass |
叢集的硬體類別。 服務支援的已知值
小型:硬體類別較小。 |
| HciEdgeDeviceJobPropertiesUnion |
Alias for HciEdgeDeviceJobPropertiesUnion |
| HciEdgeDeviceJobType |
支援工作類型。 服務支援的已知值
CollectLog:負責從裝置收集日誌的工作。 |
| HealthState |
更新特定健康狀態檢查的整體健康狀態。 表示系統是否正常運作、有警告或錯誤,或正在進行健康評估。 服務支援的已知值
未知:健康狀況不明或無法確定。 |
| IdentityProvider |
叢集的身份提供者 服務支援的已知值
ActiveDirectory:使用 Active Directory 作為身份提供者,實現基於網域的認證與集中式身份管理。 這是預設選項。 |
| ImdsAttestation |
該群組的IMDS認證狀態。 服務支援的已知值
停用:叢集的 IMDS 認證被關閉。 |
| JobStatus |
代表工作在其生命週期中可能擁有的各種狀態。 服務支援的已知值
未指定:職位狀態尚未說明。 |
| LogCollectionJobType |
指定記錄收集工作的類型。 判斷日誌是立即按需收集,還是作為預定作業的一部分。 服務支援的已知值
隨需:日誌收集是手動觸發並立即執行。 |
| LogCollectionStatus |
日誌收集狀態 服務支援的已知值
無:尚未啟動任何日誌收集。 |
| ManagedServiceIdentityType |
受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。 服務支援的已知值
無:沒有受控識別。 |
| NodeArcState |
此節點中 Arc 代理的狀態。 顯示代理目前的生命週期狀態,例如是否正在配置、連線、更新,或是否遇到錯誤。 服務支援的已知值
未指定狀態:未指定狀態。 |
| NodeExtensionState |
此節點的弧延伸狀態。 反映該擴充功能在個別節點的當前生命週期狀態,例如是否正在建立、更新、刪除或遇到錯誤。 服務支援的已知值
未指定狀態:未指定狀態。 |
| OemActivation |
叢集的 OEM 啟動狀態。 服務支援的已知值
停用:叢集的 OEM 啟用功能已停用。 |
| OperationType |
叢集的預期作業。 服務支援的已知值
叢集配置:叢集配置操作。 |
| Origin |
作業的預期執行程式;如同資源型訪問控制 (RBAC) 和稽核記錄 UX。 預設值為「user,system」 服務支援的已知值
user:表示作業是由使用者起始。 |
| OverprovisioningRatio |
S2D 儲存的過度配置比率。 服務支援的已知值
0:不允許過度補給。 |
| ProvisioningState |
ArcSetting 代理資源的配置狀態。 服務支援的已知值
未指定:未指定配置狀態。 |
| RdmaCapability |
描述網路介面卡的 RDMA 功能。 服務支援的已知值
啟用:裝置上的網路適配器支援 RDMA |
| RebootRequirement |
指示更新或操作後是否需要重新啟動。 有助於判斷是否需要重新啟動系統才能完成流程。 服務支援的已知值
未知:目前尚不清楚是否需要重啟。 |
| RemoteSupportAccessLevel |
定義所授予的遠端支援存取層級。 服務支援的已知值
無:不允許遠端支援存取權限。 |
| RemoteSupportProvisioningState |
遠端支援配置狀態 服務支援的已知值
無:目前無手術進行中。 |
| RemoteSupportType |
叢集的遠端支援類型 服務支援的已知值
啟用:啟用叢集的遠端支援。 |
| SecretsType |
要儲存的秘密類型 服務支援的已知值備份秘密:備份秘密類型 |
| ServiceName |
指定與更新或操作相關聯的服務名稱。 這有助於辨識涉及哪個系統元件或工具。 服務支援的已知值WAC:Windows 管理中心(WAC)是與此操作相關的服務。 |
| Severity |
表示結果的重要性或影響程度。 判斷結果是資訊性、警告性,或可能阻擋更新的關鍵問題。 服務支援的已知值
關鍵問題:會阻擋更新且需要立即處理的關鍵問題。 |
| SoftwareAssuranceIntent |
軟體保證權益的客戶意圖。 服務支援的已知值
啟用:客戶打算啟用軟體保證福利。 |
| SoftwareAssuranceStatus |
叢集的軟體保證狀態。 服務支援的已知值
啟用:叢集已啟用軟體保證。 |
| State |
代表與此郵票相關的更新狀態。 這包括準備、安裝、掃描及錯誤處理等階段,提供更新進度及遇到問題的洞察。 服務支援的已知值
HasPrerequisite:更新有必須先完成的先決條件才能繼續。 |
| Status |
集群特工狀態。 表示代理在叢集內目前的連線、驗證及部署狀態。 服務支援的已知值
NotYetRegistered:叢集代理尚未在 Azure 註冊。 |
| StatusLevelTypes |
層級程序代碼。 表示狀態訊息的嚴重性或重要性。 服務支援的已知值
資訊:指示正常運作的資訊訊息。 |
| StorageType |
HCI 叢集支援儲存類型。 服務支援的已知值
S2D:儲存空間直接存取(S2D)儲存類型。 |
| UpdateRunPropertiesState |
代表目前更新執行的狀態。 顯示更新是否正在進行中、已成功完成、失敗,或處於未知狀態。 服務支援的已知值
未知:更新進度不明。 |
| UpdateSummariesPropertiesState |
戳記的整體更新狀態。 顯示整個印章中更新部署的狀態,包括準備、應用及遇到的任何問題。 服務支援的已知值
未知:更新狀態不明。 |
| VolumeType |
S2D 儲存的磁碟區配置類型。 服務支援的已知值
固定:固定配置類型。 |
| WindowsServerSubscription |
Windows Server 訂閱的期望狀態。 服務支援的已知值
停用:Windows Server 訂閱已停用。 |
列舉
| AzureClouds |
描述 Azure 雲端環境的列舉。 |
| KnownAccessLevel |
遠端支援存取層級 |
| KnownActionType |
可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。 |
| KnownArcExtensionState |
Arc Extension 安裝狀態。 |
| KnownArcSettingAggregateState |
Arc 代理在這個 HCI 叢集中各節點的總體狀態。 |
| KnownAvailabilityType |
說明更新內容如何提供下載。 這會決定更新是本地來源、線上倉庫,還是需要用戶通知。 |
| KnownClusterNodeType |
指定叢集中所有節點的硬體供應商類型。 表示節點是由 Microsoft 或第三方廠商提供。 |
| KnownClusterPattern |
HCI 叢集支援的儲存模式 |
| KnownComplianceAssignmentType |
代表資源的合規指派類型。 |
| KnownComplianceStatus |
代表資源的合規狀態。 |
| KnownConnectivityStatus |
叢集資源的整體連接狀態。 顯示叢集是否已連接 Azure、部分連接,或近期未曾通訊。 |
| KnownCreatedByType |
建立資源的實體類型。 |
| KnownDeploymentMode |
部署模式以觸發工作。 |
| KnownDeviceKind |
邊緣裝置類型。 |
| KnownDeviceLogCollectionStatus |
代表日誌收集操作的狀態。 |
| KnownDeviceState |
邊緣裝置狀態。 |
| KnownDiagnosticLevel |
叢集發出的診斷數據所需層級。 |
| KnownDnsServerConfig |
指定 DNS 伺服器的配置方式以用於基礎設施網路。 允許的值為「UseDnsServer」以使用提供的 DNS 伺服器,以及「UseForwarder」以使用 DNS 轉發器。 |
| KnownEceSecrets |
允許企業雲引擎(ECE)部署秘密名稱。 |
| KnownEdgeDeviceKind |
邊緣裝置類型。 |
| KnownExtensionAggregateState |
此 HCI 叢集中跨節點的 Arc 擴展整合狀態。 這反映了擴充部署與所有節點運作的整體狀態。 |
| KnownExtensionManagedBy |
顯示擴充功能是由使用者管理還是由 Azure 管理。 |
| KnownHardwareClass |
叢集的硬體類別。 |
| KnownHciEdgeDeviceJobType |
支援工作類型。 |
| KnownHealthState |
更新特定健康狀態檢查的整體健康狀態。 表示系統是否正常運作、有警告或錯誤,或正在進行健康評估。 |
| KnownIdentityProvider |
叢集的身份提供者 |
| KnownImdsAttestation |
該群組的IMDS認證狀態。 |
| KnownJobStatus |
代表工作在其生命週期中可能擁有的各種狀態。 |
| KnownLogCollectionJobType |
指定記錄收集工作的類型。 判斷日誌是立即按需收集,還是作為預定作業的一部分。 |
| KnownLogCollectionStatus |
日誌收集狀態 |
| KnownManagedServiceIdentityType |
受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。 |
| KnownNodeArcState |
此節點中 Arc 代理的狀態。 顯示代理目前的生命週期狀態,例如是否正在配置、連線、更新,或是否遇到錯誤。 |
| KnownNodeExtensionState |
此節點的弧延伸狀態。 反映該擴充功能在個別節點的當前生命週期狀態,例如是否正在建立、更新、刪除或遇到錯誤。 |
| KnownOemActivation |
叢集的 OEM 啟動狀態。 |
| KnownOperationType |
叢集的預期作業。 |
| KnownOrigin |
作業的預期執行程式;如同資源型訪問控制 (RBAC) 和稽核記錄 UX。 默認值為 “user,system” |
| KnownOverprovisioningRatio |
S2D 儲存的過度配置比率。 |
| KnownProvisioningState |
ArcSetting 代理資源的配置狀態。 |
| KnownRdmaCapability |
描述網路介面卡的 RDMA 功能。 |
| KnownRebootRequirement |
指示更新或操作後是否需要重新啟動。 有助於判斷是否需要重新啟動系統才能完成流程。 |
| KnownRemoteSupportAccessLevel |
定義所授予的遠端支援存取層級。 |
| KnownRemoteSupportProvisioningState |
遠端支援配置狀態 |
| KnownRemoteSupportType |
叢集的遠端支援類型 |
| KnownSecretsType |
要儲存的秘密類型 |
| KnownServiceName |
指定與更新或操作相關聯的服務名稱。 這有助於辨識涉及哪個系統元件或工具。 |
| KnownSeverity |
表示結果的重要性或影響程度。 判斷結果是資訊性、警告性,或可能阻擋更新的關鍵問題。 |
| KnownSoftwareAssuranceIntent |
軟體保證權益的客戶意圖。 |
| KnownSoftwareAssuranceStatus |
叢集的軟體保證狀態。 |
| KnownState |
代表與此郵票相關的更新狀態。 這包括準備、安裝、掃描及錯誤處理等階段,提供更新進度及遇到問題的洞察。 |
| KnownStatus |
集群特工狀態。 表示代理在叢集內目前的連線、驗證及部署狀態。 |
| KnownStatusLevelTypes |
層級程序代碼。 表示狀態訊息的嚴重性或重要性。 |
| KnownStorageType |
HCI 叢集支援儲存類型。 |
| KnownUpdateRunPropertiesState |
代表目前更新執行的狀態。 顯示更新是否正在進行中、已成功完成、失敗,或處於未知狀態。 |
| KnownUpdateSummariesPropertiesState |
戳記的整體更新狀態。 顯示整個印章中更新部署的狀態,包括準備、應用及遇到的任何問題。 |
| KnownVersions |
可用的 API 版本。 |
| KnownVolumeType |
S2D 儲存的磁碟區配置類型。 |
| KnownWindowsServerSubscription |
Windows Server 訂閱的期望狀態。 |
函式
| is |
RestError 的 Typeguard |
| restore |
從另一個輪詢器的序列化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器,或需要在原始輪詢器不在範圍內之後建構輪詢器時,這會很有用。 |
變數
| Rest |
失敗管線要求的自定義錯誤類型。 |
函式詳細資料
isRestError(unknown)
RestError 的 Typeguard
function isRestError(e: unknown): e
參數
- e
-
unknown
catch 子句攔截到的東西。
傳回
e
restorePoller<TResponse, TResult>(AzureStackHCIClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
從另一個輪詢器的序列化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器,或需要在原始輪詢器不在範圍內之後建構輪詢器時,這會很有用。
function restorePoller<TResponse, TResult>(client: AzureStackHCIClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
參數
- client
- AzureStackHCIClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
傳回
PollerLike<OperationState<TResult>, TResult>