共用方式為


Managed Clusters - Create Or Update

建立或更新 Service Fabric 受控叢集資源。
Create 或更新具有指定名稱的 Service Fabric 受控叢集資源。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}?api-version=2024-04-01

URI 參數

名稱 位於 必要 類型 Description
clusterName
path True

string

叢集資源的名稱。

resourceGroupName
path True

string

資源群組的名稱。

subscriptionId
path True

string

客戶訂用帳戶標識碼。

api-version
query True

string

Service Fabric 資源提供者 API 的版本。 這是必要的參數,而且此值必須是此規格的 “2024-04-01”。

要求本文

名稱 必要 類型 Description
location True

string

Azure 資源位置。

properties.adminUserName True

string

VM 系統管理員用戶名稱。

properties.dnsName True

string

叢集 dns 名稱。

sku True

Sku

受控叢集的SKU

properties.addonFeatures

ManagedClusterAddOnFeature[]

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

properties.adminPassword

string

VM 系統管理員用戶密碼。

properties.allowRdpAccess

boolean

將此設定為 true 可讓 RDP 存取 VM。 默認 NSG 規則會開啟 RDP 連接埠到因特網,可使用自訂的網路安全性規則加以覆寫。 此設定的預設值為 false。

properties.applicationTypeVersionsCleanupPolicy

ApplicationTypeVersionsCleanupPolicy

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

properties.auxiliarySubnets

Subnet[]

叢集的輔助子網。

properties.azureActiveDirectory

AzureActiveDirectory

叢集的 AAD 驗證設定。

properties.clientConnectionPort

integer

用於與叢集之用戶端連線的埠。

properties.clients

ClientCertificate[]

允許管理叢集的客戶端憑證。

properties.clusterCodeVersion

string

叢集的 Service Fabric 運行時間版本。 當 clusterUpgradeMode 設定為 'Manual' 時,需要這個屬性。 若要取得新叢集可用的 Service Fabric 版本清單,請使用 ClusterVersion API。 若要取得現有叢集可用的版本清單,請使用 availableClusterVersions

properties.clusterUpgradeCadence

clusterUpgradeCadence

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

properties.clusterUpgradeMode

ClusterUpgradeMode

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

properties.ddosProtectionPlanId

string

指定與叢集虛擬網路相關聯的 DDoS 網路保護計劃資源識別碼。

properties.enableAutoOSUpgrade

boolean

將此設定為 true 可針對使用任何平臺 OS 映射搭配版本 『latest』 建立的節點類型自動升級。 此設定的預設值為 false。

properties.enableHttpGatewayExclusiveAuthMode

boolean

如果為 true,HttpGatewayEndpoint 上不允許令牌型驗證。 這是支援 TLS 1.3 版和更新版本的必要專案。 如果使用令牌型驗證,則必須定義 HttpGatewayTokenAuthConnectionPort。

properties.enableIpv6

boolean

將此設定為 true 會為叢集所使用的預設 VNet 建立 IPv6 位址空間。 建立叢集之後,就無法變更此設定。 此設定的預設值為 false。

properties.enableServicePublicIP

boolean

將此設定為 true 會將 IPv4 位址連結為 IPv6 位址的 ServicePublicIP。 只有在叢集上啟用 IPv6 時,才能將它設定為 True。

properties.fabricSettings

SettingsSectionDescription[]

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

properties.httpGatewayConnectionPort

integer

用於叢集 HTTP 連線的埠。

properties.httpGatewayTokenAuthConnectionPort

integer

用於對叢集進行令牌驗證型 HTTPS 連線的埠。 無法設定為與 HttpGatewayEndpoint 相同的埠。

properties.ipTags

IpTag[]

與叢集預設公用IP位址相關聯的IP標籤清單。

properties.loadBalancingRules

LoadBalancingRule[]

套用至叢集公用負載平衡器的負載平衡規則。

properties.networkSecurityRules

NetworkSecurityRule[]

套用至叢集 虛擬網路 的自定義網路安全性規則。

properties.publicIPPrefixId

string

指定負載平衡器將配置公用 IPv4 位址的來源公用 IPv4 前置詞的資源識別碼。 建立叢集之後,就無法變更此設定。

properties.publicIPv6PrefixId

string

指定負載平衡器將配置公用 IPv6 位址的來源公用 IPv6 前置詞的資源識別碼。 建立叢集之後,就無法變更此設定。

properties.serviceEndpoints

ServiceEndpoint[]

叢集中子網的服務端點。

properties.subnetId

string

如果指定,則會在此子網中建立叢集的節點類型,而不是預設的 VNet。 針對叢集指定的 networkSecurityRules 也會套用至此子網。 建立叢集之後,就無法變更此設定。

properties.upgradeDescription

ClusterUpgradePolicy

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

properties.useCustomVnet

boolean

對於新的叢集,此參數表示它使用自備 VNet,但子網是在節點類型層級指定;針對這類叢集,節點類型需要subnetId屬性。

properties.zonalResiliency

boolean

指出叢集是否有區域復原功能。

properties.zonalUpdateMode

ZonalUpdateMode

指出跨 Az 叢集的更新模式。

tags

object

Azure 資源標籤。

回應

名稱 類型 Description
200 OK

ManagedCluster

作業已成功完成。

202 Accepted

ManagedCluster

已接受要求,且作業會以異步方式完成。

標題

  • Azure-AsyncOperation: string
  • Location: string
