ManagedCluster interface

套件:: @azure/arm-servicefabricmanagedclusters

受控叢集資源

Extends: TrackedResource

屬性

addonFeatures	在叢集上啟用的附加元件功能清單。
adminPassword	VM 系統管理員用戶密碼。
adminUserName	VM 系統管理員用戶名稱。
allocatedOutboundPorts	針對預設負載平衡器後端集區中每個節點配置給SNAT的輸出埠數目。默認值為 0，會根據集區大小提供動態埠配置。
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' 時才適用。
clusterUpgradeMode	有新的 Service Fabric 執行時間版本可用時，叢集的升級模式。
ddosProtectionPlanId	指定與叢集虛擬網路相關聯的 DDoS 網路保護計劃資源識別碼。
dnsName	叢集 dns 名稱。
enableAutoOSUpgrade	針對使用操作系統映像與版本「最新」建立的節點類型啟用自動OS升級。此設定的預設值為 false。
enableHttpGatewayExclusiveAuthMode	如果為 true，則 HttpGatewayEndpoint 上不允許令牌型驗證。這需要支援 TLS 1.3 版和更新版本。如果使用令牌型驗證，則必須定義 HttpGatewayTokenAuthConnectionPort。
enableIpv6	將此設定為 true 會為叢集所使用的預設 VNet 建立 IPv6 位址空間。建立叢集之後，就無法變更此設定。此設定的預設值為 false。
enableOutboundOnlyNodeTypes	啟用僅啟用輸出流量的節點類型建立。如果設定，則會為已啟用輸入流量的節點類型建立個別的負載平衡器後端集區。只能在建立叢集時設定。
enableServicePublicIP	將此設定為 true 會將 IPv4 位址連結為 IPv6 位址的 ServicePublicIP。只有在叢集上啟用 IPv6 時，才能將它設定為 True。
etag	如果在回應本文中提供 eTag，它也可以根據一般 etag 慣例提供作為標頭。實體標籤用於比較來自相同要求資源的兩個或多個實體。 HTTP/1.1 在 etag（第 14.19 節）、If-Match（第 14.24 節）、If-None-Match（第 14.26 節）和 If-Range（第 14.27 節）標頭欄位中使用實體標記。
fabricSettings	要設定叢集的自定義網狀架構設定清單。
fqdn	與叢集公用負載平衡器相關聯的完整功能變數名稱。
httpGatewayConnectionPort	用於叢集 HTTP 連線的埠。
httpGatewayTokenAuthConnectionPort	用於對叢集進行令牌驗證型 HTTPS 連線的埠。無法設定為與 HttpGatewayEndpoint 相同的埠。
ipTags	與叢集預設公用IP位址相關聯的IP標籤清單。
ipv4Address	與叢集公用負載平衡器相關聯的 IPv4 位址。
ipv6Address	如果已啟用 IPv6，叢集的 IPv6 位址。
loadBalancingRules	套用至叢集公用負載平衡器的負載平衡規則。
networkSecurityRules	自訂網路安全規則，套用於叢集的 Virtual Network。
provisioningState	受控叢集資源的布建狀態。
publicIPPrefixId	指定負載平衡器將從中配置公用 IPv4 位址之公用 IPv4 前置的資源識別碼。建立叢集之後，就無法變更此設定。
publicIPv6PrefixId	指定負載平衡器將從中配置公用 IPv6 位址的公用 IPv6 前置碼資源識別碼。建立叢集之後，就無法變更此設定。
serviceEndpoints	叢集中子網的服務端點。
skipManagedNsgAssignment	判斷在使用自帶虛擬網路（BYOVNET）配置時，是否跳過將受管理網路安全群組（SF-NSG）指派至叢集子網路。預設值為 false。
sku	受控叢集的SKU
subnetId	如果指定，則會在此子網中建立叢集的節點類型，而不是預設的 VNet。針對叢集指定的 networkSecurityRules 也會套用至此子網。建立叢集之後，就無法變更此設定。
upgradeDescription	升級叢集時要使用的原則。
useCustomVnet	對於新的叢集，此參數表示其使用自備 VNet，但子網是在節點類型層級指定;對於這類叢集，節點類型需要subnetId屬性。
vmImage	節點類型設定的 VM 映像。此屬性會控制要用於叢集的 Service Fabric 元件套件。允許的值為：「Windows」。預設值是「Windows」。
zonalResiliency	指出叢集是否有區域復原能力。
zonalUpdateMode	指出跨 Az 叢集的更新模式。

繼承的屬性

id	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	資源所在的地理位置
name	資源的名稱
systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
tags	資源標籤。
type	資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

屬性詳細資料

addonFeatures

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

addonFeatures?: string[]

屬性值

string[]

adminPassword

VM 系統管理員用戶密碼。

adminPassword?: string

屬性值

string

adminUserName

VM 系統管理員用戶名稱。

adminUserName?: string

屬性值

string

allocatedOutboundPorts

針對預設負載平衡器後端集區中每個節點配置給SNAT的輸出埠數目。默認值為 0，會根據集區大小提供動態埠配置。

