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

Microsoft.ServiceFabric 群集

• 最新
• 2023-11-01-preview
• 2021-06-01
• 2020-12-01-preview
• 2020-03-01
• 2019-11-01-preview
• 2019-06-01-preview
• 2019-03-01
• 2019-03-01-preview
• 2018-02-01
• 2017-07-01-preview
• 2016-09-01

Bicep 资源定义

可以使用目标操作部署群集资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ServiceFabric/clusters 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ServiceFabric/clusters@2023-11-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    addOnFeatures: [
      'string'
    ]
    applicationTypeVersionsCleanupPolicy: {
      maxUnusedVersionsToKeep: int
    }
    azureActiveDirectory: {
      clientApplication: 'string'
      clusterApplication: 'string'
      tenantId: 'string'
    }
    certificate: {
      thumbprint: 'string'
      thumbprintSecondary: 'string'
      x509StoreName: 'string'
    }
    certificateCommonNames: {
      commonNames: [
        {
          certificateCommonName: 'string'
          certificateIssuerThumbprint: 'string'
        }
      ]
      x509StoreName: 'string'
    }
    clientCertificateCommonNames: [
      {
        certificateCommonName: 'string'
        certificateIssuerThumbprint: 'string'
        isAdmin: bool
      }
    ]
    clientCertificateThumbprints: [
      {
        certificateThumbprint: 'string'
        isAdmin: bool
      }
    ]
    clusterCodeVersion: 'string'
    diagnosticsStorageAccountConfig: {
      blobEndpoint: 'string'
      protectedAccountKeyName: 'string'
      protectedAccountKeyName2: 'string'
      queueEndpoint: 'string'
      storageAccountName: 'string'
      tableEndpoint: 'string'
    }
    enableHttpGatewayExclusiveAuthMode: bool
    eventStoreServiceEnabled: bool
    fabricSettings: [
      {
        name: 'string'
        parameters: [
          {
            name: 'string'
            value: 'string'
          }
        ]
      }
    ]
    infrastructureServiceManager: bool
    managementEndpoint: 'string'
    nodeTypes: [
      {
        applicationPorts: {
          endPort: int
          startPort: int
        }
        capacities: {
          {customized property}: 'string'
        }
        clientConnectionEndpointPort: int
        durabilityLevel: 'string'
        ephemeralPorts: {
          endPort: int
          startPort: int
        }
        httpGatewayEndpointPort: int
        httpGatewayTokenAuthEndpointPort: int
        isPrimary: bool
        isStateless: bool
        multipleAvailabilityZones: bool
        name: 'string'
        placementProperties: {
          {customized property}: 'string'
        }
        reverseProxyEndpointPort: int
        vmInstanceCount: int
      }
    ]
    notifications: [
      {
        isEnabled: bool
        notificationCategory: 'string'
        notificationLevel: 'string'
        notificationTargets: [
          {
            notificationChannel: 'string'
            receivers: [
              'string'
            ]
          }
        ]
      }
    ]
    reliabilityLevel: 'string'
    reverseProxyCertificate: {
      thumbprint: 'string'
      thumbprintSecondary: 'string'
      x509StoreName: 'string'
    }
    reverseProxyCertificateCommonNames: {
      commonNames: [
        {
          certificateCommonName: 'string'
          certificateIssuerThumbprint: 'string'
        }
      ]
      x509StoreName: 'string'
    }
    sfZonalUpgradeMode: 'string'
    upgradeDescription: {
      deltaHealthPolicy: {
        applicationDeltaHealthPolicies: {
          {customized property}: {
            defaultServiceTypeDeltaHealthPolicy: {
              maxPercentDeltaUnhealthyServices: int
            }
            serviceTypeDeltaHealthPolicies: {
              {customized property}: {
                maxPercentDeltaUnhealthyServices: int
              }
            }
          }
        }
        maxPercentDeltaUnhealthyApplications: int
        maxPercentDeltaUnhealthyNodes: int
        maxPercentUpgradeDomainDeltaUnhealthyNodes: int
      }
      forceRestart: bool
      healthCheckRetryTimeout: 'string'
      healthCheckStableDuration: 'string'
      healthCheckWaitDuration: 'string'
      healthPolicy: {
        applicationHealthPolicies: {
          {customized property}: {
            defaultServiceTypeHealthPolicy: {
              maxPercentUnhealthyServices: int
            }
            serviceTypeHealthPolicies: {
              {customized property}: {
                maxPercentUnhealthyServices: int
              }
            }
          }
        }
        maxPercentUnhealthyApplications: int
        maxPercentUnhealthyNodes: int
      }
      upgradeDomainTimeout: 'string'
      upgradeReplicaSetCheckTimeout: 'string'
      upgradeTimeout: 'string'
    }
    upgradeMode: 'string'
    upgradePauseEndTimestampUtc: 'string'
    upgradePauseStartTimestampUtc: 'string'
    upgradeWave: 'string'
    vmImage: 'string'
    vmssZonalUpgradeMode: 'string'
    waveUpgradePaused: bool
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

ApplicationDeltaHealthPolicy

名字	描述	价值
defaultServiceTypeDeltaHealthPolicy	升级群集时，默认用于评估服务类型的运行状况的增量运行状况策略。	ServiceTypeDeltaHealthPolicy
serviceTypeDeltaHealthPolicies	每个服务类型名称具有服务类型增量运行状况策略的映射。 默认情况下，地图为空。	ServiceTypeDeltaHealthPolicyMap

ApplicationDeltaHealthPolicyMap

名字	描述	价值

ApplicationHealthPolicy

名字	描述	价值
defaultServiceTypeHealthPolicy	默认情况下用于评估服务类型的运行状况的运行状况策略。	ServiceTypeHealthPolicy
serviceTypeHealthPolicies	每个服务类型名称具有服务类型运行状况策略的映射。 默认情况下，地图为空。	ServiceTypeHealthPolicyMap

ApplicationHealthPolicyMap

名字	描述	价值

ApplicationTypeVersionsCleanupPolicy

名字	描述	价值
maxUnusedVersionsToKeep	要保留的每个应用程序类型的未使用版本数。	int 约束： 最小值 = 0 （必需）

AzureActiveDirectory

名字	描述	价值
clientApplication	Azure Active Directory 客户端应用程序 ID。	字符串
clusterApplication	Azure Active Directory 群集应用程序 ID。	字符串
tenantId	Azure Active Directory 租户 ID。	字符串

CertificateDescription

名字	描述	价值
指纹	主证书的指纹。	string （必需）
thumbprintSecondary	辅助证书的指纹。	字符串
x509StoreName	本地证书存储位置。	“AddressBook” “AuthRoot” “CertificateAuthority” “不允许” “My” “Root” “TrustedPeople” “TrustedPublisher”

ClientCertificateCommonName

名字	描述	价值
certificateCommonName	客户端证书的公用名。	string （必需）
certificateIssuerThumbprint	客户端证书的颁发者指纹。	string （必需）
isAdmin	指示客户端证书是否具有对群集的管理员访问权限。 非管理员客户端只能在群集上执行只读操作。	bool （必需）

ClientCertificateThumbprint

名字	描述	价值
certificateThumbprint	客户端证书的指纹。	string （必需）
isAdmin	指示客户端证书是否具有对群集的管理员访问权限。 非管理员客户端只能在群集上执行只读操作。	bool （必需）

ClusterHealthPolicy

