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

Clusters - List

参考

服务:: Service Fabric

API 版本:: 2023-11-01-preview

获取在指定订阅中创建的 Service Fabric 群集资源的列表。
获取在订阅中创建或正在创建的所有 Service Fabric 群集资源。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters?api-version=2023-11-01-preview

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	客户订阅标识符。
api-version	query	True	string	Service Fabric 资源提供程序 API 的版本。这是一个必需参数，其值必须为此规范的“2023-11-01-preview”。

响应

名称	类型	说明
200 OK	ClusterListResult	作已成功完成。
Other Status Codes	ErrorModel	详细的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

List clusters

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/clusters?api-version=2023-11-01-preview

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicefabric import ServiceFabricManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicefabric
# USAGE
    python cluster_list_operation_example.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceFabricManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.clusters.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/examples/ClusterListOperation_example.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ServiceFabric.Models;
using Azure.ResourceManager.ServiceFabric;

// Generated from example definition: specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/examples/ClusterListOperation_example.json
// this example is just showing the usage of "Clusters_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (ServiceFabricClusterResource item in subscriptionResource.GetServiceFabricClustersAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ServiceFabricClusterData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "value": [
    {
      "type": "Microsoft.ServiceFabric/clusters",
      "location": "eastus",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster",
      "name": "myCluster",
      "tags": {},
      "etag": "W/\"636462502169240745\"",
      "properties": {
        "provisioningState": "Succeeded",
        "clusterId": "92584666-9889-4ae8-8d02-91902923d37f",
        "clusterCodeVersion": "6.1.480.9494",
        "clusterState": "WaitingForNodes",
        "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080",
        "clusterEndpoint": "https://eastus.servicefabric.azure.com",
        "certificateCommonNames": {
          "commonNames": [
            {
              "certificateCommonName": "abc.com",
              "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622"
            }
          ],
          "x509StoreName": "My"
        },
        "clientCertificateThumbprints": [
          {
            "isAdmin": false,
            "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A"
          }
        ],
        "clientCertificateCommonNames": [
          {
            "isAdmin": true,
            "certificateCommonName": "abc.com",
            "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A"
          }
        ],
        "fabricSettings": [
          {
            "name": "UpgradeService",
            "parameters": [
              {
                "name": "AppPollIntervalInSeconds",
                "value": "60"
              }
            ]
          }
        ],
        "upgradeDescription": {
          "forceRestart": false,
          "upgradeReplicaSetCheckTimeout": "00:10:00",
          "healthCheckWaitDuration": "00:00:30",
          "healthCheckStableDuration": "00:00:30",
          "healthCheckRetryTimeout": "00:05:00",
          "upgradeTimeout": "01:00:00",
          "upgradeDomainTimeout": "00:15:00",
          "healthPolicy": {
            "maxPercentUnhealthyNodes": 0,
            "maxPercentUnhealthyApplications": 0,
            "applicationHealthPolicies": {
              "fabric:/myApp1": {
                "defaultServiceTypeHealthPolicy": {
                  "maxPercentUnhealthyServices": 0
                },
                "serviceTypeHealthPolicies": {
                  "myServiceType1": {
                    "maxPercentUnhealthyServices": 100
                  }
                }
              }
            }
          },
          "deltaHealthPolicy": {
            "maxPercentDeltaUnhealthyNodes": 0,
            "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0,
            "maxPercentDeltaUnhealthyApplications": 0,
            "applicationDeltaHealthPolicies": {
              "fabric:/myApp1": {
                "defaultServiceTypeDeltaHealthPolicy": {
                  "maxPercentDeltaUnhealthyServices": 0
                },
                "serviceTypeDeltaHealthPolicies": {
                  "myServiceType1": {
                    "maxPercentDeltaUnhealthyServices": 0
                  }
                }
              }
            }
          }
        },
        "diagnosticsStorageAccountConfig": {
          "storageAccountName": "diag",
          "protectedAccountKeyName": "StorageAccountKey1",
          "blobEndpoint": "https://diag.blob.core.windows.net/",
          "queueEndpoint": "https://diag.queue.core.windows.net/",
          "tableEndpoint": "https://diag.table.core.windows.net/"
        },
        "nodeTypes": [
          {
            "name": "nt1vm",
            "clientConnectionEndpointPort": 19000,
            "httpGatewayEndpointPort": 19007,
            "applicationPorts": {
              "startPort": 20000,
              "endPort": 30000
            },
            "ephemeralPorts": {
              "startPort": 49000,
              "endPort": 64000
            },
            "isPrimary": true,
            "vmInstanceCount": 5,
            "durabilityLevel": "Bronze"
          }
        ],
        "vmImage": "Windows",
        "azureActiveDirectory": {
          "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c",
          "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae",
          "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75"
        },
        "reliabilityLevel": "Silver",
        "reverseProxyCertificateCommonNames": {
          "commonNames": [
            {
              "certificateCommonName": "abc.com",
              "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622"
            }
          ],
          "x509StoreName": "My"
        },
        "upgradeMode": "Manual",
        "availableClusterVersions": [
          {
            "codeVersion": "6.1.480.9494",
            "supportExpiryUtc": "2018-06-15T23:59:59.9999999",
            "environment": "Windows"
          }
        ],
        "addOnFeatures": [
          "RepairManager",
          "DnsService",
          "BackupRestoreService",
          "ResourceMonitorService"
        ]
      }
    },
    {
      "type": "Microsoft.ServiceFabric/clusters",
      "location": "eastus",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2",
      "name": "myCluster2",
      "tags": {},
      "etag": "W/\"636462502164040075\"",
      "properties": {
        "provisioningState": "Succeeded",
        "clusterId": "2747e469-b24e-4039-8a0a-46151419523f",
        "clusterCodeVersion": "6.1.187.1",
        "clusterState": "WaitingForNodes",
        "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080",
        "clusterEndpoint": "https://eastus.servicefabric.azure.com",
        "clientCertificateThumbprints": [],
        "clientCertificateCommonNames": [],
        "fabricSettings": [
          {
            "name": "UpgradeService",
            "parameters": [
              {
                "name": "AppPollIntervalInSeconds",
                "value": "60"
              }
            ]
          }
        ],
        "upgradeDescription": {
          "forceRestart": false,
          "upgradeReplicaSetCheckTimeout": "00:10:00",
          "healthCheckWaitDuration": "00:00:30",
          "healthCheckStableDuration": "00:00:30",
          "healthCheckRetryTimeout": "00:05:00",
          "upgradeTimeout": "01:00:00",
          "upgradeDomainTimeout": "00:15:00",
          "healthPolicy": {
            "maxPercentUnhealthyNodes": 0,
            "maxPercentUnhealthyApplications": 0
          },
          "deltaHealthPolicy": {
            "maxPercentDeltaUnhealthyNodes": 0,
            "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0,
            "maxPercentDeltaUnhealthyApplications": 0
          }
        },
        "diagnosticsStorageAccountConfig": {
          "storageAccountName": "diag",
          "protectedAccountKeyName": "StorageAccountKey1",
          "blobEndpoint": "https://diag.blob.core.windows.net/",
          "queueEndpoint": "https://diag.queue.core.windows.net/",
          "tableEndpoint": "https://diag.table.core.windows.net/"
        },
        "nodeTypes": [
          {
            "name": "nt1vm",
            "clientConnectionEndpointPort": 19000,
            "httpGatewayEndpointPort": 19007,
            "applicationPorts": {
              "startPort": 20000,
              "endPort": 30000
            },
            "ephemeralPorts": {
              "startPort": 49000,
              "endPort": 64000
            },
            "isPrimary": true,
            "vmInstanceCount": 5,
            "durabilityLevel": "Bronze"
          }
        ],
        "vmImage": "Ubuntu",
        "reliabilityLevel": "Silver",
        "upgradeMode": "Manual",
        "availableClusterVersions": [
          {
            "codeVersion": "6.1.187.1",
            "supportExpiryUtc": "2018-06-15T23:59:59.9999999",
            "environment": "Linux"
          }
        ],
        "addOnFeatures": [
          "RepairManager"
        ]
      }
    }
  ],
  "nextLink": ""
}

