Cluster interface

套件:

@azure/arm-servicefabric

叢集資源

Extends

Resource

屬性

addOnFeatures	在叢集中啟用的附加元件功能清單。
applicationTypeVersionsCleanupPolicy	用來清除未使用版本的原則。
availableClusterVersions	此叢集可用的 Service Fabric 執行時間版本。 注意：這個屬性不會串行化。 它只能由伺服器填入。
azureActiveDirectory	叢集的 AAD 驗證設定。
certificate	用於保護叢集的憑證。 提供的憑證將用於叢集內的節點對節點安全性、叢集管理端點的 SSL 憑證和預設管理員用戶端。
certificateCommonNames	描述用來保護叢集之通用名稱所參考的伺服器憑證清單。
clientCertificateCommonNames	允許管理叢集之一般名稱所參考的客戶端憑證清單。
clientCertificateThumbprints	允許管理叢集的指紋所參考的客戶端憑證清單。
clusterCodeVersion	叢集的 Service Fabric 運行時間版本。 只有當 upgradeMode 設定為 'Manual' 時，才能設定使用者 此屬性。 若要取得新叢集可用的 Service Fabric 版本列表，請使用 ClusterVersion API。 若要取得現有叢集可用的版本清單，請使用 availableClusterVersions。
clusterEndpoint	Azure 資源提供者端點。 叢集中的系統服務會連線到此端點。 注意：這個屬性不會串行化。 它只能由伺服器填入。
clusterId	服務為叢集資源產生唯一標識符。 注意：這個屬性不會串行化。 它只能由伺服器填入。
clusterState	叢集的目前狀態。 WaitingForNodes - 指出已建立叢集資源，且資源提供者正在等候 Service Fabric VM 擴充功能開機並回報給它。 部署 - 指出正在 VM 上安裝 Service Fabric 執行時間。 叢集資源會處於此狀態，直到叢集啟動且系統服務啟動為止。 BaselineUpgrade - 指出叢集正在升級以建立叢集版本。 第一次啟動叢集時，會自動起始此升級。 UpdateingUserConfiguration - 指出叢集正隨著使用者提供的組態升級。 UpdateingUserCertificate - 指出叢集正以使用者提供的憑證升級。 UpdateingInfrastructure - 指出叢集正以最新的 Service Fabric 運行時間版本升級。 只有當 upgradeMode 設定為 [自動] 時，才會發生這種情況。 EnforcingClusterVersion - 指出叢集位於與預期版本不同的版本，且叢集正在升級至預期的版本。 UpgradeServiceUnreachable - 指出叢集中的系統服務不再輪詢資源提供者。 處於此狀態的叢集無法由資源提供者管理。 自動調整 - 指出正在調整叢集的 ReliabilityLevel。 就緒 - 表示叢集處於穩定狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
diagnosticsStorageAccountConfig	用來儲存 Service Fabric 診斷記錄的記憶體帳戶資訊。
eventStoreServiceEnabled	指出事件存放區服務是否已啟用。
fabricSettings	要設定叢集的自定義網狀架構設定清單。
infrastructureServiceManager	指出基礎結構服務管理員是否已啟用。
managementEndpoint	叢集的 HTTP 管理端點。
nodeTypes	叢集中的節點類型清單。
notifications	指出叢集事件的通知通道清單。
provisioningState	叢集資源的布建狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
reliabilityLevel	可靠性層級會設定系統服務的復本集大小。 瞭解 ReliabilityLevel。 無 - 執行目標副本集計數為 1 的系統服務。 這隻應該用於測試叢集。 銅牌 - 以目標副本集計數 3 執行系統服務。 這隻應該用於測試叢集。 Silver - 使用目標副本集計數 5 執行系統服務。 Gold - 使用目標副本集計數 7 執行系統服務。 白金 - 以目標副本集計數 9 執行系統服務。
reverseProxyCertificate	反向 Proxy 所使用的伺服器證書。
reverseProxyCertificateCommonNames	描述用來保護叢集之通用名稱所參考的伺服器憑證清單。
sfZonalUpgradeMode	此屬性會控制升級網域中 VM 的邏輯群組（UD）。 如果叢集中已有多個可用性區域的節點類型，則無法修改這個屬性。
upgradeDescription	升級叢集時要使用的原則。
upgradeMode	有新的 Service Fabric 執行時間版本可用時，叢集的升級模式。
upgradePauseEndTimestampUtc	指出在叢集上暫停自動運行時間版本升級的特定時間週期 （UTC） 的結束日期和時間。
upgradePauseStartTimestampUtc	指出在叢集上暫停自動運行時間版本升級的特定時間週期的開始日期和時間。
upgradeWave	指出發行新的叢集運行時間版本升級何時會套用。 根據預設為 Wave0。 只有在 upgradeMode 設定為 『Automatic』 時才適用。
vmImage	已設定 VM 映像 VMSS。 您可以使用 Windows 或 Linux 等泛型名稱。
vmssZonalUpgradeMode	此屬性會定義虛擬機擴展集的升級模式，如果新增具有多個可用性區域的節點類型，則為必要。
waveUpgradePaused	布爾值，以暫停自動運行時間版本升級至叢集。