Other Status Codes

ErrorModel

詳細的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Put a cluster with maximum parameters
Put a cluster with minimum parameters

Put a cluster with maximum parameters

範例要求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster?api-version=2024-04-01

{
  "location": "eastus",
  "tags": {},
  "sku": {
    "name": "Basic"
  },
  "properties": {
    "clusterUpgradeMode": "Manual",
    "clusterCodeVersion": "7.1.168.9494",
    "dnsName": "myCluster",
    "adminUserName": "vmadmin",
    "adminPassword": "{vm-password}",
    "clientConnectionPort": 19000,
    "httpGatewayConnectionPort": 19080,
    "loadBalancingRules": [
      {
        "frontendPort": 80,
        "backendPort": 80,
        "probePort": 80,
        "protocol": "http",
        "probeProtocol": "http"
      },
      {
        "frontendPort": 443,
        "backendPort": 443,
        "probePort": 443,
        "protocol": "http",
        "probeProtocol": "http"
      },
      {
        "frontendPort": 10000,
        "backendPort": 10000,
        "probePort": 10000,
        "protocol": "tcp",
        "probeProtocol": "http",
        "loadDistribution": "Default"
      }
    ],
    "allowRdpAccess": true,
    "networkSecurityRules": [
      {
        "name": "TestName",
        "protocol": "tcp",
        "access": "allow",
        "priority": 1010,
        "direction": "inbound",
        "sourcePortRanges": [
          "*"
        ],
        "destinationPortRanges": [
          "*"
        ],
        "sourceAddressPrefixes": [
          "*"
        ],
        "destinationAddressPrefixes": [
          "*"
        ],
        "description": "Test description"
      },
      {
        "name": "AllowARM",
        "protocol": "*",
        "sourcePortRange": "*",
        "sourceAddressPrefix": "AzureResourceManager",
        "destinationAddressPrefix": "*",
        "destinationPortRange": "33500-33699",
        "access": "allow",
        "priority": 2002,
        "direction": "inbound"
      }
    ],
    "fabricSettings": [
      {
        "name": "ManagedIdentityTokenService",
        "parameters": [
          {
            "name": "IsEnabled",
            "value": "true"
          }
        ]
      }
    ],
    "addonFeatures": [
      "DnsService",
      "BackupRestoreService",
      "ResourceMonitorService"
    ],
    "enableAutoOSUpgrade": true,
    "applicationTypeVersionsCleanupPolicy": {
      "maxUnusedVersionsToKeep": 3
    },
    "zonalResiliency": true,
    "zonalUpdateMode": "Fast",
    "enableIpv6": true,
    "publicIPPrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPPrefix",
    "publicIPv6PrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPv6Prefix",
    "ipTags": [
      {
        "ipTagType": "FirstPartyUsage",
        "tag": "SQL"
      }
    ],
    "auxiliarySubnets": [
      {
        "name": "testSubnet1",
        "enableIpv6": true,
        "privateEndpointNetworkPolicies": "enabled",
        "privateLinkServiceNetworkPolicies": "enabled",
        "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1"
      }
    ],
    "serviceEndpoints": [
      {
        "service": "Microsoft.Storage",
        "locations": [
          "eastus2",
          "usnorth"
        ]
      }
    ],
    "useCustomVnet": true,
    "ddosProtectionPlanId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/ddosProtectionPlans/myDDoSProtectionPlan",
    "upgradeDescription": {
      "forceRestart": false,
      "monitoringPolicy": {
        "healthCheckWaitDuration": "00:05:00",
        "healthCheckStableDuration": "00:45:00",
        "healthCheckRetryTimeout": "00:55:00",
        "upgradeTimeout": "12:00:00",
        "upgradeDomainTimeout": "03:00:00"
      },
      "healthPolicy": {
        "maxPercentUnhealthyNodes": 10,
        "maxPercentUnhealthyApplications": 30
      },
      "deltaHealthPolicy": {
        "maxPercentDeltaUnhealthyNodes": 20,
        "maxPercentUpgradeDomainDeltaUnhealthyNodes": 40,
        "maxPercentDeltaUnhealthyApplications": 40
      }
    },
    "httpGatewayTokenAuthConnectionPort": 19081,
    "enableHttpGatewayExclusiveAuthMode": true
  }
}

範例回覆