定义

名称	说明
AddOnFeatures	可用的群集加载项功能
ApplicationDeltaHealthPolicy	定义用于在升级群集时评估应用程序或其子实体的运行状况的增量运行状况策略。
ApplicationHealthPolicy	定义用于评估应用程序或其子实体之一的运行状况的运行状况策略。
ApplicationTypeVersionsCleanupPolicy
AzureActiveDirectory	在群集上启用 AAD 身份验证的设置。
CertificateDescription	描述证书详细信息。
ClientCertificateCommonName	使用公用名描述客户端证书详细信息。
ClientCertificateThumbprint	使用指纹描述客户端证书详细信息。
Cluster	群集资源
ClusterEnvironment	群集作系统，默认值为 Windows
ClusterHealthPolicy	定义用于评估群集或群集节点运行状况的运行状况策略。
ClusterListResult	群集列表结果
ClusterState	群集的当前状态。 WaitingForNodes - 指示已创建群集资源，并且资源提供程序正在等待 Service Fabric VM 扩展启动并报告给它。部署 - 指示在 VM 上安装 Service Fabric 运行时。群集资源将处于此状态，直到群集启动并启动系统服务。 BaselineUpgrade - 指示群集正在升级以建立群集版本。首次启动群集时，会自动启动此升级。 UpdateingUserConfiguration - 指示使用用户提供的配置升级群集。 UpdateingUserCertificate - 指示使用用户提供的证书升级群集。 UpdateingInfrastructure - 指示群集正在使用最新的 Service Fabric 运行时版本进行升级。仅当 upgradeMode 设置为“自动”时，才会发生这种情况。强制实施ClusterVersion - 指示群集与预期版本不同，并且群集正在升级到预期版本。 UpgradeServiceUnreachable - 指示群集中的系统服务不再轮询资源提供程序。处于此状态的群集不能由资源提供程序管理。自动缩放 - 指示正在调整群集的 ReliabilityLevel。就绪 - 指示群集处于稳定状态。
clusterUpgradeCadence	指示何时在发布群集运行时版本升级后应用新的群集运行时版本升级。默认情况下为 Wave0。仅当 upgradeMode 设置为“Automatic”时适用。
ClusterUpgradeDeltaHealthPolicy	描述群集升级的增量运行状况策略。
ClusterUpgradePolicy	描述升级群集时使用的策略。
ClusterVersionDetails	Service Fabric 运行时版本结果的详细信息
DiagnosticsStorageAccountConfig	用于存储 Service Fabric 诊断日志的存储帐户信息。
DurabilityLevel	节点类型的持久性级别。了解 DurabilityLevel。青铜 - 无特权。这是默认值。 Silver - 每个 UD 可以暂停基础结构作业 10 分钟。黄金 - 每个 UD 可以暂停基础结构作业 2 小时。只能在完整节点 VM SKU（如 D15_V2、G5 等）上启用金级持续性。
EndpointRangeDescription	端口范围详细信息
ErrorModel	错误的结构。
ErrorModelError	错误详细信息。
NodeTypeDescription	描述群集中的节点类型，每个节点类型表示群集中的子节点集。
Notification	描述群集事件的通知通道。
notificationCategory	通知类别。
notificationChannel	通知通道指示订阅通知的接收方类型，即用户或订阅。
notificationLevel	通知级别。
NotificationTarget	描述通知目标属性。
ProvisioningState	群集资源的预配状态。
ReliabilityLevel	可靠性级别设置系统服务的副本集大小。了解 ReliabilityLevel。无 - 运行目标副本集计数为 1 的系统服务。这只应用于测试群集。青铜 - 运行目标副本集计数为 3 的系统服务。这只应用于测试群集。 Silver - 运行目标副本集计数为 5 的系统服务。 Gold - 运行目标副本集计数为 7 的系统服务。 Platinum - 运行目标副本集计数为 9 的系统服务。
ServerCertificateCommonName	使用公用名描述服务器证书详细信息。
ServerCertificateCommonNames	描述由公用名称引用的服务器证书列表，这些证书用于保护群集。
ServiceTypeDeltaHealthPolicy	表示用于在升级群集时评估属于服务类型的服务的运行状况的增量运行状况策略。
ServiceTypeHealthPolicy	表示用于评估属于服务类型的服务的运行状况的运行状况策略。
SettingsParameterDescription	描述群集构造设置中的参数。
SettingsSectionDescription	介绍群集构造设置中的一部分。
sfZonalUpgradeMode	此属性控制升级域中 VM 的逻辑分组（UD）。如果群集中已存在具有多个可用性区域的节点类型，则无法修改此属性。
StoreName	本地证书存储位置。
SystemData	与创建和上次修改资源相关的元数据。
UpgradeMode	新的 Service Fabric 运行时版本可用时群集的升级模式。
vmssZonalUpgradeMode	此属性定义虚拟机规模集的升级模式，如果添加了具有多个可用性区域的节点类型，则是必需的。