名字	描述	价值
applicationHealthPolicies	定义用于评估应用程序或其子实体之一运行状况的应用程序运行状况策略映射。	ApplicationHealthPolicyMap
maxPercentUnhealthyApplications	报告错误之前允许的最大不正常应用程序的百分比。 例如，若要允许 10 个应用程序% 运行不正常，此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的应用程序的最大允许百分比。 如果遵循百分比，但至少有一个不正常的应用程序，则运行状况将评估为“警告”。 这是通过除以群集中应用程序实例总数的不正常应用程序数（不包括 ApplicationTypeHealthPolicyMap 中包含的应用程序类型的应用程序）来计算的。 计算四舍五入，以容忍少量应用程序出现一次故障。 默认百分比为零。	int 约束： 最小值 = 0 最大值 = 100
maxPercentUnhealthyNodes	报告错误之前允许的最大不正常节点百分比。 例如，若要允许 10 个节点% 运行不正常，此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的节点的最大允许百分比。 如果遵循百分比，但至少有一个不正常的节点，则运行状况将评估为“警告”。 通过除以群集中节点总数的不正常节点数来计算百分比。 计算向上舍入，以容忍少量节点上的一次故障。 默认百分比为零。 在大型群集中，某些节点将始终关闭或退出进行修复，因此应将此百分比配置为容忍该百分比。	int 约束： 最小值 = 0 最大值 = 100

ClusterProperties

名字	描述	价值
addOnFeatures	在群集中启用的附加功能列表。	包含任一项的字符串数组： “BackupRestoreService” “DnsService” “RepairManager” “ResourceMonitorService”
applicationTypeVersionsCleanupPolicy	用于清理未使用版本的策略。	ApplicationTypeVersionsCleanupPolicy
azureActiveDirectory	群集的 AAD 身份验证设置。	AzureActiveDirectory
证书	用于保护群集的证书。 提供的证书将用于群集中的节点到节点安全性、群集管理终结点的 SSL 证书和默认管理客户端。	CertificateDescription
certificateCommonNames	描述由公用名称引用的服务器证书列表，这些证书用于保护群集。	ServerCertificateCommonNames
clientCertificateCommonNames	允许管理群集的公用名称引用的客户端证书列表。	ClientCertificateCommonName[]
clientCertificateThumbprints	允许管理群集的指纹引用的客户端证书列表。	ClientCertificateThumbprint[]
clusterCodeVersion	群集的 Service Fabric 运行时版本。 仅当 upgradeMode 设置为“Manual”时，此属性才能设置用户。 若要获取新群集的可用 Service Fabric 版本列表，请使用 ClusterVersion API。 若要获取现有群集的可用版本列表，请使用 availableClusterVersions。	字符串
diagnosticsStorageAccountConfig	用于存储 Service Fabric 诊断日志的存储帐户信息。	DiagnosticsStorageAccountConfig
enableHttpGatewayExclusiveAuthMode	如果为 true，则 HttpGatewayEndpoint 上不允许使用基于令牌的身份验证。 这需要支持 TLS 版本 1.3 及更高版本。 如果使用基于令牌的身份验证，则必须定义 HttpGatewayTokenAuthEndpointPort。	bool
eventStoreServiceEnabled	指示是否启用了事件存储服务。	bool
fabricSettings	要配置群集的自定义结构设置列表。	SettingsSectionDescription[]
infrastructureServiceManager	指示是否已启用基础结构服务管理器。	bool
managementEndpoint	群集的 http 管理终结点。	string （必需）
nodeTypes	群集中的节点类型列表。	NodeTypeDescription[] （必需）
通知	指示群集事件的通知通道列表。	通知[]
reliabilityLevel	可靠性级别设置系统服务的副本集大小。 了解 ReliabilityLevel。 - 无 - 运行目标副本集计数为 1 的系统服务。 这只应用于测试群集。 - 青铜 - 运行目标副本集计数为 3 的系统服务。 这只应用于测试群集。 - Silver - 运行目标副本集计数为 5 的系统服务。 - Gold - 运行目标副本集计数为 7 的系统服务。 - Platinum - 运行目标副本集计数为 9 的系统服务。	“铜牌” “Gold” “None” “Platinum” “Silver”
reverseProxyCertificate	反向代理使用的服务器证书。	CertificateDescription
reverseProxyCertificateCommonNames	描述由公用名称引用的服务器证书列表，这些证书用于保护群集。	ServerCertificateCommonNames
sfZonalUpgradeMode	此属性控制升级域中 VM 的逻辑分组（UD）。 如果群集中已存在具有多个可用性区域的节点类型，则无法修改此属性。	“分层” “Parallel”
upgradeDescription	升级群集时要使用的策略。	ClusterUpgradePolicy
upgradeMode	新的 Service Fabric 运行时版本可用时群集的升级模式。	“Automatic” “Manual”
upgradePauseEndTimestampUtc	指示在群集（UTC）的特定时间段内暂停群集上的自动运行时版本升级的结束日期和时间。	字符串
upgradePauseStartTimestampUtc	指示在群集（UTC）的特定时间段内暂停群集上的自动运行时版本升级的开始日期和时间。	字符串
upgradeWave	指示何时在发布群集运行时版本升级后应用新的群集运行时版本升级。 默认情况下为 Wave0。 仅当 upgradeMode 设置为“Automatic”时适用。	“Wave0” “Wave1” “Wave2”
vmImage	VM 映像 VMSS 已配置。 可以使用通用名称，例如 Windows 或 Linux。	字符串
vmssZonalUpgradeMode	此属性定义虚拟机规模集的升级模式，如果添加了具有多个可用性区域的节点类型，则是必需的。	“分层” “Parallel”
waveUpgradePaused	用于暂停自动运行时版本升级到群集的布尔值。	bool

ClusterUpgradeDeltaHealthPolicy

名字	描述	价值
applicationDeltaHealthPolicies	定义应用程序增量运行状况策略映射，用于在升级群集时评估应用程序或其子实体的运行状况。	ApplicationDeltaHealthPolicyMap
maxPercentDeltaUnhealthyApplications	群集升级期间允许的应用程序运行状况降级的最大百分比。 在升级开始时的应用程序状态与运行状况评估时应用程序的状态之间测量增量。 在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。 系统服务不包括在此服务中。	int 约束： 最小值 = 0 最大值 = 100 （必需）
maxPercentDeltaUnhealthyNodes	群集升级期间允许的最大节点运行状况降级百分比。 在升级开始时的节点状态与运行状况评估时节点的状态之间测量增量。 在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。	int 约束： 最小值 = 0 最大值 = 100 （必需）
maxPercentUpgradeDomainDeltaUnhealthyNodes	群集升级期间允许的最大升级域节点运行状况降级百分比。 在升级开始时的升级域节点的状态与运行状况评估时升级域节点的状态之间测量增量。 在完成所有已完成升级域的每个升级域后执行检查，以确保升级域的状态处于允许的限制范围内。	int 约束： 最小值 = 0 最大值 = 100 （必需）

ClusterUpgradePolicy

名字	描述	价值
deltaHealthPolicy	升级群集时使用的群集增量运行状况策略。	ClusterUpgradeDeltaHealthPolicy
forceRestart	如果为 true，则即使代码版本未更改（升级仅更改配置或数据），升级期间也会强制重启进程。	bool
healthCheckRetryTimeout	在升级回滚之前，当应用程序或群集运行不正常时重试运行状况评估的时间。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
healthCheckStableDuration	在升级继续到下一个升级域之前，应用程序或群集必须保持正常运行的时间量。 持续时间可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
healthCheckWaitDuration	完成升级域后等待的时间长度，然后执行运行状况检查。 持续时间可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
healthPolicy	升级群集时使用的群集运行状况策略。	ClusterHealthPolicy （必需）
upgradeDomainTimeout	在升级回滚之前，每个升级域必须完成的时间。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
upgradeReplicaSetCheckTimeout	阻止处理升级域的最大时间，并在出现意外问题时防止可用性丢失。 当此超时过期时，无论可用性丢失问题如何，升级域的处理都将继续进行。 超时是在每个升级域的开头重置的。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
upgradeTimeout	在升级回滚之前，整个升级必须完成的时间量。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）

DiagnosticsStorageAccountConfig

名字	描述	价值
blobEndpoint	Azure 存储帐户的 Blob 终结点。	string （必需）
protectedAccountKeyName	受保护的诊断存储密钥名称。	string （必需）
protectedAccountKeyName2	辅助保护的诊断存储密钥名称。 如果轮换其中一个存储帐户密钥，群集将回退到使用另一个密钥。	字符串
queueEndpoint	Azure 存储帐户的队列终结点。	string （必需）
storageAccountName	Azure 存储帐户名称。	string （必需）
tableEndpoint	Azure 存储帐户的表终结点。	string （必需）