Location: http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-04-01
Azure-AsyncOperation: http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-04-01
{
  "type": "Microsoft.ServiceFabric/managedClusters",
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster",
  "name": "myCluster",
  "tags": {},
  "etag": "W/\"636462502169240745\"",
  "sku": {
    "name": "Basic"
  },
  "properties": {
    "provisioningState": "Updating",
    "clusterId": "92584666-9889-4ae8-8d02-91902923d37f",
    "clusterUpgradeMode": "Manual",
    "clusterCodeVersion": "7.1.168.9494",
    "clusterState": "WaitingForNodes",
    "dnsName": "myCluster",
    "fqdn": "MyCluster.eastus.cloudapp.azure.com",
    "clusterCertificateThumbprints": [
      "12599211F8F14C90AFA9532AD79A6F2CA1C00622"
    ],
    "clientConnectionPort": 19000,
    "httpGatewayConnectionPort": 19080,
    "loadBalancingRules": [
      {
        "frontendPort": 80,
        "backendPort": 80,
        "probePort": 80,
        "protocol": "http",
        "probeProtocol": "http"
      },
      {
        "frontendPort": 443,
        "backendPort": 443,
        "probePort": 443,
        "protocol": "http",
        "probeProtocol": "http"
      },
      {
        "frontendPort": 10000,
        "backendPort": 10000,
        "probePort": 10000,
        "protocol": "tcp",
        "probeProtocol": "tcp",
        "loadDistribution": "Default"
      }
    ],
    "allowRdpAccess": true,
    "networkSecurityRules": [
      {
        "name": "TestName",
        "protocol": "tcp",
        "access": "allow",
        "priority": 1010,
        "direction": "inbound",
        "sourcePortRanges": [
          "*"
        ],
        "destinationPortRanges": [
          "*"
        ],
        "sourceAddressPrefixes": [
          "*"
        ],
        "destinationAddressPrefixes": [
          "*"
        ],
        "description": "Test description"
      },
      {
        "name": "AllowARM",
        "protocol": "*",
        "sourcePortRange": "*",
        "sourceAddressPrefix": "AzureResourceManager",
        "destinationAddressPrefix": "*",
        "destinationPortRange": "33500-33699",
        "access": "allow",
        "priority": 2002,
        "direction": "inbound"
      }
    ],
    "adminUserName": "vmadmin",
    "fabricSettings": [
      {
        "name": "ManagedIdentityTokenService",
        "parameters": [
          {
            "name": "IsEnabled",
            "value": "true"
          }
        ]
      }
    ],
    "addonFeatures": [
      "DnsService",
      "BackupRestoreService",
      "ResourceMonitorService"
    ],
    "enableAutoOSUpgrade": true,
    "applicationTypeVersionsCleanupPolicy": {
      "maxUnusedVersionsToKeep": 3
    },
    "zonalResiliency": true,
    "zonalUpdateMode": "Fast",
    "enableIpv6": true,
    "enableServicePublicIP": true,
    "publicIPPrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPPrefix",
    "publicIPv6PrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPv6Prefix",
    "ipTags": [
      {
        "ipTagType": "FirstPartyUsage",
        "tag": "SQL"
      }
    ],
    "auxiliarySubnets": [
      {
        "name": "testSubnet1",
        "enableIpv6": true,
        "privateEndpointNetworkPolicies": "enabled",
        "privateLinkServiceNetworkPolicies": "enabled",
        "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1"
      }
    ],
    "serviceEndpoints": [
      {
        "service": "Microsoft.Storage",
        "locations": [
          "eastus2",
          "usnorth"
        ]
      }
    ],
    "useCustomVnet": true,
    "ddosProtectionPlanId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/ddosProtectionPlans/myDDoSProtectionPlan",
    "upgradeDescription": {
      "forceRestart": false,
      "monitoringPolicy": {
        "healthCheckWaitDuration": "00:05:00",
        "healthCheckStableDuration": "00:45:00",
        "healthCheckRetryTimeout": "00:55:00",
        "upgradeTimeout": "12:00:00",
        "upgradeDomainTimeout": "03:00:00"
      },
      "healthPolicy": {
        "maxPercentUnhealthyNodes": 10,
        "maxPercentUnhealthyApplications": 30
      },
      "deltaHealthPolicy": {
        "maxPercentDeltaUnhealthyNodes": 20,
        "maxPercentUpgradeDomainDeltaUnhealthyNodes": 40,
        "maxPercentDeltaUnhealthyApplications": 40
      }
    },
    "httpGatewayTokenAuthConnectionPort": 19081,
    "enableHttpGatewayExclusiveAuthMode": true
  }
}
Location: http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-04-01
Azure-AsyncOperation: http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-04-01
{
  "type": "Microsoft.ServiceFabric/managedClusters",
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster",
  "name": "myCluster",
  "tags": {},
  "etag": "W/\"636462502169240745\"",
  "sku": {
    "name": "Basic"
  },
  "properties": {
    "provisioningState": "Creating",
    "clusterId": "92584666-9889-4ae8-8d02-91902923d37f",
    "clusterUpgradeMode": "Manual",
    "clusterCodeVersion": "7.1.168.9494",
    "clusterState": "WaitingForNodes",
    "dnsName": "myCluster",
    "fqdn": "MyCluster.eastus.cloudapp.azure.com",
    "clusterCertificateThumbprints": [
      "12599211F8F14C90AFA9532AD79A6F2CA1C00622"
    ],
    "clientConnectionPort": 19000,
    "httpGatewayConnectionPort": 19080,
    "loadBalancingRules": [
      {
        "frontendPort": 80,
        "backendPort": 80,
        "probePort": 80,
        "protocol": "http",
        "probeProtocol": "http"
      },
      {
        "frontendPort": 443,
        "backendPort": 443,
        "probePort": 443,
        "protocol": "http",
        "probeProtocol": "http"
      },
      {
        "frontendPort": 10000,
        "backendPort": 10000,
        "probePort": 10000,
        "protocol": "tcp",
        "probeProtocol": "tcp",
        "loadDistribution": "Default"
      }
    ],
    "allowRdpAccess": true,
    "networkSecurityRules": [
      {
        "name": "TestName",
        "protocol": "tcp",
        "access": "allow",
        "priority": 1010,
        "direction": "inbound",
        "sourcePortRanges": [
          "*"
        ],
        "destinationPortRanges": [
          "*"
        ],
        "sourceAddressPrefixes": [
          "*"
        ],
        "destinationAddressPrefixes": [
          "*"
        ],
        "description": "Test description"
      },
      {
        "name": "AllowARM",
        "protocol": "*",
        "sourcePortRange": "*",
        "sourceAddressPrefix": "AzureResourceManager",
        "destinationAddressPrefix": "*",
        "destinationPortRange": "33500-33699",
        "access": "allow",
        "priority": 2002,
        "direction": "inbound"
      }
    ],
    "adminUserName": "vmadmin",
    "fabricSettings": [
      {
        "name": "ManagedIdentityTokenService",
        "parameters": [
          {
            "name": "IsEnabled",
            "value": "true"
          }
        ]
      }
    ],
    "addonFeatures": [
      "DnsService",
      "BackupRestoreService",
      "ResourceMonitorService"
    ],
    "enableAutoOSUpgrade": true,
    "applicationTypeVersionsCleanupPolicy": {
      "maxUnusedVersionsToKeep": 3
    },
    "zonalResiliency": true,
    "zonalUpdateMode": "Fast",
    "enableIpv6": true,
    "enableServicePublicIP": true,
    "ipv6Address": "0000:0000:0000:0000:0000:0000:0000:0000",
    "publicIPPrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPPrefix",
    "publicIPv6PrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPv6Prefix",
    "ipTags": [
      {
        "ipTagType": "FirstPartyUsage",
        "tag": "SQL"
      }
    ],
    "auxiliarySubnets": [
      {
        "name": "testSubnet1",
        "enableIpv6": true,
        "privateEndpointNetworkPolicies": "enabled",
        "privateLinkServiceNetworkPolicies": "enabled",
        "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1"
      }
    ],
    "serviceEndpoints": [
      {
        "service": "Microsoft.Storage",
        "locations": [
          "eastus2",
          "usnorth"
        ]
      }
    ],
    "useCustomVnet": true,
    "ddosProtectionPlanId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/ddosProtectionPlans/myDDoSProtectionPlan",
    "upgradeDescription": {
      "forceRestart": false,
      "monitoringPolicy": {
        "healthCheckWaitDuration": "00:05:00",
        "healthCheckStableDuration": "00:45:00",
        "healthCheckRetryTimeout": "00:55:00",
        "upgradeTimeout": "12:00:00",
        "upgradeDomainTimeout": "03:00:00"
      },
      "upgradeReplicaSetCheckTimeout": "49710.06:28:16",
      "healthPolicy": {
        "maxPercentUnhealthyNodes": 10,
        "maxPercentUnhealthyApplications": 30
      },
      "deltaHealthPolicy": {
        "maxPercentDeltaUnhealthyNodes": 20,
        "maxPercentUpgradeDomainDeltaUnhealthyNodes": 40,
        "maxPercentDeltaUnhealthyApplications": 40
      }
    },
    "httpGatewayTokenAuthConnectionPort": 19081,
    "enableHttpGatewayExclusiveAuthMode": true
  }
}