繼承的屬性

etag	Azure 資源 etag。 注意：這個屬性不會串行化。 它只能由伺服器填入。
id	Azure 資源標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。
location	Azure 資源位置。
name	Azure 資源名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
systemData	與建立和上次修改資源相關的元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
tags	Azure 資源標籤。
type	Azure 資源類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

屬性詳細資料

addOnFeatures

在叢集中啟用的附加元件功能清單。

addOnFeatures?: string[]

屬性值

string[]

applicationTypeVersionsCleanupPolicy

用來清除未使用版本的原則。

applicationTypeVersionsCleanupPolicy?: ApplicationTypeVersionsCleanupPolicy

屬性值

ApplicationTypeVersionsCleanupPolicy

availableClusterVersions

此叢集可用的 Service Fabric 執行時間版本。 注意：這個屬性不會串行化。 它只能由伺服器填入。

availableClusterVersions?: ClusterVersionDetails[]

屬性值

ClusterVersionDetails[]

azureActiveDirectory

叢集的 AAD 驗證設定。

azureActiveDirectory?: AzureActiveDirectory

屬性值

AzureActiveDirectory

certificate

用於保護叢集的憑證。 提供的憑證將用於叢集內的節點對節點安全性、叢集管理端點的 SSL 憑證和預設管理員用戶端。

certificate?: CertificateDescription

屬性值

CertificateDescription

certificateCommonNames

描述用來保護叢集之通用名稱所參考的伺服器憑證清單。

certificateCommonNames?: ServerCertificateCommonNames

屬性值

ServerCertificateCommonNames

clientCertificateCommonNames

允許管理叢集之一般名稱所參考的客戶端憑證清單。

clientCertificateCommonNames?: ClientCertificateCommonName[]

屬性值

ClientCertificateCommonName[]

clientCertificateThumbprints

允許管理叢集的指紋所參考的客戶端憑證清單。

clientCertificateThumbprints?: ClientCertificateThumbprint[]

屬性值

ClientCertificateThumbprint[]

clusterCodeVersion

叢集的 Service Fabric 運行時間版本。 只有當 upgradeMode 設定為 'Manual' 時，才能設定使用者 此屬性。 若要取得新叢集可用的 Service Fabric 版本列表，請使用 ClusterVersion API。 若要取得現有叢集可用的版本清單，請使用 availableClusterVersions。

clusterCodeVersion?: string

屬性值

string

clusterEndpoint

Azure 資源提供者端點。 叢集中的系統服務會連線到此端點。 注意：這個屬性不會串行化。 它只能由伺服器填入。

clusterEndpoint?: string

屬性值

string

clusterId

服務為叢集資源產生唯一標識符。 注意：這個屬性不會串行化。 它只能由伺服器填入。

clusterId?: string

屬性值

string

clusterState

叢集的目前狀態。

• WaitingForNodes - 指出已建立叢集資源，且資源提供者正在等候 Service Fabric VM 擴充功能開機並回報給它。
• 部署 - 指出正在 VM 上安裝 Service Fabric 執行時間。 叢集資源會處於此狀態，直到叢集啟動且系統服務啟動為止。
• BaselineUpgrade - 指出叢集正在升級以建立叢集版本。 第一次啟動叢集時，會自動起始此升級。
• UpdateingUserConfiguration - 指出叢集正隨著使用者提供的組態升級。
• UpdateingUserCertificate - 指出叢集正以使用者提供的憑證升級。
• UpdateingInfrastructure - 指出叢集正以最新的 Service Fabric 運行時間版本升級。 只有當 upgradeMode 設定為 [自動] 時，才會發生這種情況。
• EnforcingClusterVersion - 指出叢集位於與預期版本不同的版本，且叢集正在升級至預期的版本。
• UpgradeServiceUnreachable - 指出叢集中的系統服務不再輪詢資源提供者。 處於此狀態的叢集無法由資源提供者管理。
• 自動調整 - 指出正在調整叢集的 ReliabilityLevel。
• 就緒 - 表示叢集處於穩定狀態。