AddOnFeatures

枚举

可用的群集加载项功能

值	说明
BackupRestoreService
DnsService
RepairManager
ResourceMonitorService

ApplicationDeltaHealthPolicy

Object

定义用于在升级群集时评估应用程序或其子实体的运行状况的增量运行状况策略。

名称	类型	说明
defaultServiceTypeDeltaHealthPolicy	ServiceTypeDeltaHealthPolicy	升级群集时，默认用于评估服务类型的运行状况的增量运行状况策略。
serviceTypeDeltaHealthPolicies	<string, ServiceTypeDeltaHealthPolicy>	每个服务类型名称具有服务类型增量运行状况策略的映射。默认情况下，地图为空。

ApplicationHealthPolicy

Object

定义用于评估应用程序或其子实体之一的运行状况的运行状况策略。

名称	类型	说明
defaultServiceTypeHealthPolicy	ServiceTypeHealthPolicy	默认情况下用于评估服务类型的运行状况的运行状况策略。
serviceTypeHealthPolicies	<string, ServiceTypeHealthPolicy>	每个服务类型名称具有服务类型运行状况策略的映射。默认情况下，地图为空。

ApplicationTypeVersionsCleanupPolicy

Object

名称	类型	说明
maxUnusedVersionsToKeep	integer (int64) minimum: 0	要保留的每个应用程序类型的未使用版本数。

