ManagedCluster interface

套件:

@azure/arm-servicefabricmanagedclusters

受控叢集資源

Extends

Resource

屬性

addonFeatures	在叢集上啟用的附加元件功能清單。
adminPassword	VM 系統管理員用戶密碼。 此值包含認證。 在向用戶顯示之前，請考慮遮蔽
adminUserName	VM 系統管理員用戶名稱。
allowRdpAccess	將此設定為 true 可讓 RDP 存取 VM。 默認 NSG 規則會開啟 RDP 連接埠至因特網，以自定義網路安全性規則加以覆寫。 此設定的預設值為 false。
applicationTypeVersionsCleanupPolicy	用來清除未使用版本的原則。
autoGeneratedDomainNameLabelScope	此屬性是針對叢集憑證使用公用 CA 憑證的進入點。它會指定針對所建立之自定義 FQDN 所允許的重複使用層級，以符合公用 CA 憑證的主體。
auxiliarySubnets	叢集的輔助子網。
azureActiveDirectory	叢集的 AAD 驗證設定。
clientConnectionPort	用於與叢集之用戶端連線的埠。
clients	允許管理叢集的客戶端憑證。
clusterCertificateThumbprints	叢集憑證的指紋清單。 注意：這個屬性不會串行化。 它只能由伺服器填入。
clusterCodeVersion	叢集的 Service Fabric 運行時間版本。 當 clusterUpgradeMode 設定為 'Manual' 時，需要此屬性。 若要取得新叢集可用的 Service Fabric 版本列表，請使用 ClusterVersion API。 若要取得現有叢集可用的版本清單，請使用 availableClusterVersions。
clusterId	服務為叢集資源產生唯一標識符。 注意：這個屬性不會串行化。 它只能由伺服器填入。
clusterState	叢集的目前狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
clusterUpgradeCadence	指出發行新的叢集運行時間版本升級何時會套用。 根據預設為 Wave0。 只有在 clusterUpgradeMode 設定為 'Automatic' 時 ，才會套用叢集UpgradeMode。
clusterUpgradeMode	有新的 Service Fabric 執行時間版本可用時，叢集的升級模式。
customFqdn	如果使用 autoGeneratedDomainNameLabelScope，則這是使用 SFMC 網域的完整功能變數名稱，指向叢集的公用負載平衡器。
ddosProtectionPlanId	指定與叢集虛擬網路相關聯的 DDoS 網路保護計劃資源識別碼。
dnsName	叢集 dns 名稱。
enableAutoOSUpgrade	將此設定為 true 可針對使用任何平臺 OS 映射搭配版本 『latest』 建立的節點類型，啟用自動 OS 升級。 此設定的預設值為 false。
enableHttpGatewayExclusiveAuthMode	如果為 true，則 HttpGatewayEndpoint 上不允許令牌型驗證。 這需要支援 TLS 1.3 版和更新版本。 如果使用令牌型驗證，則必須定義 HttpGatewayTokenAuthConnectionPort。
enableIpv6	將此設定為 true 會為叢集所使用的預設 VNet 建立 IPv6 位址空間。 建立叢集之後，就無法變更此設定。 此設定的預設值為 false。
enableServicePublicIP	將此設定為 true 會將 IPv4 位址連結為 IPv6 位址的 ServicePublicIP。 只有在叢集上啟用 IPv6 時，才能將它設定為 True。
fabricSettings	要設定叢集的自定義網狀架構設定清單。
fqdn	與叢集公用負載平衡器相關聯的完整功能變數名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
httpGatewayConnectionPort	用於叢集 HTTP 連線的埠。
httpGatewayTokenAuthConnectionPort	用於對叢集進行令牌驗證型 HTTPS 連線的埠。 無法設定為與 HttpGatewayEndpoint 相同的埠。
ipTags	與叢集預設公用IP位址相關聯的IP標籤清單。
ipv4Address	與叢集公用負載平衡器相關聯的 IPv4 位址。 注意：這個屬性不會串行化。 它只能由伺服器填入。
ipv6Address	如果已啟用 IPv6，叢集的 IPv6 位址。 注意：這個屬性不會串行化。 它只能由伺服器填入。
loadBalancingRules	套用至叢集公用負載平衡器的負載平衡規則。
networkSecurityRules	套用至叢集虛擬網路的自定義網路安全性規則。
provisioningState	受控叢集資源的布建狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
publicIPPrefixId	指定負載平衡器將從中配置公用 IPv4 位址之公用 IPv4 前置的資源識別碼。 建立叢集之後，就無法變更此設定。
publicIPv6PrefixId	指定負載平衡器將從中配置公用 IPv6 位址的公用 IPv6 前置碼資源識別碼。 建立叢集之後，就無法變更此設定。
serviceEndpoints	叢集中子網的服務端點。
sku	受控叢集的SKU
subnetId	如果指定，則會在此子網中建立叢集的節點類型，而不是預設的 VNet。 為叢集指定的 networkSecurityRules 也會套用至此子網。 建立叢集之後，就無法變更此設定。
upgradeDescription	升級叢集時要使用的原則。
useCustomVnet	對於新的叢集，此參數表示其使用自備 VNet，但子網是在節點類型層級指定;對於這類叢集，節點類型需要subnetId屬性。
zonalResiliency	指出叢集是否有區域復原能力。
zonalUpdateMode	指出跨 Az 叢集的更新模式。

繼承的屬性

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

屬性詳細資料