EndpointRangeDescription

名字	描述	价值
endPort	一系列端口的结束端口	int （必需）
startPort	一系列端口的起始端口	int （必需）

Microsoft.ServiceFabric/clusters

名字	描述	价值
位置	Azure 资源位置。	string （必需）
名字	资源名称	string （必需）
性能	群集资源属性	ClusterProperties
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

NodeTypeDescription

名字	描述	价值
applicationPorts	群集分配端口到 Service Fabric 应用程序的端口范围。	EndpointRangeDescription
能力	应用于节点类型的节点的容量标记，群集资源管理器使用这些标记来了解节点拥有的资源量。	NodeTypeDescriptionCapacities
clientConnectionEndpointPort	TCP 群集管理终结点端口。	int （必需）
durabilityLevel	节点类型的持久性级别。 了解 DurabilityLevel。 - 青铜 - 无特权。 这是默认值。 - Silver - 每个 UD 可以暂停基础结构作业 10 分钟。 - 黄金 - 每个 UD 可以暂停基础结构作业 2 小时。 只能在完整节点 VM SKU（如 D15_V2、G5 等）上启用金级持续性。	“铜牌” “Gold” “Silver”
ephemeralPorts	应配置此节点类型的节点的临时端口范围。	EndpointRangeDescription
httpGatewayEndpointPort	HTTP 群集管理终结点端口。	int （必需）
httpGatewayTokenAuthEndpointPort	用于与群集建立基于令牌身份验证的 HTTPS 连接的端口。 不能设置为与 HttpGatewayEndpoint 相同的端口。	int
isPrimary	运行系统服务的节点类型。 只应将一个节点类型标记为主节点。 无法删除或更改现有群集的主节点类型。	bool （必需）
isStateless	指示节点类型是否只能托管无状态工作负荷。	bool
multipleAvailabilityZones	指示是否启用节点类型以支持多个区域。	bool
名字	节点类型的名称。	string （必需）
placementProperties	应用于节点类型的节点的放置标记，可用于指示某些服务（工作负荷）应运行的位置。	NodeTypeDescriptionPlacementProperties
reverseProxyEndpointPort	反向代理使用的终结点。	int
vmInstanceCount	VMInstanceCount 应为 1 到 n，其中 n 表示与此 nodeType 对应的 VM 实例数。 VMInstanceCount = 0 只能在以下方案中完成：NodeType 是辅助 nodeType。 持久性 = 青铜或持续性 >= 铜牌和 InfrastructureServiceManager = true。 如果 VMInstanceCount = 0，则表示此 nodeType 的 VM 不会用于初始群集大小计算。	int 约束： 最小值 = 0 最大值 = 2147483647 （必需）

NodeTypeDescriptionCapacities

名字	描述	价值

NodeTypeDescriptionPlacementProperties

名字	描述	价值

通知

名字	描述	价值
isEnabled	指示是否启用通知。	bool （必需）
notificationCategory	通知类别。	“WaveProgress”（必需）
notificationLevel	通知级别。	“All” “严重”（必需）
notificationTargets	订阅通知的目标列表。	NotificationTarget[] （必需）

NotificationTarget

名字	描述	价值
notificationChannel	通知通道指示订阅通知的接收方类型，即用户或订阅。	“EmailSubscription” “EmailUser”（必需）
接收机	订阅通知的目标列表。	string[] （必需）

ResourceTags

名字	描述	价值

ServerCertificateCommonName

名字	描述	价值
certificateCommonName	服务器证书的公用名。	string （必需）
certificateIssuerThumbprint	服务器证书的颁发者指纹。	string （必需）

ServerCertificateCommonNames

名字	描述	价值
commonNames	用于保护群集的公用名称引用的服务器证书列表。	ServerCertificateCommonName[]
x509StoreName	本地证书存储位置。	“AddressBook” “AuthRoot” “CertificateAuthority” “不允许” “My” “Root” “TrustedPeople” “TrustedPublisher”

ServiceTypeDeltaHealthPolicy

名字	描述	价值
maxPercentDeltaUnhealthyServices	群集升级期间允许的最大服务运行状况降级百分比。 在升级开始时的服务状态与运行状况评估时服务的状态之间测量增量。 在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。	int 约束： 最小值 = 0 最大值 = 100

ServiceTypeDeltaHealthPolicyMap

名字	描述	价值

ServiceTypeHealthPolicy

名字	描述	价值
maxPercentUnhealthyServices	在应用程序被视为错误之前，允许运行不正常的服务的最大百分比。	int 约束： 最小值 = 0 最大值 = 100

ServiceTypeHealthPolicyMap

名字	描述	价值

SettingsParameterDescription

名字	描述	价值
名字	构造设置的参数名称。	string （必需）
价值	构造设置的参数值。	string （必需）

SettingsSectionDescription

名字	描述	价值
名字	结构设置的节名称。	string （必需）
参数	节中的参数集合。	SettingsParameterDescription[] （必需）

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
部署 5 节点安全群集	使用此模板，可以在Standard_D2_v2大小 VMSS 上部署运行 Windows Server 2019 Datacenter 的安全 5 节点 Service Fabric 群集。

ARM 模板资源定义