AzureActiveDirectory

Object

在群集上启用 AAD 身份验证的设置。

名称	类型	说明
clientApplication	string	Azure Active Directory 客户端应用程序 ID。
clusterApplication	string	Azure Active Directory 群集应用程序 ID。
tenantId	string	Azure Active Directory 租户 ID。

CertificateDescription

Object

描述证书详细信息。

名称	类型	说明
thumbprint	string	主证书的指纹。
thumbprintSecondary	string	辅助证书的指纹。
x509StoreName	StoreName	本地证书存储位置。

ClientCertificateCommonName

Object

使用公用名描述客户端证书详细信息。

名称	类型	说明
certificateCommonName	string	客户端证书的公用名。
certificateIssuerThumbprint	string	客户端证书的颁发者指纹。
isAdmin	boolean	指示客户端证书是否具有对群集的管理员访问权限。非管理员客户端只能在群集上执行只读操作。

ClientCertificateThumbprint

Object

使用指纹描述客户端证书详细信息。

名称	类型	说明
certificateThumbprint	string	客户端证书的指纹。
isAdmin	boolean	指示客户端证书是否具有对群集的管理员访问权限。非管理员客户端只能在群集上执行只读操作。

Cluster

Object

群集资源

名称	类型	默认值	说明
etag	string		Azure 资源 etag。
id	string		Azure 资源标识符。
location	string		Azure 资源位置。
name	string		Azure 资源名称。
properties.addOnFeatures	AddOnFeatures[]		在群集中启用的附加功能列表。
properties.applicationTypeVersionsCleanupPolicy	ApplicationTypeVersionsCleanupPolicy		用于清理未使用版本的策略。
properties.availableClusterVersions	ClusterVersionDetails[]		此群集可用的 Service Fabric 运行时版本。
properties.azureActiveDirectory	AzureActiveDirectory		群集的 AAD 身份验证设置。
properties.certificate	CertificateDescription		用于保护群集的证书。提供的证书将用于群集中的节点到节点安全性、群集管理终结点的 SSL 证书和默认管理客户端。
properties.certificateCommonNames	ServerCertificateCommonNames		描述由公用名称引用的服务器证书列表，这些证书用于保护群集。
properties.clientCertificateCommonNames	ClientCertificateCommonName[]		允许管理群集的公用名称引用的客户端证书列表。
properties.clientCertificateThumbprints	ClientCertificateThumbprint[]		允许管理群集的指纹引用的客户端证书列表。
properties.clusterCodeVersion	string		群集的 Service Fabric 运行时版本。仅当 upgradeMode 设置为“Manual”时，此属性才能设置用户。若要获取新群集的可用 Service Fabric 版本列表，请使用 ClusterVersion API。若要获取现有群集的可用版本列表，请使用 availableClusterVersions。
properties.clusterEndpoint	string		Azure 资源提供程序终结点。群集中的系统服务连接到此终结点。
properties.clusterId	string		服务为群集资源生成了唯一标识符。
properties.clusterState	ClusterState		群集的当前状态。 WaitingForNodes - 指示已创建群集资源，并且资源提供程序正在等待 Service Fabric VM 扩展启动并报告给它。部署 - 指示在 VM 上安装 Service Fabric 运行时。群集资源将处于此状态，直到群集启动并启动系统服务。 BaselineUpgrade - 指示群集正在升级以建立群集版本。首次启动群集时，会自动启动此升级。 UpdateingUserConfiguration - 指示使用用户提供的配置升级群集。 UpdateingUserCertificate - 指示使用用户提供的证书升级群集。 UpdateingInfrastructure - 指示群集正在使用最新的 Service Fabric 运行时版本进行升级。仅当 upgradeMode 设置为“自动”时，才会发生这种情况。强制实施ClusterVersion - 指示群集与预期版本不同，并且群集正在升级到预期版本。 UpgradeServiceUnreachable - 指示群集中的系统服务不再轮询资源提供程序。处于此状态的群集不能由资源提供程序管理。自动缩放 - 指示正在调整群集的 ReliabilityLevel。就绪 - 指示群集处于稳定状态。
properties.diagnosticsStorageAccountConfig	DiagnosticsStorageAccountConfig		用于存储 Service Fabric 诊断日志的存储帐户信息。
properties.enableHttpGatewayExclusiveAuthMode	boolean		如果为 true，则 HttpGatewayEndpoint 上不允许使用基于令牌的身份验证。这需要支持 TLS 版本 1.3 及更高版本。如果使用基于令牌的身份验证，则必须定义 HttpGatewayTokenAuthEndpointPort。
properties.eventStoreServiceEnabled	boolean		指示是否启用了事件存储服务。
properties.fabricSettings	SettingsSectionDescription[]		要配置群集的自定义结构设置列表。
properties.infrastructureServiceManager	boolean		指示是否已启用基础结构服务管理器。
properties.managementEndpoint	string		群集的 http 管理终结点。
properties.nodeTypes	NodeTypeDescription[]		群集中的节点类型列表。
properties.notifications	Notification[]		指示群集事件的通知通道列表。
properties.provisioningState	ProvisioningState		群集资源的预配状态。
properties.reliabilityLevel	ReliabilityLevel		可靠性级别设置系统服务的副本集大小。了解 ReliabilityLevel。无 - 运行目标副本集计数为 1 的系统服务。这只应用于测试群集。青铜 - 运行目标副本集计数为 3 的系统服务。这只应用于测试群集。 Silver - 运行目标副本集计数为 5 的系统服务。 Gold - 运行目标副本集计数为 7 的系统服务。 Platinum - 运行目标副本集计数为 9 的系统服务。
properties.reverseProxyCertificate	CertificateDescription		反向代理使用的服务器证书。
properties.reverseProxyCertificateCommonNames	ServerCertificateCommonNames		描述由公用名称引用的服务器证书列表，这些证书用于保护群集。
properties.sfZonalUpgradeMode	sfZonalUpgradeMode		此属性控制升级域中 VM 的逻辑分组（UD）。如果群集中已存在具有多个可用性区域的节点类型，则无法修改此属性。
properties.upgradeDescription	ClusterUpgradePolicy		升级群集时要使用的策略。
properties.upgradeMode	UpgradeMode	Automatic	新的 Service Fabric 运行时版本可用时群集的升级模式。
properties.upgradePauseEndTimestampUtc	string (date-time)		指示在群集（UTC）的特定时间段内暂停群集上的自动运行时版本升级的结束日期和时间。
properties.upgradePauseStartTimestampUtc	string (date-time)		指示在群集（UTC）的特定时间段内暂停群集上的自动运行时版本升级的开始日期和时间。
properties.upgradeWave	clusterUpgradeCadence		指示何时在发布群集运行时版本升级后应用新的群集运行时版本升级。默认情况下为 Wave0。仅当 upgradeMode 设置为“Automatic”时适用。
properties.vmImage	string		VM 映像 VMSS 已配置。可以使用通用名称，例如 Windows 或 Linux。
properties.vmssZonalUpgradeMode	vmssZonalUpgradeMode		此属性定义虚拟机规模集的升级模式，如果添加了具有多个可用性区域的节点类型，则是必需的。
properties.waveUpgradePaused	boolean		用于暂停自动运行时版本升级到群集的布尔值。
systemData	SystemData		与创建和上次修改资源相关的元数据。
tags	object		Azure 资源标记。
type	string		Azure 资源类型。

