ManagedCluster interface

パッケージ:

@azure/arm-servicefabricmanagedclusters

マネージド クラスター リソース

Extends

TrackedResource

プロパティ

addonFeatures	クラスターで有効にするアドオン機能の一覧。
adminPassword	VM 管理者のユーザー パスワード。
adminUserName	VM 管理者ユーザー名。
allocatedOutboundPorts	既定のロード バランサーのバックエンド プール内の各ノードに対して SNAT に割り当てられた送信ポートの数。 既定値は 0 で、プール サイズに基づいて動的なポート割り当てを提供します。
allowRdpAccess	これを true に設定すると、VM への RDP アクセスが有効になります。 既定の NSG 規則は、インターネットへの RDP ポートを開きます。このポートは、カスタム ネットワーク セキュリティ規則でオーバーライドできます。 この設定の既定値は false です。
applicationTypeVersionsCleanupPolicy	未使用のバージョンをクリーンアップするために使用されるポリシー。
autoGeneratedDomainNameLabelScope	このプロパティは、クラスター証明書にパブリック CA 証明書を使用するためのエントリ ポイントです。これは、パブリック CA 証明書のサブジェクトと一致する、作成されたカスタム FQDN に対して許可される再利用のレベルを指定します。
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 ネットワーク保護プランのリソース ID を指定します。
dnsName	クラスターの DNS 名。
enableAutoOSUpgrade	バージョン 'latest' の OS イメージを使用して作成されたノードの種類に対して、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 規則に従ってヘッダーとして提供することもできます。 エンティティ タグは、同じ要求されたリソースから 2 つ以上のエンティティを比較するために使用されます。 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 プレフィックスのリソース ID を指定します。 この設定は、クラスターが作成された後は変更できません。
publicIPv6PrefixId	ロード バランサーがパブリック IPv6 アドレスを割り当てるパブリック IPv6 プレフィックスのリソース ID を指定します。 この設定は、クラスターが作成された後は変更できません。
serviceEndpoints	クラスター内のサブネットのサービス エンドポイント。
skipManagedNsgAssignment	Bring your-Own Virtual Network(BYOVNET)構成を使用する場合、管理ネットワークセキュリティグループ(SF-NSG)をクラスタサブネットに割り当てるかどうかを判断します。 既定値は false です。
sku	マネージド クラスターの SKU
subnetId	指定した場合、クラスターのノードの種類は、既定の VNet ではなく、このサブネットに作成されます。 クラスターに指定された networkSecurityRules も、このサブネットに適用されます。 この設定は、クラスターが作成された後は変更できません。
upgradeDescription	クラスターのアップグレード時に使用するポリシー。
useCustomVnet	新しいクラスターの場合、このパラメーターは Bring Your Own VNet を使用することを示しますが、サブネットはノード タイプ レベルで指定されます。このようなクラスターでは、ノードの種類に subnetId プロパティが必要です。
vmImage	ノードの種類が構成されている VM イメージ。 このプロパティは、クラスターに使用する Service Fabric コンポーネント パッケージを制御します。 許可される値は「Windows」です。 デフォルト値は「Windows」です。
zonalResiliency	クラスターにゾーンの回復性があるかどうかを示します。
zonalUpdateMode	クロス Az クラスターの更新モードを示します。

継承されたプロパティ

id	リソースの完全修飾リソース 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 に設定すると、VM への RDP アクセスが有効になります。 既定の NSG 規則は、インターネットへの RDP ポートを開きます。このポートは、カスタム ネットワーク セキュリティ規則でオーバーライドできます。 この設定の既定値は false です。

allowRdpAccess?: boolean

プロパティ値

boolean

applicationTypeVersionsCleanupPolicy

未使用のバージョンをクリーンアップするために使用されるポリシー。

applicationTypeVersionsCleanupPolicy?: ApplicationTypeVersionsCleanupPolicy

プロパティ値

ApplicationTypeVersionsCleanupPolicy

autoGeneratedDomainNameLabelScope

このプロパティは、クラスター証明書にパブリック CA 証明書を使用するためのエントリ ポイントです。これは、パブリック CA 証明書のサブジェクトと一致する、作成されたカスタム FQDN に対して許可される再利用のレベルを指定します。

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 ネットワーク保護プランのリソース ID を指定します。

ddosProtectionPlanId?: string

プロパティ値

string

dnsName

クラスターの DNS 名。

dnsName?: string

プロパティ値

string

enableAutoOSUpgrade

バージョン 'latest' の OS イメージを使用して作成されたノードの種類に対して、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 規則に従ってヘッダーとして提供することもできます。 エンティティ タグは、同じ要求されたリソースから 2 つ以上のエンティティを比較するために使用されます。 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 プレフィックスのリソース ID を指定します。 この設定は、クラスターが作成された後は変更できません。

publicIPPrefixId?: string

プロパティ値

string

publicIPv6PrefixId

ロード バランサーがパブリック IPv6 アドレスを割り当てるパブリック IPv6 プレフィックスのリソース ID を指定します。 この設定は、クラスターが作成された後は変更できません。

publicIPv6PrefixId?: string

プロパティ値

string

serviceEndpoints

クラスター内のサブネットのサービス エンドポイント。

serviceEndpoints?: ServiceEndpoint[]

プロパティ値

ServiceEndpoint[]

skipManagedNsgAssignment

Bring your-Own Virtual Network(BYOVNET)構成を使用する場合、管理ネットワークセキュリティグループ(SF-NSG)をクラスタサブネットに割り当てるかどうかを判断します。 既定値は false です。

skipManagedNsgAssignment?: boolean

プロパティ値

boolean

sku

マネージド クラスターの SKU

sku: Sku

プロパティ値

Sku

subnetId

指定した場合、クラスターのノードの種類は、既定の VNet ではなく、このサブネットに作成されます。 クラスターに指定された networkSecurityRules も、このサブネットに適用されます。 この設定は、クラスターが作成された後は変更できません。

subnetId?: string

プロパティ値

string

upgradeDescription

クラスターのアップグレード時に使用するポリシー。

upgradeDescription?: ClusterUpgradePolicy

プロパティ値

ClusterUpgradePolicy

useCustomVnet

新しいクラスターの場合、このパラメーターは Bring Your Own VNet を使用することを示しますが、サブネットはノード タイプ レベルで指定されます。このようなクラスターでは、ノードの種類に subnetId プロパティが必要です。

useCustomVnet?: boolean

プロパティ値

boolean

vmImage

ノードの種類が構成されている VM イメージ。 このプロパティは、クラスターに使用する Service Fabric コンポーネント パッケージを制御します。 許可される値は「Windows」です。 デフォルト値は「Windows」です。

vmImage?: string

プロパティ値

string

zonalResiliency

クラスターにゾーンの回復性があるかどうかを示します。

zonalResiliency?: boolean

プロパティ値

boolean

zonalUpdateMode

クロス Az クラスターの更新モードを示します。

zonalUpdateMode?: string

プロパティ値

string

継承されたプロパティの詳細

id

リソースの完全修飾リソース 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 から継承

tags

リソース タグ。

tags?: Record<string, string>

プロパティ値

Record<string, string>

TrackedResource.tags から継承された

type

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

type?: string

プロパティ値

string

trackedResource.typeから継承された