Put a cluster with minimum parameters

範例要求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster?api-version=2024-04-01

{
  "location": "eastus",
  "sku": {
    "name": "Basic"
  },
  "properties": {
    "clusterUpgradeMode": "Automatic",
    "clusterUpgradeCadence": "Wave1",
    "dnsName": "myCluster",
    "adminUserName": "vmadmin",
    "adminPassword": "{vm-password}",
    "fabricSettings": [
      {
        "name": "ManagedIdentityTokenService",
        "parameters": [
          {
            "name": "IsEnabled",
            "value": "true"
          }
        ]
      }
    ]
  }
}

範例回覆

Location: http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-04-01
Azure-AsyncOperation: http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-04-01
{
  "type": "Microsoft.ServiceFabric/managedClusters",
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster",
  "name": "myCluster",
  "tags": {},
  "etag": "W/\"636462502169240745\"",
  "sku": {
    "name": "Basic"
  },
  "properties": {
    "provisioningState": "Updating",
    "clusterId": "92584666-9889-4ae8-8d02-91902923d37f",
    "clusterUpgradeMode": "Automatic",
    "clusterUpgradeCadence": "Wave1",
    "clusterState": "WaitingForNodes",
    "dnsName": "myCluster",
    "fqdn": "MyCluster.eastus.cloudapp.azure.com",
    "clusterCertificateThumbprints": [
      "12599211F8F14C90AFA9532AD79A6F2CA1C00622"
    ],
    "clientConnectionPort": 19000,
    "httpGatewayConnectionPort": 19080,
    "loadBalancingRules": [],
    "adminUserName": "vmadmin",
    "fabricSettings": [
      {
        "name": "ManagedIdentityTokenService",
        "parameters": [
          {
            "name": "IsEnabled",
            "value": "true"
          }
        ]
      }
    ]
  }
}
Location: http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-04-01
Azure-AsyncOperation: http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2024-04-01
{
  "type": "Microsoft.ServiceFabric/managedClusters",
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster",
  "name": "myCluster",
  "tags": {},
  "etag": "W/\"636462502169240745\"",
  "sku": {
    "name": "Basic"
  },
  "properties": {
    "provisioningState": "Creating",
    "clusterId": "92584666-9889-4ae8-8d02-91902923d37f",
    "clusterUpgradeMode": "Automatic",
    "clusterUpgradeCadence": "Wave1",
    "clusterState": "WaitingForNodes",
    "dnsName": "myCluster",
    "fqdn": "MyCluster.eastus.cloudapp.azure.com",
    "clusterCertificateThumbprints": [
      "12599211F8F14C90AFA9532AD79A6F2CA1C00622"
    ],
    "clientConnectionPort": 19000,
    "httpGatewayConnectionPort": 19080,
    "loadBalancingRules": [],
    "adminUserName": "vmadmin",
    "fabricSettings": [
      {
        "name": "ManagedIdentityTokenService",
        "parameters": [
          {
            "name": "IsEnabled",
            "value": "true"
          }
        ]
      }
    ]
  }
}