ClusterEnvironment

枚举

群集作系统，默认值为 Windows

值	说明
Linux
Windows

ClusterHealthPolicy

Object

定义用于评估群集或群集节点运行状况的运行状况策略。

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

名称

类型

默认值

说明

applicationHealthPolicies

<string, ApplicationHealthPolicy>

定义用于评估应用程序或其子实体之一运行状况的应用程序运行状况策略映射。

maxPercentUnhealthyApplications

integer (int32)

minimum: 0
maximum: 100

报告错误之前允许的最大不正常应用程序的百分比。例如，若要允许 10 个应用程序% 运行不正常，此值将为 10。

该百分比表示在群集被视为错误之前可以运行不正常的应用程序的最大允许百分比。如果遵循百分比，但至少有一个不正常的应用程序，则运行状况将评估为“警告”。这是通过除以群集中应用程序实例总数的不正常应用程序数（不包括 ApplicationTypeHealthPolicyMap 中包含的应用程序类型的应用程序）来计算的。计算四舍五入，以容忍少量应用程序出现一次故障。默认百分比为零。

maxPercentUnhealthyNodes

integer (int32)

minimum: 0
maximum: 100

报告错误之前允许的最大不正常节点百分比。例如，若要允许 10 个节点% 运行不正常，此值将为 10。