addonFeatures

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

addonFeatures?: string[]

屬性值

string[]

adminPassword

VM 系統管理員用戶密碼。 此值包含認證。 在向用戶顯示之前，請考慮遮蔽

adminPassword?: string

屬性值

string

adminUserName

VM 系統管理員用戶名稱。

adminUserName?: string

屬性值

string

allowRdpAccess

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

allowRdpAccess?: boolean

屬性值

boolean

applicationTypeVersionsCleanupPolicy

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

applicationTypeVersionsCleanupPolicy?: ApplicationTypeVersionsCleanupPolicy

屬性值

ApplicationTypeVersionsCleanupPolicy

autoGeneratedDomainNameLabelScope

此屬性是針對叢集憑證使用公用 CA 憑證的進入點。它會指定針對所建立之自定義 FQDN 所允許的重複使用層級，以符合公用 CA 憑證的主體。

autoGeneratedDomainNameLabelScope?: string

屬性值

string

auxiliarySubnets

叢集的輔助子網。

auxiliarySubnets?: Subnet[]

屬性值

Subnet[]

azureActiveDirectory

叢集的 AAD 驗證設定。

azureActiveDirectory?: AzureActiveDirectory

屬性值

AzureActiveDirectory

clientConnectionPort

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

clientConnectionPort?: number

屬性值

number

clients

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

clients?: ClientCertificate[]

屬性值

ClientCertificate[]

clusterCertificateThumbprints

叢集憑證的指紋清單。 注意：這個屬性不會串行化。 它只能由伺服器填入。

clusterCertificateThumbprints?: string[]

屬性值

string[]

clusterCodeVersion

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

clusterCodeVersion?: string

屬性值

string

clusterId

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

clusterId?: string

屬性值

string

clusterState

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

clusterState?: string

屬性值

string

clusterUpgradeCadence

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

clusterUpgradeCadence?: string

屬性值

string

clusterUpgradeMode

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

clusterUpgradeMode?: string

屬性值

string

customFqdn

如果使用 autoGeneratedDomainNameLabelScope，則這是使用 SFMC 網域的完整功能變數名稱，指向叢集的公用負載平衡器。

customFqdn?: string

屬性值

string

ddosProtectionPlanId

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

ddosProtectionPlanId?: string

屬性值

string

dnsName

叢集 dns 名稱。

dnsName?: string

屬性值

string

enableAutoOSUpgrade

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

enableAutoOSUpgrade?: boolean

屬性值

boolean

enableHttpGatewayExclusiveAuthMode

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

enableHttpGatewayExclusiveAuthMode?: boolean

屬性值

boolean

enableIpv6

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

enableIpv6?: boolean

屬性值

boolean

enableServicePublicIP

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

enableServicePublicIP?: boolean

屬性值

boolean

fabricSettings

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

fabricSettings?: SettingsSectionDescription[]

屬性值

SettingsSectionDescription[]

fqdn

與叢集公用負載平衡器相關聯的完整功能變數名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

fqdn?: string

屬性值

string

httpGatewayConnectionPort

用於叢集 HTTP 連線的埠。

httpGatewayConnectionPort?: number

屬性值

number

httpGatewayTokenAuthConnectionPort

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

httpGatewayTokenAuthConnectionPort?: number

屬性值

number

ipTags

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

ipTags?: IpTag[]

屬性值

IpTag[]

ipv4Address

與叢集公用負載平衡器相關聯的 IPv4 位址。 注意：這個屬性不會串行化。 它只能由伺服器填入。

ipv4Address?: string

屬性值

string

ipv6Address

如果已啟用 IPv6，叢集的 IPv6 位址。 注意：這個屬性不會串行化。 它只能由伺服器填入。

ipv6Address?: string

屬性值

string

loadBalancingRules

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

loadBalancingRules?: LoadBalancingRule[]

屬性值

LoadBalancingRule[]

networkSecurityRules

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

networkSecurityRules?: NetworkSecurityRule[]

屬性值

NetworkSecurityRule[]

provisioningState

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

provisioningState?: string

屬性值

string

publicIPPrefixId

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

publicIPPrefixId?: string

屬性值

string

publicIPv6PrefixId

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

publicIPv6PrefixId?: string

屬性值

string

serviceEndpoints

叢集中子網的服務端點。

serviceEndpoints?: ServiceEndpoint[]

屬性值

ServiceEndpoint[]

sku

受控叢集的SKU

sku: Sku

屬性值

Sku

subnetId

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

subnetId?: string

屬性值

string

upgradeDescription

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

upgradeDescription?: ClusterUpgradePolicy

屬性值

ClusterUpgradePolicy

useCustomVnet

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

useCustomVnet?: boolean

屬性值

boolean

zonalResiliency

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

zonalResiliency?: boolean

屬性值

boolean

zonalUpdateMode

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

zonalUpdateMode?: string

屬性值

string

繼承的屬性詳細資料

etag

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

etag?: string

屬性值

string

繼承自Resource.etag

id

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

id?: string

屬性值

string

繼承自Resource.id

location

Azure 資源位置。

location: string

屬性值

string

繼承自Resource.location

name

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

name?: string

屬性值

string

繼承自Resource.name

systemData

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

systemData?: SystemData

屬性值

SystemData

繼承自Resource.systemData

tags

Azure 資源標籤。

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

屬性值

{[propertyName: string]: string}

繼承自Resource.tags

type

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

type?: string

屬性值

string

繼承自Resource.type