可以使用目标操作部署群集资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ServiceFabric/clusters 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.ServiceFabric/clusters",
  "apiVersion": "2023-11-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "addOnFeatures": [ "string" ],
    "applicationTypeVersionsCleanupPolicy": {
      "maxUnusedVersionsToKeep": "int"
    },
    "azureActiveDirectory": {
      "clientApplication": "string",
      "clusterApplication": "string",
      "tenantId": "string"
    },
    "certificate": {
      "thumbprint": "string",
      "thumbprintSecondary": "string",
      "x509StoreName": "string"
    },
    "certificateCommonNames": {
      "commonNames": [
        {
          "certificateCommonName": "string",
          "certificateIssuerThumbprint": "string"
        }
      ],
      "x509StoreName": "string"
    },
    "clientCertificateCommonNames": [
      {
        "certificateCommonName": "string",
        "certificateIssuerThumbprint": "string",
        "isAdmin": "bool"
      }
    ],
    "clientCertificateThumbprints": [
      {
        "certificateThumbprint": "string",
        "isAdmin": "bool"
      }
    ],
    "clusterCodeVersion": "string",
    "diagnosticsStorageAccountConfig": {
      "blobEndpoint": "string",
      "protectedAccountKeyName": "string",
      "protectedAccountKeyName2": "string",
      "queueEndpoint": "string",
      "storageAccountName": "string",
      "tableEndpoint": "string"
    },
    "enableHttpGatewayExclusiveAuthMode": "bool",
    "eventStoreServiceEnabled": "bool",
    "fabricSettings": [
      {
        "name": "string",
        "parameters": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "infrastructureServiceManager": "bool",
    "managementEndpoint": "string",
    "nodeTypes": [
      {
        "applicationPorts": {
          "endPort": "int",
          "startPort": "int"
        },
        "capacities": {
          "{customized property}": "string"
        },
        "clientConnectionEndpointPort": "int",
        "durabilityLevel": "string",
        "ephemeralPorts": {
          "endPort": "int",
          "startPort": "int"
        },
        "httpGatewayEndpointPort": "int",
        "httpGatewayTokenAuthEndpointPort": "int",
        "isPrimary": "bool",
        "isStateless": "bool",
        "multipleAvailabilityZones": "bool",
        "name": "string",
        "placementProperties": {
          "{customized property}": "string"
        },
        "reverseProxyEndpointPort": "int",
        "vmInstanceCount": "int"
      }
    ],
    "notifications": [
      {
        "isEnabled": "bool",
        "notificationCategory": "string",
        "notificationLevel": "string",
        "notificationTargets": [
          {
            "notificationChannel": "string",
            "receivers": [ "string" ]
          }
        ]
      }
    ],
    "reliabilityLevel": "string",
    "reverseProxyCertificate": {
      "thumbprint": "string",
      "thumbprintSecondary": "string",
      "x509StoreName": "string"
    },
    "reverseProxyCertificateCommonNames": {
      "commonNames": [
        {
          "certificateCommonName": "string",
          "certificateIssuerThumbprint": "string"
        }
      ],
      "x509StoreName": "string"
    },
    "sfZonalUpgradeMode": "string",
    "upgradeDescription": {
      "deltaHealthPolicy": {
        "applicationDeltaHealthPolicies": {
          "{customized property}": {
            "defaultServiceTypeDeltaHealthPolicy": {
              "maxPercentDeltaUnhealthyServices": "int"
            },
            "serviceTypeDeltaHealthPolicies": {
              "{customized property}": {
                "maxPercentDeltaUnhealthyServices": "int"
              }
            }
          }
        },
        "maxPercentDeltaUnhealthyApplications": "int",
        "maxPercentDeltaUnhealthyNodes": "int",
        "maxPercentUpgradeDomainDeltaUnhealthyNodes": "int"
      },
      "forceRestart": "bool",
      "healthCheckRetryTimeout": "string",
      "healthCheckStableDuration": "string",
      "healthCheckWaitDuration": "string",
      "healthPolicy": {
        "applicationHealthPolicies": {
          "{customized property}": {
            "defaultServiceTypeHealthPolicy": {
              "maxPercentUnhealthyServices": "int"
            },
            "serviceTypeHealthPolicies": {
              "{customized property}": {
                "maxPercentUnhealthyServices": "int"
              }
            }
          }
        },
        "maxPercentUnhealthyApplications": "int",
        "maxPercentUnhealthyNodes": "int"
      },
      "upgradeDomainTimeout": "string",
      "upgradeReplicaSetCheckTimeout": "string",
      "upgradeTimeout": "string"
    },
    "upgradeMode": "string",
    "upgradePauseEndTimestampUtc": "string",
    "upgradePauseStartTimestampUtc": "string",
    "upgradeWave": "string",
    "vmImage": "string",
    "vmssZonalUpgradeMode": "string",
    "waveUpgradePaused": "bool"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

ApplicationDeltaHealthPolicy

名字	描述	价值
defaultServiceTypeDeltaHealthPolicy	升级群集时，默认用于评估服务类型的运行状况的增量运行状况策略。	ServiceTypeDeltaHealthPolicy
serviceTypeDeltaHealthPolicies	每个服务类型名称具有服务类型增量运行状况策略的映射。 默认情况下，地图为空。	ServiceTypeDeltaHealthPolicyMap

ApplicationDeltaHealthPolicyMap

名字	描述	价值

ApplicationHealthPolicy

名字	描述	价值
defaultServiceTypeHealthPolicy	默认情况下用于评估服务类型的运行状况的运行状况策略。	ServiceTypeHealthPolicy
serviceTypeHealthPolicies	每个服务类型名称具有服务类型运行状况策略的映射。 默认情况下，地图为空。	ServiceTypeHealthPolicyMap

ApplicationHealthPolicyMap

名字	描述	价值

ApplicationTypeVersionsCleanupPolicy

名字	描述	价值
maxUnusedVersionsToKeep	要保留的每个应用程序类型的未使用版本数。	int 约束： 最小值 = 0 （必需）

AzureActiveDirectory

名字	描述	价值
clientApplication	Azure Active Directory 客户端应用程序 ID。	字符串
clusterApplication	Azure Active Directory 群集应用程序 ID。	字符串
tenantId	Azure Active Directory 租户 ID。	字符串

CertificateDescription

名字	描述	价值
指纹	主证书的指纹。	string （必需）
thumbprintSecondary	辅助证书的指纹。	字符串
x509StoreName	本地证书存储位置。	“AddressBook” “AuthRoot” “CertificateAuthority” “不允许” “My” “Root” “TrustedPeople” “TrustedPublisher”

ClientCertificateCommonName

名字	描述	价值
certificateCommonName	客户端证书的公用名。	string （必需）
certificateIssuerThumbprint	客户端证书的颁发者指纹。	string （必需）
isAdmin	指示客户端证书是否具有对群集的管理员访问权限。 非管理员客户端只能在群集上执行只读操作。	bool （必需）

ClientCertificateThumbprint

名字	描述	价值
certificateThumbprint	客户端证书的指纹。	string （必需）
isAdmin	指示客户端证书是否具有对群集的管理员访问权限。 非管理员客户端只能在群集上执行只读操作。	bool （必需）

ClusterHealthPolicy

名字	描述	价值
applicationHealthPolicies	定义用于评估应用程序或其子实体之一运行状况的应用程序运行状况策略映射。	ApplicationHealthPolicyMap
maxPercentUnhealthyApplications	报告错误之前允许的最大不正常应用程序的百分比。 例如，若要允许 10 个应用程序% 运行不正常，此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的应用程序的最大允许百分比。 如果遵循百分比，但至少有一个不正常的应用程序，则运行状况将评估为“警告”。 这是通过除以群集中应用程序实例总数的不正常应用程序数（不包括 ApplicationTypeHealthPolicyMap 中包含的应用程序类型的应用程序）来计算的。 计算四舍五入，以容忍少量应用程序出现一次故障。 默认百分比为零。	int 约束： 最小值 = 0 最大值 = 100
maxPercentUnhealthyNodes	报告错误之前允许的最大不正常节点百分比。 例如，若要允许 10 个节点% 运行不正常，此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的节点的最大允许百分比。 如果遵循百分比，但至少有一个不正常的节点，则运行状况将评估为“警告”。 通过除以群集中节点总数的不正常节点数来计算百分比。 计算向上舍入，以容忍少量节点上的一次故障。 默认百分比为零。 在大型群集中，某些节点将始终关闭或退出进行修复，因此应将此百分比配置为容忍该百分比。	int 约束： 最小值 = 0 最大值 = 100

ClusterProperties

名字	描述	价值
addOnFeatures	在群集中启用的附加功能列表。	包含任一项的字符串数组： “BackupRestoreService” “DnsService” “RepairManager” “ResourceMonitorService”
applicationTypeVersionsCleanupPolicy	用于清理未使用版本的策略。	ApplicationTypeVersionsCleanupPolicy
azureActiveDirectory	群集的 AAD 身份验证设置。	AzureActiveDirectory
证书	用于保护群集的证书。 提供的证书将用于群集中的节点到节点安全性、群集管理终结点的 SSL 证书和默认管理客户端。	CertificateDescription
certificateCommonNames	描述由公用名称引用的服务器证书列表，这些证书用于保护群集。	ServerCertificateCommonNames
clientCertificateCommonNames	允许管理群集的公用名称引用的客户端证书列表。	ClientCertificateCommonName[]
clientCertificateThumbprints	允许管理群集的指纹引用的客户端证书列表。	ClientCertificateThumbprint[]
clusterCodeVersion	群集的 Service Fabric 运行时版本。 仅当 upgradeMode 设置为“Manual”时，此属性才能设置用户。 若要获取新群集的可用 Service Fabric 版本列表，请使用 ClusterVersion API。 若要获取现有群集的可用版本列表，请使用 availableClusterVersions。	字符串
diagnosticsStorageAccountConfig	用于存储 Service Fabric 诊断日志的存储帐户信息。	DiagnosticsStorageAccountConfig
enableHttpGatewayExclusiveAuthMode	如果为 true，则 HttpGatewayEndpoint 上不允许使用基于令牌的身份验证。 这需要支持 TLS 版本 1.3 及更高版本。 如果使用基于令牌的身份验证，则必须定义 HttpGatewayTokenAuthEndpointPort。	bool
eventStoreServiceEnabled	指示是否启用了事件存储服务。	bool
fabricSettings	要配置群集的自定义结构设置列表。	SettingsSectionDescription[]
infrastructureServiceManager	指示是否已启用基础结构服务管理器。	bool
managementEndpoint	群集的 http 管理终结点。	string （必需）
nodeTypes	群集中的节点类型列表。	NodeTypeDescription[] （必需）
通知	指示群集事件的通知通道列表。	通知[]
reliabilityLevel	可靠性级别设置系统服务的副本集大小。 了解 ReliabilityLevel。 - 无 - 运行目标副本集计数为 1 的系统服务。 这只应用于测试群集。 - 青铜 - 运行目标副本集计数为 3 的系统服务。 这只应用于测试群集。 - Silver - 运行目标副本集计数为 5 的系统服务。 - Gold - 运行目标副本集计数为 7 的系统服务。 - Platinum - 运行目标副本集计数为 9 的系统服务。	“铜牌” “Gold” “None” “Platinum” “Silver”
reverseProxyCertificate	反向代理使用的服务器证书。	CertificateDescription
reverseProxyCertificateCommonNames	描述由公用名称引用的服务器证书列表，这些证书用于保护群集。	ServerCertificateCommonNames
sfZonalUpgradeMode	此属性控制升级域中 VM 的逻辑分组（UD）。 如果群集中已存在具有多个可用性区域的节点类型，则无法修改此属性。	“分层” “Parallel”
upgradeDescription	升级群集时要使用的策略。	ClusterUpgradePolicy
upgradeMode	新的 Service Fabric 运行时版本可用时群集的升级模式。	“Automatic” “Manual”
upgradePauseEndTimestampUtc	指示在群集（UTC）的特定时间段内暂停群集上的自动运行时版本升级的结束日期和时间。	字符串
upgradePauseStartTimestampUtc	指示在群集（UTC）的特定时间段内暂停群集上的自动运行时版本升级的开始日期和时间。	字符串
upgradeWave	指示何时在发布群集运行时版本升级后应用新的群集运行时版本升级。 默认情况下为 Wave0。 仅当 upgradeMode 设置为“Automatic”时适用。	“Wave0” “Wave1” “Wave2”
vmImage	VM 映像 VMSS 已配置。 可以使用通用名称，例如 Windows 或 Linux。	字符串
vmssZonalUpgradeMode	此属性定义虚拟机规模集的升级模式，如果添加了具有多个可用性区域的节点类型，则是必需的。	“分层” “Parallel”
waveUpgradePaused	用于暂停自动运行时版本升级到群集的布尔值。	bool

ClusterUpgradeDeltaHealthPolicy

名字	描述	价值
applicationDeltaHealthPolicies	定义应用程序增量运行状况策略映射，用于在升级群集时评估应用程序或其子实体的运行状况。	ApplicationDeltaHealthPolicyMap
maxPercentDeltaUnhealthyApplications	群集升级期间允许的应用程序运行状况降级的最大百分比。 在升级开始时的应用程序状态与运行状况评估时应用程序的状态之间测量增量。 在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。 系统服务不包括在此服务中。	int 约束： 最小值 = 0 最大值 = 100 （必需）
maxPercentDeltaUnhealthyNodes	群集升级期间允许的最大节点运行状况降级百分比。 在升级开始时的节点状态与运行状况评估时节点的状态之间测量增量。 在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。	int 约束： 最小值 = 0 最大值 = 100 （必需）
maxPercentUpgradeDomainDeltaUnhealthyNodes	群集升级期间允许的最大升级域节点运行状况降级百分比。 在升级开始时的升级域节点的状态与运行状况评估时升级域节点的状态之间测量增量。 在完成所有已完成升级域的每个升级域后执行检查，以确保升级域的状态处于允许的限制范围内。	int 约束： 最小值 = 0 最大值 = 100 （必需）

ClusterUpgradePolicy

名字	描述	价值
deltaHealthPolicy	升级群集时使用的群集增量运行状况策略。	ClusterUpgradeDeltaHealthPolicy
forceRestart	如果为 true，则即使代码版本未更改（升级仅更改配置或数据），升级期间也会强制重启进程。	bool
healthCheckRetryTimeout	在升级回滚之前，当应用程序或群集运行不正常时重试运行状况评估的时间。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
healthCheckStableDuration	在升级继续到下一个升级域之前，应用程序或群集必须保持正常运行的时间量。 持续时间可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
healthCheckWaitDuration	完成升级域后等待的时间长度，然后执行运行状况检查。 持续时间可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
healthPolicy	升级群集时使用的群集运行状况策略。	ClusterHealthPolicy （必需）
upgradeDomainTimeout	在升级回滚之前，每个升级域必须完成的时间。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
upgradeReplicaSetCheckTimeout	阻止处理升级域的最大时间，并在出现意外问题时防止可用性丢失。 当此超时过期时，无论可用性丢失问题如何，升级域的处理都将继续进行。 超时是在每个升级域的开头重置的。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
upgradeTimeout	在升级回滚之前，整个升级必须完成的时间量。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）

DiagnosticsStorageAccountConfig

名字	描述	价值
blobEndpoint	Azure 存储帐户的 Blob 终结点。	string （必需）
protectedAccountKeyName	受保护的诊断存储密钥名称。	string （必需）
protectedAccountKeyName2	辅助保护的诊断存储密钥名称。 如果轮换其中一个存储帐户密钥，群集将回退到使用另一个密钥。	字符串
queueEndpoint	Azure 存储帐户的队列终结点。	string （必需）
storageAccountName	Azure 存储帐户名称。	string （必需）
tableEndpoint	Azure 存储帐户的表终结点。	string （必需）

EndpointRangeDescription

名字	描述	价值
endPort	一系列端口的结束端口	int （必需）
startPort	一系列端口的起始端口	int （必需）

Microsoft.ServiceFabric/clusters

名字	描述	价值
apiVersion	API 版本	'2023-11-01-preview'
位置	Azure 资源位置。	string （必需）
名字	资源名称	string （必需）
性能	群集资源属性	ClusterProperties
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.ServiceFabric/clusters”

NodeTypeDescription

名字	描述	价值
applicationPorts	群集分配端口到 Service Fabric 应用程序的端口范围。	EndpointRangeDescription
能力	应用于节点类型的节点的容量标记，群集资源管理器使用这些标记来了解节点拥有的资源量。	NodeTypeDescriptionCapacities
clientConnectionEndpointPort	TCP 群集管理终结点端口。	int （必需）
durabilityLevel	节点类型的持久性级别。 了解 DurabilityLevel。 - 青铜 - 无特权。 这是默认值。 - Silver - 每个 UD 可以暂停基础结构作业 10 分钟。 - 黄金 - 每个 UD 可以暂停基础结构作业 2 小时。 只能在完整节点 VM SKU（如 D15_V2、G5 等）上启用金级持续性。	“铜牌” “Gold” “Silver”
ephemeralPorts	应配置此节点类型的节点的临时端口范围。	EndpointRangeDescription
httpGatewayEndpointPort	HTTP 群集管理终结点端口。	int （必需）
httpGatewayTokenAuthEndpointPort	用于与群集建立基于令牌身份验证的 HTTPS 连接的端口。 不能设置为与 HttpGatewayEndpoint 相同的端口。	int
isPrimary	运行系统服务的节点类型。 只应将一个节点类型标记为主节点。 无法删除或更改现有群集的主节点类型。	bool （必需）
isStateless	指示节点类型是否只能托管无状态工作负荷。	bool
multipleAvailabilityZones	指示是否启用节点类型以支持多个区域。	bool
名字	节点类型的名称。	string （必需）
placementProperties	应用于节点类型的节点的放置标记，可用于指示某些服务（工作负荷）应运行的位置。	NodeTypeDescriptionPlacementProperties
reverseProxyEndpointPort	反向代理使用的终结点。	int
vmInstanceCount	VMInstanceCount 应为 1 到 n，其中 n 表示与此 nodeType 对应的 VM 实例数。 VMInstanceCount = 0 只能在以下方案中完成：NodeType 是辅助 nodeType。 持久性 = 青铜或持续性 >= 铜牌和 InfrastructureServiceManager = true。 如果 VMInstanceCount = 0，则表示此 nodeType 的 VM 不会用于初始群集大小计算。	int 约束： 最小值 = 0 最大值 = 2147483647 （必需）

NodeTypeDescriptionCapacities

名字	描述	价值

NodeTypeDescriptionPlacementProperties

名字	描述	价值

通知

名字	描述	价值
isEnabled	指示是否启用通知。	bool （必需）
notificationCategory	通知类别。	“WaveProgress”（必需）
notificationLevel	通知级别。	“All” “严重”（必需）
notificationTargets	订阅通知的目标列表。	NotificationTarget[] （必需）

NotificationTarget

名字	描述	价值
notificationChannel	通知通道指示订阅通知的接收方类型，即用户或订阅。	“EmailSubscription” “EmailUser”（必需）
接收机	订阅通知的目标列表。	string[] （必需）

ResourceTags

名字	描述	价值

ServerCertificateCommonName

名字	描述	价值
certificateCommonName	服务器证书的公用名。	string （必需）
certificateIssuerThumbprint	服务器证书的颁发者指纹。	string （必需）

ServerCertificateCommonNames

名字	描述	价值
commonNames	用于保护群集的公用名称引用的服务器证书列表。	ServerCertificateCommonName[]
x509StoreName	本地证书存储位置。	“AddressBook” “AuthRoot” “CertificateAuthority” “不允许” “My” “Root” “TrustedPeople” “TrustedPublisher”

ServiceTypeDeltaHealthPolicy

名字	描述	价值
maxPercentDeltaUnhealthyServices	群集升级期间允许的最大服务运行状况降级百分比。 在升级开始时的服务状态与运行状况评估时服务的状态之间测量增量。 在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。	int 约束： 最小值 = 0 最大值 = 100

ServiceTypeDeltaHealthPolicyMap

名字	描述	价值

ServiceTypeHealthPolicy

名字	描述	价值
maxPercentUnhealthyServices	在应用程序被视为错误之前，允许运行不正常的服务的最大百分比。	int 约束： 最小值 = 0 最大值 = 100

ServiceTypeHealthPolicyMap

名字	描述	价值

SettingsParameterDescription

名字	描述	价值
名字	构造设置的参数名称。	string （必需）
价值	构造设置的参数值。	string （必需）

SettingsSectionDescription

名字	描述	价值
名字	结构设置的节名称。	string （必需）
参数	节中的参数集合。	SettingsParameterDescription[] （必需）

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
部署启用了 NSG 的 3 Nodetype 安全群集	此模板允许在Standard_D2大小 VM 上部署运行 Windows Server 2016 数据中心的安全 3 节点类型 Service Fabric 群集。 使用此模板，可以使用网络安全组控制入站和出站网络流量。
部署 5 节点安全群集	使用此模板，可以在Standard_D2_v2大小 VMSS 上部署运行 Windows Server 2019 Datacenter 的安全 5 节点 Service Fabric 群集。
部署 5 节点 Ubuntu Service Fabric 群集	此模板允许在Standard_D2_V2大小 VMSS 上部署运行 Ubuntu 的安全 5 节点 Service Fabric 群集。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署群集资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ServiceFabric/clusters 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceFabric/clusters@2023-11-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      addOnFeatures = [
        "string"
      ]
      applicationTypeVersionsCleanupPolicy = {
        maxUnusedVersionsToKeep = int
      }
      azureActiveDirectory = {
        clientApplication = "string"
        clusterApplication = "string"
        tenantId = "string"
      }
      certificate = {
        thumbprint = "string"
        thumbprintSecondary = "string"
        x509StoreName = "string"
      }
      certificateCommonNames = {
        commonNames = [
          {
            certificateCommonName = "string"
            certificateIssuerThumbprint = "string"
          }
        ]
        x509StoreName = "string"
      }
      clientCertificateCommonNames = [
        {
          certificateCommonName = "string"
          certificateIssuerThumbprint = "string"
          isAdmin = bool
        }
      ]
      clientCertificateThumbprints = [
        {
          certificateThumbprint = "string"
          isAdmin = bool
        }
      ]
      clusterCodeVersion = "string"
      diagnosticsStorageAccountConfig = {
        blobEndpoint = "string"
        protectedAccountKeyName = "string"
        protectedAccountKeyName2 = "string"
        queueEndpoint = "string"
        storageAccountName = "string"
        tableEndpoint = "string"
      }
      enableHttpGatewayExclusiveAuthMode = bool
      eventStoreServiceEnabled = bool
      fabricSettings = [
        {
          name = "string"
          parameters = [
            {
              name = "string"
              value = "string"
            }
          ]
        }
      ]
      infrastructureServiceManager = bool
      managementEndpoint = "string"
      nodeTypes = [
        {
          applicationPorts = {
            endPort = int
            startPort = int
          }
          capacities = {
            {customized property} = "string"
          }
          clientConnectionEndpointPort = int
          durabilityLevel = "string"
          ephemeralPorts = {
            endPort = int
            startPort = int
          }
          httpGatewayEndpointPort = int
          httpGatewayTokenAuthEndpointPort = int
          isPrimary = bool
          isStateless = bool
          multipleAvailabilityZones = bool
          name = "string"
          placementProperties = {
            {customized property} = "string"
          }
          reverseProxyEndpointPort = int
          vmInstanceCount = int
        }
      ]
      notifications = [
        {
          isEnabled = bool
          notificationCategory = "string"
          notificationLevel = "string"
          notificationTargets = [
            {
              notificationChannel = "string"
              receivers = [
                "string"
              ]
            }
          ]
        }
      ]
      reliabilityLevel = "string"
      reverseProxyCertificate = {
        thumbprint = "string"
        thumbprintSecondary = "string"
        x509StoreName = "string"
      }
      reverseProxyCertificateCommonNames = {
        commonNames = [
          {
            certificateCommonName = "string"
            certificateIssuerThumbprint = "string"
          }
        ]
        x509StoreName = "string"
      }
      sfZonalUpgradeMode = "string"
      upgradeDescription = {
        deltaHealthPolicy = {
          applicationDeltaHealthPolicies = {
            {customized property} = {
              defaultServiceTypeDeltaHealthPolicy = {
                maxPercentDeltaUnhealthyServices = int
              }
              serviceTypeDeltaHealthPolicies = {
                {customized property} = {
                  maxPercentDeltaUnhealthyServices = int
                }
              }
            }
          }
          maxPercentDeltaUnhealthyApplications = int
          maxPercentDeltaUnhealthyNodes = int
          maxPercentUpgradeDomainDeltaUnhealthyNodes = int
        }
        forceRestart = bool
        healthCheckRetryTimeout = "string"
        healthCheckStableDuration = "string"
        healthCheckWaitDuration = "string"
        healthPolicy = {
          applicationHealthPolicies = {
            {customized property} = {
              defaultServiceTypeHealthPolicy = {
                maxPercentUnhealthyServices = int
              }
              serviceTypeHealthPolicies = {
                {customized property} = {
                  maxPercentUnhealthyServices = int
                }
              }
            }
          }
          maxPercentUnhealthyApplications = int
          maxPercentUnhealthyNodes = int
        }
        upgradeDomainTimeout = "string"
        upgradeReplicaSetCheckTimeout = "string"
        upgradeTimeout = "string"
      }
      upgradeMode = "string"
      upgradePauseEndTimestampUtc = "string"
      upgradePauseStartTimestampUtc = "string"
      upgradeWave = "string"
      vmImage = "string"
      vmssZonalUpgradeMode = "string"
      waveUpgradePaused = bool
    }
  })
}