该百分比表示在群集被视为错误之前可以运行不正常的节点的最大允许百分比。如果遵循百分比，但至少有一个不正常的节点，则运行状况将评估为“警告”。通过除以群集中节点总数的不正常节点数来计算百分比。计算向上舍入，以容忍少量节点上的一次故障。默认百分比为零。

在大型群集中，某些节点将始终关闭或退出进行修复，因此应将此百分比配置为容忍该百分比。

ClusterListResult

Object

群集列表结果

名称	类型	说明
nextLink	string	用于获取下一组结果的 URL。
value	Cluster[]	群集资源

ClusterState

枚举

群集的当前状态。

WaitingForNodes - 指示已创建群集资源，并且资源提供程序正在等待 Service Fabric VM 扩展启动并报告给它。
部署 - 指示在 VM 上安装 Service Fabric 运行时。群集资源将处于此状态，直到群集启动并启动系统服务。
BaselineUpgrade - 指示群集正在升级以建立群集版本。首次启动群集时，会自动启动此升级。
UpdateingUserConfiguration - 指示使用用户提供的配置升级群集。
UpdateingUserCertificate - 指示使用用户提供的证书升级群集。
UpdateingInfrastructure - 指示群集正在使用最新的 Service Fabric 运行时版本进行升级。仅当 upgradeMode 设置为“自动”时，才会发生这种情况。
强制实施ClusterVersion - 指示群集与预期版本不同，并且群集正在升级到预期版本。
UpgradeServiceUnreachable - 指示群集中的系统服务不再轮询资源提供程序。处于此状态的群集不能由资源提供程序管理。
自动缩放 - 指示正在调整群集的 ReliabilityLevel。
就绪 - 指示群集处于稳定状态。

值	说明
AutoScale
BaselineUpgrade
Deploying
EnforcingClusterVersion
Ready
UpdatingInfrastructure
UpdatingUserCertificate
UpdatingUserConfiguration
UpgradeServiceUnreachable
WaitingForNodes

clusterUpgradeCadence

枚举

指示何时在发布群集运行时版本升级后应用新的群集运行时版本升级。默认情况下为 Wave0。仅当 upgradeMode 设置为“Automatic”时适用。

