你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 设置为“Automatic”时，才会发生这种情况。 强制实施 ClusterVersion - 指示群集的版本与预期版本不同，并且群集正在升级到预期的版本。 UpgradeServiceUnreachable - 指示群集中的系统服务不再轮询资源提供程序。 处于此状态的群集不能由资源提供程序管理。 自动缩放 - 指示正在调整群集的 ReliabilityLevel。 就绪 - 指示群集处于稳定状态。 注意：此属性不会序列化。 它只能由服务器填充。
diagnosticsStorageAccountConfig	用于存储 Service Fabric 诊断日志的存储帐户信息。
eventStoreServiceEnabled	指示是否启用了事件存储服务。
fabricSettings	用于配置群集的自定义结构设置的列表。
infrastructureServiceManager	指示是否启用了基础结构服务管理器。
managementEndpoint	群集的 http 管理终结点。
nodeTypes	群集中的节点类型列表。
notifications	指示群集事件的通知通道列表。
provisioningState	群集资源的预配状态。 注意：此属性不会序列化。 它只能由服务器填充。
reliabilityLevel	可靠性级别设置系统服务的副本 (replica) 集大小。 了解 ReliabilityLevel。 无 - 运行目标为 1 的系统服务副本 (replica) 计数。 这只能用于测试群集。 青铜 - 运行目标副本 (replica) 计数为 3 的系统服务。 这只能用于测试群集。 Silver - 运行目标副本 (replica) 计数为 5 的系统服务。 黄金 - 运行目标副本 (replica) 计数设置为 7 的系统服务。 Platinum - 运行目标副本 (replica) 计数为 9 的系统服务。
reverseProxyCertificate	反向代理使用的服务器证书。
reverseProxyCertificateCommonNames	描述用于保护群集的公用名称引用的服务器证书的列表。
sfZonalUpgradeMode	此属性控制升级域 (UD) 中虚拟机的逻辑分组。 如果群集中已存在具有多个可用性区域的节点类型，则无法修改此属性。
upgradeDescription	升级群集时要使用的策略。
upgradeMode	新的 Service Fabric 运行时版本可用时群集的升级模式。
upgradePauseEndTimestampUtc	指示在群集上在特定时间段内暂停群集上的自动运行时版本升级的结束日期和时间， (UTC) 。
upgradePauseStartTimestampUtc	指示在群集上在特定时间段内暂停群集上的自动运行时版本升级的开始日期和时间， (UTC) 。
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 设置为“Automatic”时，才会发生这种情况。
• 强制实施 ClusterVersion - 指示群集的版本与预期版本不同，并且群集正在升级到预期的版本。
• 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

可靠性级别设置系统服务的副本 (replica) 集大小。 了解 ReliabilityLevel。

• 无 - 运行目标为 1 的系统服务副本 (replica) 计数。 这只能用于测试群集。
• 青铜 - 运行目标副本 (replica) 计数为 3 的系统服务。 这只能用于测试群集。
• Silver - 运行目标副本 (replica) 计数为 5 的系统服务。
• 黄金 - 运行目标副本 (replica) 计数设置为 7 的系统服务。
• Platinum - 运行目标副本 (replica) 计数为 9 的系统服务。

reliabilityLevel?: string

属性值

string

reverseProxyCertificate

反向代理使用的服务器证书。

reverseProxyCertificate?: CertificateDescription

属性值

CertificateDescription

reverseProxyCertificateCommonNames

描述用于保护群集的公用名称引用的服务器证书的列表。

reverseProxyCertificateCommonNames?: ServerCertificateCommonNames

属性值

ServerCertificateCommonNames

sfZonalUpgradeMode

此属性控制升级域 (UD) 中虚拟机的逻辑分组。 如果群集中已存在具有多个可用性区域的节点类型，则无法修改此属性。

sfZonalUpgradeMode?: string

属性值

string

upgradeDescription

升级群集时要使用的策略。

upgradeDescription?: ClusterUpgradePolicy

属性值

ClusterUpgradePolicy

upgradeMode

新的 Service Fabric 运行时版本可用时群集的升级模式。

upgradeMode?: string

属性值

string

upgradePauseEndTimestampUtc

指示在群集上在特定时间段内暂停群集上的自动运行时版本升级的结束日期和时间， (UTC) 。

upgradePauseEndTimestampUtc?: Date

属性值

Date

upgradePauseStartTimestampUtc

指示在群集上在特定时间段内暂停群集上的自动运行时版本升级的开始日期和时间， (UTC) 。

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