属性值

ApplicationDeltaHealthPolicy

名字	描述	价值
defaultServiceTypeDeltaHealthPolicy	升级群集时，默认用于评估服务类型的运行状况的增量运行状况策略。	ServiceTypeDeltaHealthPolicy
serviceTypeDeltaHealthPolicies	每个服务类型名称具有服务类型增量运行状况策略的映射。 默认情况下，地图为空。	ServiceTypeDeltaHealthPolicyMap

ApplicationDeltaHealthPolicyMap

名字	描述	价值

ApplicationHealthPolicy

名字	描述	价值
defaultServiceTypeHealthPolicy	默认情况下用于评估服务类型的运行状况的运行状况策略。	ServiceTypeHealthPolicy
serviceTypeHealthPolicies	每个服务类型名称具有服务类型运行状况策略的映射。 默认情况下，地图为空。	ServiceTypeHealthPolicyMap

ApplicationHealthPolicyMap

名字	描述	价值

ApplicationTypeVersionsCleanupPolicy

名字	描述	价值
maxUnusedVersionsToKeep	要保留的每个应用程序类型的未使用版本数。	int 约束： 最小值 = 0 （必需）

AzureActiveDirectory

名字	描述	价值
clientApplication	Azure Active Directory 客户端应用程序 ID。	字符串
clusterApplication	Azure Active Directory 群集应用程序 ID。	字符串
tenantId	Azure Active Directory 租户 ID。	字符串