值	说明
Wave0	推出新版本后，群集升级会立即启动。建议用于测试/开发群集。
Wave1	在推出新版本后 7 天启动群集升级。建议用于预生产群集。
Wave2	在推出新版本后 14 天开始群集升级。建议用于生产群集。

ClusterUpgradeDeltaHealthPolicy

Object

描述群集升级的增量运行状况策略。

名称	类型	说明
applicationDeltaHealthPolicies	<string, ApplicationDeltaHealthPolicy>	定义应用程序增量运行状况策略映射，用于在升级群集时评估应用程序或其子实体的运行状况。
maxPercentDeltaUnhealthyApplications	integer (int32) minimum: 0 maximum: 100	群集升级期间允许的应用程序运行状况降级的最大百分比。在升级开始时的应用程序状态与运行状况评估时应用程序的状态之间测量增量。在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。系统服务不包括在此服务中。
maxPercentDeltaUnhealthyNodes	integer (int32) minimum: 0 maximum: 100	群集升级期间允许的最大节点运行状况降级百分比。在升级开始时的节点状态与运行状况评估时节点的状态之间测量增量。在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。
maxPercentUpgradeDomainDeltaUnhealthyNodes	integer (int32) minimum: 0 maximum: 100	群集升级期间允许的最大升级域节点运行状况降级百分比。在升级开始时的升级域节点的状态与运行状况评估时升级域节点的状态之间测量增量。在完成所有已完成升级域的每个升级域后执行检查，以确保升级域的状态处于允许的限制范围内。

ClusterUpgradePolicy

Object

描述升级群集时使用的策略。

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

ClusterVersionDetails

Object

Service Fabric 运行时版本结果的详细信息

名称	类型	说明
codeVersion	string	群集的 Service Fabric 运行时版本。
environment	ClusterEnvironment	指示此版本是否适用于 Windows 或 Linux 操作系统。
supportExpiryUtc	string	版本的支持到期日期。

DiagnosticsStorageAccountConfig

Object

用于存储 Service Fabric 诊断日志的存储帐户信息。

名称	类型	说明
blobEndpoint	string	Azure 存储帐户的 Blob 终结点。
protectedAccountKeyName	string	受保护的诊断存储密钥名称。
protectedAccountKeyName2	string	辅助保护的诊断存储密钥名称。如果轮换其中一个存储帐户密钥，群集将回退到使用另一个密钥。
queueEndpoint	string	Azure 存储帐户的队列终结点。
storageAccountName	string	Azure 存储帐户名称。
tableEndpoint	string	Azure 存储帐户的表终结点。

DurabilityLevel

枚举

节点类型的持久性级别。了解 DurabilityLevel。

青铜 - 无特权。这是默认值。
Silver - 每个 UD 可以暂停基础结构作业 10 分钟。
黄金 - 每个 UD 可以暂停基础结构作业 2 小时。只能在完整节点 VM SKU（如 D15_V2、G5 等）上启用金级持续性。

值	说明
Bronze
Gold
Silver

EndpointRangeDescription

Object

端口范围详细信息

名称	类型	说明
endPort	integer (int32)	一系列端口的结束端口
startPort	integer (int32)	一系列端口的起始端口

ErrorModel

Object

错误的结构。

名称	类型	说明
error	ErrorModelError	错误详细信息。

ErrorModelError

Object

错误详细信息。

名称	类型	说明
code	string	错误代码。
message	string	错误消息。

NodeTypeDescription

Object

描述群集中的节点类型，每个节点类型表示群集中的子节点集。

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

Notification

Object

描述群集事件的通知通道。

名称	类型	说明
isEnabled	boolean	指示是否启用通知。
notificationCategory	notificationCategory	通知类别。
notificationLevel	notificationLevel	通知级别。
notificationTargets	NotificationTarget[]	订阅通知的目标列表。

notificationCategory

枚举

通知类别。

值	说明
WaveProgress	通知将涉及波形进度。

notificationChannel

枚举

通知通道指示订阅通知的接收方类型，即用户或订阅。

值	说明
EmailSubscription	对于订阅接收器。在这种情况下，参数接收器应是群集订阅的角色列表（例如。将接收通知的所有者、AccountAdmin 等。
EmailUser	对于电子邮件用户接收方。在这种情况下，参数接收器应是将接收通知的电子邮件地址列表。

notificationLevel

枚举