定義

名稱 Description
access

允許或拒絕網路流量。

ApplicationTypeVersionsCleanupPolicy

用來清除未使用版本的原則。 未明確指定原則時,要保留的預設未使用應用程式版本會是 3。

AzureActiveDirectory

在叢集上啟用 AAD 驗證的設定。

ClientCertificate

用戶端憑證定義。

ClusterHealthPolicy

定義用來評估叢集或叢集節點健康情況的健康情況原則。

ClusterMonitoringPolicy

描述叢集升級的監視原則。

ClusterState

叢集的目前狀態。

clusterUpgradeCadence

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

ClusterUpgradeDeltaHealthPolicy

描述叢集升級的差異健康情況原則。

ClusterUpgradeMode

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

ClusterUpgradePolicy

描述升級叢集時所使用的原則。

direction

網路安全性規則方向。

ErrorModel

錯誤的結構。

ErrorModelError

錯誤詳細資料。

IpTag

與公用IP位址相關聯的IP標籤。

LoadBalancingRule

描述負載平衡規則。

ManagedCluster

受控叢集資源

ManagedClusterAddOnFeature

可用的叢集附加元件功能

ManagedResourceProvisioningState

受控資源的布建狀態。

NetworkSecurityRule

描述網路安全性規則。

nsgProtocol

此規則適用的網路通訊協定。

privateEndpointNetworkPolicies

在子網的私人端點上啟用或停用套用網路原則。

privateLinkServiceNetworkPolicies

在子網中的私人連結服務上啟用或停用套用網路原則。

probeProtocol

負載平衡規則所使用的負載平衡器探查參考。

protocol

負載平衡規則所使用的傳輸通訊協議參考。

ServiceEndpoint

服務端點屬性。

SettingsParameterDescription

描述叢集網狀架構設定中的參數。

SettingsSectionDescription

描述叢集網狀架構設定中的區段。

Sku

Service Fabric 受控叢集 Sku 定義

SkuName

Sku 名稱。

Subnet

描述子網。

SystemData

與建立和上次修改資源相關的元數據。

ZonalUpdateMode

指出跨 Az 叢集的更新模式。

access

允許或拒絕網路流量。

名稱 類型 Description
allow

string

deny

string

ApplicationTypeVersionsCleanupPolicy

用來清除未使用版本的原則。 未明確指定原則時,要保留的預設未使用應用程式版本會是 3。

名稱 類型 Description
maxUnusedVersionsToKeep

integer

要保留的每個應用程式類型未使用的版本數目。

AzureActiveDirectory

在叢集上啟用 AAD 驗證的設定。

名稱 類型 Description
clientApplication

string

Azure Active Directory 用戶端應用程式識別碼。

clusterApplication

string

Azure Active Directory 叢集應用程式標識符。

tenantId

string

Azure Active Directory 租用戶標識符。

ClientCertificate

用戶端憑證定義。

名稱 類型 Description
commonName

string

憑證一般名稱。

isAdmin

boolean

指出客戶端憑證是否具有叢集的管理員存取權。 非系統管理員用戶端只能在叢集上執行唯讀作業。

issuerThumbprint

string

憑證的簽發者指紋。 只與 CommonName 搭配使用。

thumbprint

string

憑證指紋。

ClusterHealthPolicy

定義用來評估叢集或叢集節點健康情況的健康情況原則。

名稱 類型 預設值 Description
maxPercentUnhealthyApplications

integer

0

在報告錯誤之前,允許健康情況不良應用程式的最大百分比。 例如,若要允許 10% 的應用程式健康情況不良,這個值會是 10。

百分比表示在系統將叢集視為錯誤之前,容許應用程式健康情況不良的最大百分比。 如果未到達此百分比,但至少有一個健康情況不良的應用程式,則健康情況會評估為 Warning。 此計算是將健康情況不良的應用程式數目除以叢集中應用程式執行個體的總數而得,但不包括 ApplicationTypeHealthPolicyMap 所包含之應用程式類型的應用程式。 針對少量的應用程式數目,計算會四捨五入以容許一個失敗。 預設百分比是零。

maxPercentUnhealthyNodes

integer

0

在報告錯誤之前,允許健康情況不良節點的最大百分比。 例如,若要允許 10% 的節點健康情況不良,這個值會是 10。

百分比表示在叢集被視為處於錯誤狀態之前,容許節點健康情況不良的最大百分比。 如果未到達此百分比,但至少有一個健康情況不良的節點,則健康情況會評估為 Warning。 百分比是將健康情況不良節點數目除以叢集中的節點總數計算而得。 針對較少的節點數目,計算會四捨五入以容許一個失敗。 預設百分比是零。

在大型叢集中,永遠都有一些節點會關閉或需要修復,因此應設定此百分比來容許這種情形。

ClusterMonitoringPolicy

描述叢集升級的監視原則。