CertificateDescription

名字	描述	价值
指纹	主证书的指纹。	string （必需）
thumbprintSecondary	辅助证书的指纹。	字符串
x509StoreName	本地证书存储位置。	“AddressBook” “AuthRoot” “CertificateAuthority” “不允许” “My” “Root” “TrustedPeople” “TrustedPublisher”

ClientCertificateCommonName

名字	描述	价值
certificateCommonName	客户端证书的公用名。	string （必需）
certificateIssuerThumbprint	客户端证书的颁发者指纹。	string （必需）
isAdmin	指示客户端证书是否具有对群集的管理员访问权限。 非管理员客户端只能在群集上执行只读操作。	bool （必需）

ClientCertificateThumbprint

名字	描述	价值
certificateThumbprint	客户端证书的指纹。	string （必需）
isAdmin	指示客户端证书是否具有对群集的管理员访问权限。 非管理员客户端只能在群集上执行只读操作。	bool （必需）

ClusterHealthPolicy

名字	描述	价值
applicationHealthPolicies	定义用于评估应用程序或其子实体之一运行状况的应用程序运行状况策略映射。	ApplicationHealthPolicyMap
maxPercentUnhealthyApplications	报告错误之前允许的最大不正常应用程序的百分比。 例如，若要允许 10 个应用程序% 运行不正常，此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的应用程序的最大允许百分比。 如果遵循百分比，但至少有一个不正常的应用程序，则运行状况将评估为“警告”。 这是通过除以群集中应用程序实例总数的不正常应用程序数（不包括 ApplicationTypeHealthPolicyMap 中包含的应用程序类型的应用程序）来计算的。 计算四舍五入，以容忍少量应用程序出现一次故障。 默认百分比为零。	int 约束： 最小值 = 0 最大值 = 100
maxPercentUnhealthyNodes	报告错误之前允许的最大不正常节点百分比。 例如，若要允许 10 个节点% 运行不正常，此值将为 10。 该百分比表示在群集被视为错误之前可以运行不正常的节点的最大允许百分比。 如果遵循百分比，但至少有一个不正常的节点，则运行状况将评估为“警告”。 通过除以群集中节点总数的不正常节点数来计算百分比。 计算向上舍入，以容忍少量节点上的一次故障。 默认百分比为零。 在大型群集中，某些节点将始终关闭或退出进行修复，因此应将此百分比配置为容忍该百分比。	int 约束： 最小值 = 0 最大值 = 100