注意：這個屬性不會串行化。 它只能由伺服器填入。

clusterState?: string

屬性值

string

diagnosticsStorageAccountConfig

用來儲存 Service Fabric 診斷記錄的記憶體帳戶資訊。

diagnosticsStorageAccountConfig?: DiagnosticsStorageAccountConfig

屬性值

DiagnosticsStorageAccountConfig

eventStoreServiceEnabled

指出事件存放區服務是否已啟用。

eventStoreServiceEnabled?: boolean

屬性值

boolean

fabricSettings

要設定叢集的自定義網狀架構設定清單。

fabricSettings?: SettingsSectionDescription[]

屬性值

SettingsSectionDescription[]

infrastructureServiceManager

指出基礎結構服務管理員是否已啟用。

infrastructureServiceManager?: boolean

屬性值

boolean

managementEndpoint

叢集的 HTTP 管理端點。

managementEndpoint?: string

屬性值

string

nodeTypes

叢集中的節點類型清單。

nodeTypes?: NodeTypeDescription[]

屬性值

NodeTypeDescription[]

notifications

指出叢集事件的通知通道清單。

notifications?: Notification_2[]

屬性值

Notification[]

provisioningState

叢集資源的布建狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

provisioningState?: string

屬性值

string

reliabilityLevel

可靠性層級會設定系統服務的復本集大小。 瞭解 ReliabilityLevel。

• 無 - 執行目標副本集計數為 1 的系統服務。 這隻應該用於測試叢集。
• 銅牌 - 以目標副本集計數 3 執行系統服務。 這隻應該用於測試叢集。
• Silver - 使用目標副本集計數 5 執行系統服務。
• Gold - 使用目標副本集計數 7 執行系統服務。
• 白金 - 以目標副本集計數 9 執行系統服務。

reliabilityLevel?: string

屬性值

string

reverseProxyCertificate

反向 Proxy 所使用的伺服器證書。

reverseProxyCertificate?: CertificateDescription

屬性值

CertificateDescription

reverseProxyCertificateCommonNames

描述用來保護叢集之通用名稱所參考的伺服器憑證清單。

reverseProxyCertificateCommonNames?: ServerCertificateCommonNames

屬性值

ServerCertificateCommonNames

sfZonalUpgradeMode

此屬性會控制升級網域中 VM 的邏輯群組（UD）。 如果叢集中已有多個可用性區域的節點類型，則無法修改這個屬性。

sfZonalUpgradeMode?: string

屬性值

string

upgradeDescription

升級叢集時要使用的原則。

upgradeDescription?: ClusterUpgradePolicy

屬性值

ClusterUpgradePolicy

upgradeMode

有新的 Service Fabric 執行時間版本可用時，叢集的升級模式。

upgradeMode?: string

屬性值

string

upgradePauseEndTimestampUtc

指出在叢集上暫停自動運行時間版本升級的特定時間週期 （UTC） 的結束日期和時間。

upgradePauseEndTimestampUtc?: Date

屬性值

Date

upgradePauseStartTimestampUtc

指出在叢集上暫停自動運行時間版本升級的特定時間週期的開始日期和時間。

upgradePauseStartTimestampUtc?: Date

屬性值

Date

upgradeWave

指出發行新的叢集運行時間版本升級何時會套用。 根據預設為 Wave0。 只有在 upgradeMode 設定為 『Automatic』 時才適用。

upgradeWave?: string

屬性值

string

vmImage

已設定 VM 映像 VMSS。 您可以使用 Windows 或 Linux 等泛型名稱。

vmImage?: string

屬性值

string

vmssZonalUpgradeMode

此屬性會定義虛擬機擴展集的升級模式，如果新增具有多個可用性區域的節點類型，則為必要。

vmssZonalUpgradeMode?: string

屬性值

string

waveUpgradePaused

布爾值，以暫停自動運行時間版本升級至叢集。

waveUpgradePaused?: boolean

屬性值

boolean

繼承的屬性詳細資料

etag

Azure 資源 etag。 注意：這個屬性不會串行化。 它只能由伺服器填入。

etag?: string

屬性值

string

繼承自Resource.etag

id

Azure 資源標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自Resource.id

location

Azure 資源位置。

location: string

屬性值

string

繼承自Resource.location

name

Azure 資源名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自Resource.name

systemData

與建立和上次修改資源相關的元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

systemData?: SystemData

屬性值

SystemData

繼承自Resource.systemData

tags

Azure 資源標籤。

tags?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

繼承自Resource.tags

type

Azure 資源類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自Resource.type