allocatedOutboundPorts?: number

屬性值

number

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' 時才適用。

clusterUpgradeCadence?: string

屬性值

string

clusterUpgradeMode

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

clusterUpgradeMode?: string

屬性值

string

ddosProtectionPlanId

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

ddosProtectionPlanId?: string

屬性值

string

dnsName

叢集 dns 名稱。

dnsName?: string

屬性值

string

enableAutoOSUpgrade

針對使用操作系統映像與版本「最新」建立的節點類型啟用自動OS升級。此設定的預設值為 false。

enableAutoOSUpgrade?: boolean

屬性值

boolean

enableHttpGatewayExclusiveAuthMode

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

enableHttpGatewayExclusiveAuthMode?: boolean

屬性值

boolean

enableIpv6

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

enableIpv6?: boolean

屬性值

boolean

enableOutboundOnlyNodeTypes

啟用僅啟用輸出流量的節點類型建立。如果設定，則會為已啟用輸入流量的節點類型建立個別的負載平衡器後端集區。只能在建立叢集時設定。

enableOutboundOnlyNodeTypes?: boolean

屬性值

boolean

enableServicePublicIP

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

enableServicePublicIP?: boolean

屬性值

boolean

etag

如果在回應本文中提供 eTag，它也可以根據一般 etag 慣例提供作為標頭。實體標籤用於比較來自相同要求資源的兩個或多個實體。 HTTP/1.1 在 etag（第 14.19 節）、If-Match（第 14.24 節）、If-None-Match（第 14.26 節）和 If-Range（第 14.27 節）標頭欄位中使用實體標記。

etag?: string

屬性值

string

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

自訂網路安全規則，套用於叢集的 Virtual Network。

networkSecurityRules?: NetworkSecurityRule[]

屬性值

NetworkSecurityRule[]

provisioningState

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

provisioningState?: string

屬性值

string

publicIPPrefixId

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

publicIPPrefixId?: string

屬性值

string

publicIPv6PrefixId

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

publicIPv6PrefixId?: string

屬性值

string

serviceEndpoints

叢集中子網的服務端點。

serviceEndpoints?: ServiceEndpoint[]

屬性值

ServiceEndpoint[]

skipManagedNsgAssignment

判斷在使用自帶虛擬網路（BYOVNET）配置時，是否跳過將受管理網路安全群組（SF-NSG）指派至叢集子網路。預設值為 false。

skipManagedNsgAssignment?: boolean

屬性值

boolean

sku

受控叢集的SKU

sku: Sku

屬性值

Sku

subnetId

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

subnetId?: string

屬性值

string

upgradeDescription

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

upgradeDescription?: ClusterUpgradePolicy

屬性值

ClusterUpgradePolicy

useCustomVnet

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

useCustomVnet?: boolean

屬性值

boolean

vmImage

節點類型設定的 VM 映像。此屬性會控制要用於叢集的 Service Fabric 元件套件。允許的值為：「Windows」。預設值是「Windows」。

vmImage?: string

屬性值

string

zonalResiliency

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

zonalResiliency?: boolean

屬性值

boolean

zonalUpdateMode

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

zonalUpdateMode?: string

屬性值

string

繼承的屬性詳細資料

id

資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

屬性值

string

繼承自TrackedResource.id

location

資源所在的地理位置

location: string

屬性值

string

繼承自TrackedResource.location

name

資源的名稱

name?: string

屬性值

string

繼承自 TrackedResource.name 的

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。

systemData?: SystemData

屬性值

SystemData

繼承自TrackedResource.systemData

type

資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

type?: string

屬性值

string

繼承自TrackedResource.type

共用方式為

ManagedCluster interface

屬性

繼承的屬性

屬性詳細資料

addonFeatures

屬性值

adminPassword

屬性值

adminUserName

屬性值

allocatedOutboundPorts

屬性值

allowRdpAccess

屬性值

applicationTypeVersionsCleanupPolicy

屬性值

autoGeneratedDomainNameLabelScope

屬性值

auxiliarySubnets

屬性值

azureActiveDirectory

屬性值

clientConnectionPort

屬性值

clients

屬性值

clusterCertificateThumbprints

屬性值

clusterCodeVersion

屬性值

clusterId

屬性值

clusterState

屬性值

clusterUpgradeCadence

屬性值

clusterUpgradeMode

屬性值

ddosProtectionPlanId

屬性值

dnsName

屬性值

enableAutoOSUpgrade

屬性值

enableHttpGatewayExclusiveAuthMode

屬性值

enableIpv6

屬性值

enableOutboundOnlyNodeTypes

屬性值

enableServicePublicIP

屬性值

etag

屬性值

fabricSettings

屬性值

fqdn

屬性值

httpGatewayConnectionPort

屬性值

httpGatewayTokenAuthConnectionPort

屬性值

ipTags

屬性值

ipv4Address

屬性值

ipv6Address

屬性值

loadBalancingRules

屬性值

networkSecurityRules

屬性值

provisioningState

屬性值

publicIPPrefixId

屬性值

publicIPv6PrefixId

屬性值

serviceEndpoints