名稱 類型 Description
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 格式。

upgradeDomainTimeout

string

每個升級網域在升級復原之前必須完成的時間量。 逾時可以是 hh:mm:ss 或 d.hh:mm:ss.ms 格式。

upgradeTimeout

string

在升級復原之前,整體升級必須完成的時間量。 逾時可以是 hh:mm:ss 或 d.hh:mm:ss.ms 格式。

ClusterState

叢集的目前狀態。

名稱 類型 Description
BaselineUpgrade

string

表示叢集正在升級以建立叢集版本。 第一次啟動叢集時,會自動起始此升級。

Deploying

string

指出正在 VM 上安裝 Service Fabric 執行時間。 叢集資源會處於此狀態,直到叢集開機並啟動系統服務為止。

Ready

string

表示叢集處於穩定狀態。

UpgradeFailed

string

表示叢集的最後一次升級失敗。

Upgrading

string

指出叢集正以使用者提供的組態進行升級。

WaitingForNodes

string

指出已建立叢集資源,且資源提供者正在等候 Service Fabric VM 擴充功能開機並回報給它。

clusterUpgradeCadence

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

名稱 類型 Description
Wave0

string

叢集升級會在新版本推出之後立即啟動。建議用於測試/開發叢集。

Wave1

string

叢集升級會在新版本推出後的7天開始。建議用於預先執行叢集。

Wave2

string

叢集升級會在推出新版本之後 14 天開始。建議用於生產叢集。

ClusterUpgradeDeltaHealthPolicy

描述叢集升級的差異健康情況原則。

名稱 類型 Description
maxPercentDeltaUnhealthyApplications

integer

叢集升級期間允許的應用程式健康情況降低百分比上限。 差異會在升級開始時的應用程式狀態和健康情況評估時的應用程式狀態之間測量。 每次升級網域升級完成後都會執行檢查,以確保叢集的全域狀態處於容許的限制範圍內。 系統服務不包含在此專案中。 注意:此值會覆寫屬性中指定的值。UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications

maxPercentDeltaUnhealthyNodes

integer

在叢集升級期間允許的節點健康情況衰退百分比上限。 差異是測量升級開始時節點的狀態和健康情況評估時節點的狀態之間的差異。 每次升級網域升級完成後都會執行檢查,以確保叢集的全域狀態處於容許的限制範圍內。

maxPercentUpgradeDomainDeltaUnhealthyNodes

integer

在叢集升級期間允許的升級網域節點健康情況衰退百分比上限。 差異是測量升級開始時升級網域節點的狀態和健康情況評估時升級網域節點的狀態之間的差異。 每次所有已完成升級網域的升級網域升級完成後都會執行檢查,以確保升級網域的狀態處於容許的限制範圍內。

ClusterUpgradeMode

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

名稱 類型 Description
Automatic

string

叢集將會自動升級至最新的 Service Fabric 運行時間版本, clusterUpgradeCadence 會決定在新版本可用之後何時開始升級。

Manual

string

叢集不會自動升級至最新的 Service Fabric 運行時間版本。 叢集是藉由在叢集資源中設定 clusterCodeVersion 屬性來升級。

ClusterUpgradePolicy

描述升級叢集時所使用的原則。

名稱 類型 Description
deltaHealthPolicy

ClusterUpgradeDeltaHealthPolicy

叢集差異健全狀況原則會定義健康情況原則,以在叢集升級期間用來評估叢集的健康情況。

forceRestart

boolean

如果為 true,則即使程式代碼版本未變更,仍會在升級期間強制重新啟動, (升級只會變更組態或數據) 。

healthPolicy

ClusterHealthPolicy

叢集健康狀態原則會定義健康情況原則,用來在叢集升級期間評估叢集的健康情況。

monitoringPolicy

ClusterMonitoringPolicy

叢集監視原則描述在受監視模式中監視升級的參數。

upgradeReplicaSetCheckTimeout

string

發生非預期問題時,封鎖處理升級網域並防止遺失可用性的時間長度上限。 此逾時過期時,無論是否發生可用性遺失問題,升級網域的處理都將繼續。 逾時會在每個升級網域啟動時重設。 逾時可以是 hh:mm:ss 或 d.hh:mm:ss.ms 格式。 此值必須介於 00:00:00 和 49710.06:28:15 之間, (不帶正負號的 32 位整數,以秒為單位)

direction

網路安全性規則方向。

名稱 類型 Description
inbound

string

outbound

string

ErrorModel

錯誤的結構。

名稱 類型 Description
error

ErrorModelError

錯誤詳細資料。

ErrorModelError

錯誤詳細資料。

名稱 類型 Description
code

string

錯誤碼。

message

string

錯誤訊息。

IpTag

與公用IP位址相關聯的IP標籤。

名稱 類型 Description
ipTagType

string

IP 標籤類型。 範例:FirstPartyUsage。

tag

string

與公用IP相關聯的IP標籤。 範例:SQL、記憶體等。

LoadBalancingRule

描述負載平衡規則。

名稱 類型 Description
backendPort

integer

在端點上用於內部連接的連接埠。 可接受的值介於 1 到 65535 之間。

frontendPort

integer

外部端點的連接埠。 每個規則的埠號碼在 Load Balancer 內必須是唯一的。 可接受的值介於 1 到 65534 之間。

loadDistribution

string

此規則的負載分配原則。

probePort

integer

負載平衡規則所使用的探查埠。 可接受的值介於 1 到 65535 之間。