ClusterProperties

名字	描述	价值
addOnFeatures	在群集中启用的附加功能列表。	包含任一项的字符串数组： “BackupRestoreService” “DnsService” “RepairManager” “ResourceMonitorService”
applicationTypeVersionsCleanupPolicy	用于清理未使用版本的策略。	ApplicationTypeVersionsCleanupPolicy
azureActiveDirectory	群集的 AAD 身份验证设置。	AzureActiveDirectory
证书	用于保护群集的证书。 提供的证书将用于群集中的节点到节点安全性、群集管理终结点的 SSL 证书和默认管理客户端。	CertificateDescription
certificateCommonNames	描述由公用名称引用的服务器证书列表，这些证书用于保护群集。	ServerCertificateCommonNames
clientCertificateCommonNames	允许管理群集的公用名称引用的客户端证书列表。	ClientCertificateCommonName[]
clientCertificateThumbprints	允许管理群集的指纹引用的客户端证书列表。	ClientCertificateThumbprint[]
clusterCodeVersion	群集的 Service Fabric 运行时版本。 仅当 upgradeMode 设置为“Manual”时，此属性才能设置用户。 若要获取新群集的可用 Service Fabric 版本列表，请使用 ClusterVersion API。 若要获取现有群集的可用版本列表，请使用 availableClusterVersions。	字符串
diagnosticsStorageAccountConfig	用于存储 Service Fabric 诊断日志的存储帐户信息。	DiagnosticsStorageAccountConfig
enableHttpGatewayExclusiveAuthMode	如果为 true，则 HttpGatewayEndpoint 上不允许使用基于令牌的身份验证。 这需要支持 TLS 版本 1.3 及更高版本。 如果使用基于令牌的身份验证，则必须定义 HttpGatewayTokenAuthEndpointPort。	bool
eventStoreServiceEnabled	指示是否启用了事件存储服务。	bool
fabricSettings	要配置群集的自定义结构设置列表。	SettingsSectionDescription[]
infrastructureServiceManager	指示是否已启用基础结构服务管理器。	bool
managementEndpoint	群集的 http 管理终结点。	string （必需）
nodeTypes	群集中的节点类型列表。	NodeTypeDescription[] （必需）
通知	指示群集事件的通知通道列表。	通知[]
reliabilityLevel	可靠性级别设置系统服务的副本集大小。 了解 ReliabilityLevel。 - 无 - 运行目标副本集计数为 1 的系统服务。 这只应用于测试群集。 - 青铜 - 运行目标副本集计数为 3 的系统服务。 这只应用于测试群集。 - Silver - 运行目标副本集计数为 5 的系统服务。 - Gold - 运行目标副本集计数为 7 的系统服务。 - Platinum - 运行目标副本集计数为 9 的系统服务。	“铜牌” “Gold” “None” “Platinum” “Silver”
reverseProxyCertificate	反向代理使用的服务器证书。	CertificateDescription
reverseProxyCertificateCommonNames	描述由公用名称引用的服务器证书列表，这些证书用于保护群集。	ServerCertificateCommonNames
sfZonalUpgradeMode	此属性控制升级域中 VM 的逻辑分组（UD）。 如果群集中已存在具有多个可用性区域的节点类型，则无法修改此属性。	“分层” “Parallel”
upgradeDescription	升级群集时要使用的策略。	ClusterUpgradePolicy
upgradeMode	新的 Service Fabric 运行时版本可用时群集的升级模式。	“Automatic” “Manual”
upgradePauseEndTimestampUtc	指示在群集（UTC）的特定时间段内暂停群集上的自动运行时版本升级的结束日期和时间。	字符串
upgradePauseStartTimestampUtc	指示在群集（UTC）的特定时间段内暂停群集上的自动运行时版本升级的开始日期和时间。	字符串
upgradeWave	指示何时在发布群集运行时版本升级后应用新的群集运行时版本升级。 默认情况下为 Wave0。 仅当 upgradeMode 设置为“Automatic”时适用。	“Wave0” “Wave1” “Wave2”
vmImage	VM 映像 VMSS 已配置。 可以使用通用名称，例如 Windows 或 Linux。	字符串
vmssZonalUpgradeMode	此属性定义虚拟机规模集的升级模式，如果添加了具有多个可用性区域的节点类型，则是必需的。	“分层” “Parallel”
waveUpgradePaused	用于暂停自动运行时版本升级到群集的布尔值。	bool

ClusterUpgradeDeltaHealthPolicy