通知级别。

值	说明
All	接收所有通知。
Critical	仅接收关键通知。

NotificationTarget

Object

描述通知目标属性。

名称	类型	说明
notificationChannel	notificationChannel	通知通道指示订阅通知的接收方类型，即用户或订阅。
receivers	string[]	订阅通知的目标列表。

ProvisioningState

枚举

群集资源的预配状态。

值	说明
Canceled
Failed
Succeeded
Updating

ReliabilityLevel

枚举

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

无 - 运行目标副本集计数为 1 的系统服务。这只应用于测试群集。
青铜 - 运行目标副本集计数为 3 的系统服务。这只应用于测试群集。
Silver - 运行目标副本集计数为 5 的系统服务。
Gold - 运行目标副本集计数为 7 的系统服务。
Platinum - 运行目标副本集计数为 9 的系统服务。

值	说明
Bronze
Gold
None
Platinum
Silver

ServerCertificateCommonName

Object

使用公用名描述服务器证书详细信息。

名称	类型	说明
certificateCommonName	string	服务器证书的公用名。
certificateIssuerThumbprint	string	服务器证书的颁发者指纹。

ServerCertificateCommonNames

Object

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

名称	类型	说明
commonNames	ServerCertificateCommonName[]	用于保护群集的公用名称引用的服务器证书列表。
x509StoreName	StoreName	本地证书存储位置。

ServiceTypeDeltaHealthPolicy

Object

表示用于在升级群集时评估属于服务类型的服务的运行状况的增量运行状况策略。

名称	类型	默认值	说明
maxPercentDeltaUnhealthyServices	integer (int32) minimum: 0 maximum: 100	0	群集升级期间允许的最大服务运行状况降级百分比。在升级开始时的服务状态与运行状况评估时服务的状态之间测量增量。在完成每个升级域后执行检查，以确保群集的全局状态处于允许的限制范围内。

ServiceTypeHealthPolicy

Object

表示用于评估属于服务类型的服务的运行状况的运行状况策略。

名称	类型	默认值	说明
maxPercentUnhealthyServices	integer (int32) minimum: 0 maximum: 100	0	在应用程序被视为错误之前，允许运行不正常的服务的最大百分比。

SettingsParameterDescription

Object

描述群集构造设置中的参数。

名称	类型	说明
name	string	构造设置的参数名称。
value	string	构造设置的参数值。

SettingsSectionDescription

Object

介绍群集构造设置中的一部分。

名称	类型	说明
name	string	结构设置的节名称。
parameters	SettingsParameterDescription[]	节中的参数集合。

sfZonalUpgradeMode

枚举

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

值	说明
Hierarchical	如果省略此值或设置为“分层”，则会将 VM 分组以反映最多 15 个 UD 的区域性分布。三个区域各有五个 UD。这样可以确保一次更新一个区域，仅在第一个区域内完成五个 UD 之后才移动到下一个区域。此更新过程对于群集和用户应用程序更安全。
Parallel	节点类型下的 VM 分组到 UD 中，并忽略五个 UD 中的区域信息。此设置会导致所有区域中的 UD 同时升级。此部署模式对于升级速度更快，不建议这样做，因为它不符合 SDP 准则，即更新应一次应用于一个区域。

StoreName

枚举

本地证书存储位置。

值	说明
AddressBook
AuthRoot
CertificateAuthority
Disallowed
My
Root
TrustedPeople
TrustedPublisher

SystemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	string	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	string	上次修改资源的标识的类型。

UpgradeMode

枚举

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

值	说明
Automatic	群集将自动升级到最新的 Service Fabric 运行时版本，upgradeWave 将确定新版本可用后升级何时开始。
Manual	群集不会自动升级到最新的 Service Fabric 运行时版本。通过在群集资源中设置 clusterCodeVersion 属性来升级群集。

vmssZonalUpgradeMode

枚举

此属性定义虚拟机规模集的升级模式，如果添加了具有多个可用性区域的节点类型，则是必需的。

值	说明
Hierarchical	VM 分组以反映最多 15 个 UD 的区域性分布。三个区域各有五个 UD。这样可以确保一次更新一个区域，仅在第一个区域内完成五个 UD 之后才移动到下一个区域。
Parallel	虚拟机规模集的所有可用性区域中将同时进行更新。