probeProtocol

probeProtocol

負載平衡規則所使用的負載平衡器探查參考。

probeRequestPath

string

探查要求路徑。 僅支援 HTTP/HTTPS 探查。

protocol

protocol

負載平衡規則所使用的傳輸通訊協議參考。

ManagedCluster

受控叢集資源

名稱 類型 預設值 Description
etag

string

Azure 資源 etag。

id

string

Azure 資源標識碼。

location

string

Azure 資源位置。

name

string

Azure 資源名稱。

properties.addonFeatures

ManagedClusterAddOnFeature[]

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

properties.adminPassword

string

VM 系統管理員用戶密碼。

properties.adminUserName

string

VM 系統管理員用戶名稱。

properties.allowRdpAccess

boolean

將此設定為 true 可讓 RDP 存取 VM。 默認 NSG 規則會開啟 RDP 連接埠到因特網,可使用自訂的網路安全性規則加以覆寫。 此設定的預設值為 false。

properties.applicationTypeVersionsCleanupPolicy

ApplicationTypeVersionsCleanupPolicy

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

properties.auxiliarySubnets

Subnet[]

叢集的輔助子網。

properties.azureActiveDirectory

AzureActiveDirectory

叢集的 AAD 驗證設定。

properties.clientConnectionPort

integer

19000

用於與叢集之用戶端連線的埠。

properties.clients

ClientCertificate[]

允許管理叢集的客戶端憑證。

properties.clusterCertificateThumbprints

string[]

叢集憑證的指紋清單。

properties.clusterCodeVersion

string

叢集的 Service Fabric 運行時間版本。 當 clusterUpgradeMode 設定為 'Manual' 時,需要這個屬性。 若要取得新叢集可用的 Service Fabric 版本清單,請使用 ClusterVersion API。 若要取得現有叢集可用的版本清單,請使用 availableClusterVersions

properties.clusterId

string

服務為叢集資源產生唯一標識符。

properties.clusterState

ClusterState

叢集的目前狀態。

properties.clusterUpgradeCadence

clusterUpgradeCadence

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

properties.clusterUpgradeMode

ClusterUpgradeMode

Automatic

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

properties.ddosProtectionPlanId

string

指定與叢集虛擬網路相關聯的 DDoS 網路保護計劃資源識別碼。

properties.dnsName

string

叢集 dns 名稱。

properties.enableAutoOSUpgrade

boolean

將此設定為 true 可針對使用任何平臺 OS 映射搭配版本 『latest』 建立的節點類型自動升級。 此設定的預設值為 false。

properties.enableHttpGatewayExclusiveAuthMode

boolean

如果為 true,HttpGatewayEndpoint 上不允許令牌型驗證。 這是支援 TLS 1.3 版和更新版本的必要專案。 如果使用令牌型驗證,則必須定義 HttpGatewayTokenAuthConnectionPort。

properties.enableIpv6

boolean

將此設定為 true 會為叢集所使用的預設 VNet 建立 IPv6 位址空間。 建立叢集之後,就無法變更此設定。 此設定的預設值為 false。

properties.enableServicePublicIP

boolean

將此設定為 true 會將 IPv4 位址連結為 IPv6 位址的 ServicePublicIP。 只有在叢集上啟用 IPv6 時,才能將它設定為 True。

properties.fabricSettings

SettingsSectionDescription[]

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

properties.fqdn

string

與叢集公用負載平衡器相關聯的完整功能變數名稱。

properties.httpGatewayConnectionPort

integer

19080

用於叢集 HTTP 連線的埠。

properties.httpGatewayTokenAuthConnectionPort

integer

用於對叢集進行令牌驗證型 HTTPS 連線的埠。 無法設定為與 HttpGatewayEndpoint 相同的埠。

properties.ipTags

IpTag[]

與叢集預設公用IP位址相關聯的IP標籤清單。

properties.ipv4Address

string

與叢集公用負載平衡器相關聯的 IPv4 位址。

properties.ipv6Address

string

如果已啟用 IPv6,叢集的 IPv6 位址。

properties.loadBalancingRules

LoadBalancingRule[]

套用至叢集公用負載平衡器的負載平衡規則。

properties.networkSecurityRules

NetworkSecurityRule[]

套用至叢集 虛擬網路 的自定義網路安全性規則。

properties.provisioningState

ManagedResourceProvisioningState

受控叢集資源的布建狀態。

properties.publicIPPrefixId

string

指定負載平衡器將配置公用 IPv4 位址的來源公用 IPv4 前置詞的資源識別碼。 建立叢集之後,就無法變更此設定。

properties.publicIPv6PrefixId

string

指定負載平衡器將配置公用 IPv6 位址的來源公用 IPv6 前置詞的資源識別碼。 建立叢集之後,就無法變更此設定。

properties.serviceEndpoints

ServiceEndpoint[]

叢集中子網的服務端點。

properties.subnetId

string

如果指定,則會在此子網中建立叢集的節點類型,而不是預設的 VNet。 針對叢集指定的 networkSecurityRules 也會套用至此子網。 建立叢集之後,就無法變更此設定。

properties.upgradeDescription

ClusterUpgradePolicy

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

properties.useCustomVnet

boolean

對於新的叢集,此參數表示它使用自備 VNet,但子網是在節點類型層級指定;針對這類叢集,節點類型需要subnetId屬性。

properties.zonalResiliency