名字	描述	价值
applicationDeltaHealthPolicies	定义应用程序增量运行状况策略映射，用于在升级群集时评估应用程序或其子实体的运行状况。	ApplicationDeltaHealthPolicyMap
maxPercentDeltaUnhealthyApplications	群集升级期间允许的应用程序运行状况降级的最大百分比。 在升级开始时的应用程序状态与运行状况评估时应用程序的状态之间测量增量。 在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。 系统服务不包括在此服务中。	int 约束： 最小值 = 0 最大值 = 100 （必需）
maxPercentDeltaUnhealthyNodes	群集升级期间允许的最大节点运行状况降级百分比。 在升级开始时的节点状态与运行状况评估时节点的状态之间测量增量。 在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。	int 约束： 最小值 = 0 最大值 = 100 （必需）
maxPercentUpgradeDomainDeltaUnhealthyNodes	群集升级期间允许的最大升级域节点运行状况降级百分比。 在升级开始时的升级域节点的状态与运行状况评估时升级域节点的状态之间测量增量。 在完成所有已完成升级域的每个升级域后执行检查，以确保升级域的状态处于允许的限制范围内。	int 约束： 最小值 = 0 最大值 = 100 （必需）

ClusterUpgradePolicy

名字	描述	价值
deltaHealthPolicy	升级群集时使用的群集增量运行状况策略。	ClusterUpgradeDeltaHealthPolicy
forceRestart	如果为 true，则即使代码版本未更改（升级仅更改配置或数据），升级期间也会强制重启进程。	bool
healthCheckRetryTimeout	在升级回滚之前，当应用程序或群集运行不正常时重试运行状况评估的时间。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
healthCheckStableDuration	在升级继续到下一个升级域之前，应用程序或群集必须保持正常运行的时间量。 持续时间可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
healthCheckWaitDuration	完成升级域后等待的时间长度，然后执行运行状况检查。 持续时间可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
healthPolicy	升级群集时使用的群集运行状况策略。	ClusterHealthPolicy （必需）
upgradeDomainTimeout	在升级回滚之前，每个升级域必须完成的时间。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
upgradeReplicaSetCheckTimeout	阻止处理升级域的最大时间，并在出现意外问题时防止可用性丢失。 当此超时过期时，无论可用性丢失问题如何，升级域的处理都将继续进行。 超时是在每个升级域的开头重置的。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）
upgradeTimeout	在升级回滚之前，整个升级必须完成的时间量。 超时可以采用 hh：mm：ss 或 d.hh：mm：ss.ms 格式。	string （必需）

DiagnosticsStorageAccountConfig

名字	描述	价值
blobEndpoint	Azure 存储帐户的 Blob 终结点。	string （必需）
protectedAccountKeyName	受保护的诊断存储密钥名称。	string （必需）
protectedAccountKeyName2	辅助保护的诊断存储密钥名称。 如果轮换其中一个存储帐户密钥，群集将回退到使用另一个密钥。	字符串
queueEndpoint	Azure 存储帐户的队列终结点。	string （必需）
storageAccountName	Azure 存储帐户名称。	string （必需）
tableEndpoint	Azure 存储帐户的表终结点。	string （必需）

EndpointRangeDescription

名字	描述	价值
endPort	一系列端口的结束端口	int （必需）
startPort	一系列端口的起始端口	int （必需）

Microsoft.ServiceFabric/clusters

名字	描述	价值
位置	Azure 资源位置。	string （必需）
名字	资源名称	string （必需）
性能	群集资源属性	ClusterProperties
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.ServiceFabric/clusters@2023-11-01-preview”

NodeTypeDescription

名字	描述	价值
applicationPorts	群集分配端口到 Service Fabric 应用程序的端口范围。	EndpointRangeDescription
能力	应用于节点类型的节点的容量标记，群集资源管理器使用这些标记来了解节点拥有的资源量。	NodeTypeDescriptionCapacities
clientConnectionEndpointPort	TCP 群集管理终结点端口。	int （必需）
durabilityLevel	节点类型的持久性级别。 了解 DurabilityLevel。 - 青铜 - 无特权。 这是默认值。 - Silver - 每个 UD 可以暂停基础结构作业 10 分钟。 - 黄金 - 每个 UD 可以暂停基础结构作业 2 小时。 只能在完整节点 VM SKU（如 D15_V2、G5 等）上启用金级持续性。	“铜牌” “Gold” “Silver”
ephemeralPorts	应配置此节点类型的节点的临时端口范围。	EndpointRangeDescription
httpGatewayEndpointPort	HTTP 群集管理终结点端口。	int （必需）
httpGatewayTokenAuthEndpointPort	用于与群集建立基于令牌身份验证的 HTTPS 连接的端口。 不能设置为与 HttpGatewayEndpoint 相同的端口。	int
isPrimary	运行系统服务的节点类型。 只应将一个节点类型标记为主节点。 无法删除或更改现有群集的主节点类型。	bool （必需）
isStateless	指示节点类型是否只能托管无状态工作负荷。	bool
multipleAvailabilityZones	指示是否启用节点类型以支持多个区域。	bool
名字	节点类型的名称。	string （必需）
placementProperties	应用于节点类型的节点的放置标记，可用于指示某些服务（工作负荷）应运行的位置。	NodeTypeDescriptionPlacementProperties
reverseProxyEndpointPort	反向代理使用的终结点。	int
vmInstanceCount	VMInstanceCount 应为 1 到 n，其中 n 表示与此 nodeType 对应的 VM 实例数。 VMInstanceCount = 0 只能在以下方案中完成：NodeType 是辅助 nodeType。 持久性 = 青铜或持续性 >= 铜牌和 InfrastructureServiceManager = true。 如果 VMInstanceCount = 0，则表示此 nodeType 的 VM 不会用于初始群集大小计算。	int 约束： 最小值 = 0 最大值 = 2147483647 （必需）

NodeTypeDescriptionCapacities

名字	描述	价值

NodeTypeDescriptionPlacementProperties

名字	描述	价值

通知

名字	描述	价值
isEnabled	指示是否启用通知。	bool （必需）
notificationCategory	通知类别。	“WaveProgress”（必需）
notificationLevel	通知级别。	“All” “严重”（必需）
notificationTargets	订阅通知的目标列表。	NotificationTarget[] （必需）

NotificationTarget

名字	描述	价值
notificationChannel	通知通道指示订阅通知的接收方类型，即用户或订阅。	“EmailSubscription” “EmailUser”（必需）
接收机	订阅通知的目标列表。	string[] （必需）

ResourceTags

名字	描述	价值

ServerCertificateCommonName

名字	描述	价值
certificateCommonName	服务器证书的公用名。	string （必需）
certificateIssuerThumbprint	服务器证书的颁发者指纹。	string （必需）

ServerCertificateCommonNames

名字	描述	价值
commonNames	用于保护群集的公用名称引用的服务器证书列表。	ServerCertificateCommonName[]
x509StoreName	本地证书存储位置。	“AddressBook” “AuthRoot” “CertificateAuthority” “不允许” “My” “Root” “TrustedPeople” “TrustedPublisher”

ServiceTypeDeltaHealthPolicy

名字	描述	价值
maxPercentDeltaUnhealthyServices	群集升级期间允许的最大服务运行状况降级百分比。 在升级开始时的服务状态与运行状况评估时服务的状态之间测量增量。 在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。	int 约束： 最小值 = 0 最大值 = 100

ServiceTypeDeltaHealthPolicyMap

名字	描述	价值

ServiceTypeHealthPolicy

名字	描述	价值
maxPercentUnhealthyServices	在应用程序被视为错误之前，允许运行不正常的服务的最大百分比。	int 约束： 最小值 = 0 最大值 = 100

ServiceTypeHealthPolicyMap

名字	描述	价值

SettingsParameterDescription

名字	描述	价值
名字	构造设置的参数名称。	string （必需）
价值	构造设置的参数值。	string （必需）

SettingsSectionDescription

名字	描述	价值
名字	结构设置的节名称。	string （必需）
参数	节中的参数集合。	SettingsParameterDescription[] （必需）