boolean

False

指出叢集是否有區域復原功能。

properties.zonalUpdateMode

ZonalUpdateMode

指出跨 Az 叢集的更新模式。

sku

Sku

受控叢集的SKU

systemData

SystemData

與建立和上次修改資源相關的元數據。

tags

object

Azure 資源標籤。

type

string

Azure 資源類型。

ManagedClusterAddOnFeature

可用的叢集附加元件功能

名稱 類型 Description
BackupRestoreService

string

備份與還原服務

DnsService

string

Dns 服務

ResourceMonitorService

string

資源監視服務

ManagedResourceProvisioningState

受控資源的布建狀態。

名稱 類型 Description
Canceled

string

Created

string

Creating

string

Deleted

string

Deleting

string

Failed

string

None

string

Other

string

Succeeded

string

Updating

string

NetworkSecurityRule

描述網路安全性規則。

名稱 類型 Description
access

access

允許或拒絕網路流量。

description

string

網路安全性規則描述。

destinationAddressPrefix

string

目的地地址前綴。 CIDR 或目的地IP範圍。 也可用星號 (*) 來比對所有的來源 IP。 您也可以使用默認標籤,例如 'VirtualNetwork'、'AzureLoadBalancer' 和 'Internet'。

destinationAddressPrefixes

string[]

目的地位址前置詞。 CIDR 或目的地IP範圍。

destinationPortRange

string

他目的地埠或範圍。 介於 0 到 65535 之間的整數或範圍。 星號 『*』 也可以用來比對所有埠。

destinationPortRanges

string[]

目的地埠範圍。

direction

direction

網路安全性規則方向。

name

string

網路安全性規則名稱。

priority

integer

規則的優先順序。 此值的範圍可以是 1000 到 3000。 此範圍以外的值會保留給 Service Fabric ManagerCluster 資源提供者。 集合中每個規則的優先順序數字必須是唯一的。 優先順序號碼愈小,規則優先順序就愈高。

protocol

nsgProtocol

此規則適用的網路通訊協定。

sourceAddressPrefix

string

CIDR 或來源IP範圍。 也可用星號 (*) 來比對所有的來源 IP。 您也可以使用默認標籤,例如 'VirtualNetwork'、'AzureLoadBalancer' 和 'Internet'。 如果這是輸入規則,請指定網路流量的來源。

sourceAddressPrefixes

string[]

CIDR 或來源IP範圍。

sourcePortRange

string

來源埠或範圍。 介於 0 到 65535 之間的整數或範圍。 星號 『*』 也可以用來比對所有埠。

sourcePortRanges

string[]

來源埠範圍。

nsgProtocol

此規則適用的網路通訊協定。

名稱 類型 Description
ah

string

esp

string

http

string

https

string

icmp

string

tcp

string

udp

string

privateEndpointNetworkPolicies

在子網的私人端點上啟用或停用套用網路原則。

名稱 類型 Description
disabled

string

enabled

string

privateLinkServiceNetworkPolicies

在子網中的私人連結服務上啟用或停用套用網路原則。

名稱 類型 Description
disabled

string

enabled

string

probeProtocol

負載平衡規則所使用的負載平衡器探查參考。

名稱 類型 Description
http

string

https

string

tcp

string

protocol

負載平衡規則所使用的傳輸通訊協議參考。

名稱 類型 Description
tcp

string

udp

string

ServiceEndpoint

服務端點屬性。

名稱 類型 Description
locations

string[]

位置清單。

service

string

端點服務的型別。

SettingsParameterDescription

描述叢集網狀架構設定中的參數。

名稱 類型 Description
name

string

網狀架構設定的參數名稱。

value

string

網狀架構設定的參數值。

SettingsSectionDescription

描述叢集網狀架構設定中的區段。

名稱 類型 Description
name

string

網狀架構設定的區段名稱。

parameters

SettingsParameterDescription[]

區段中的參數集合。

Sku

Service Fabric 受控叢集 Sku 定義

名稱 類型 Description
name

SkuName

Sku 名稱。

SkuName

Sku 名稱。

名稱 類型 Description
Basic

string

基本至少需要 3 個節點,而且只允許 1 個節點類型。

Standard

string

至少需要 5 個節點,並允許 1 個以上的節點類型。

Subnet

描述子網。

名稱 類型 Description
enableIpv6

boolean

表示我們是否要啟用 Ipv6。 如果未提供,則會採用與叢集相同的設定。

name

string

子網名稱。

networkSecurityGroupId

string

網路安全組的完整資源標識碼。

privateEndpointNetworkPolicies

privateEndpointNetworkPolicies

在子網的私人端點上啟用或停用套用網路原則。

privateLinkServiceNetworkPolicies

privateLinkServiceNetworkPolicies

在子網中的私人連結服務上啟用或停用套用網路原則。

SystemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string

資源建立的時間戳 (UTC) 。

createdBy

string

建立資源的身分識別。

createdByType

string

建立資源的身分識別類型。

lastModifiedAt

string

上次修改的資源時間戳 (UTC) 。

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

string

上次修改資源的身分識別類型。

ZonalUpdateMode

指出跨 Az 叢集的更新模式。

名稱 類型 Description
Fast

string

叢集會針對跨 Az 節點類型使用每個區域的最多 3 個升級網域,而不是 5 個,以加快部署速度。

Standard

string

叢集將使用 5 個跨 Az 節點類型的升級網域。