Cluster interface

パッケージ:

@azure/arm-servicefabric

クラスター リソース

Extends

Resource

プロパティ

addOnFeatures	クラスターで有効にするアドオン機能の一覧。
applicationTypeVersionsCleanupPolicy	未使用のバージョンをクリーンアップするために使用されるポリシー。
availableClusterVersions	このクラスターで使用できる Service Fabric ランタイム バージョン。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
azureActiveDirectory	クラスターの AAD 認証設定。
certificate	クラスターのセキュリティ保護に使用する証明書。 指定された証明書は、クラスター内のノード間のセキュリティ、クラスター管理エンドポイント用の SSL 証明書、および既定の管理クライアントに使用されます。
certificateCommonNames	クラスターのセキュリティ保護に使用される共通名によって参照されるサーバー証明書の一覧について説明します。
clientCertificateCommonNames	クラスターの管理が許可されている共通名によって参照されるクライアント証明書の一覧。
clientCertificateThumbprints	クラスターの管理が許可されている拇印によって参照されるクライアント証明書の一覧。
clusterCodeVersion	クラスターの Service Fabric ランタイム バージョン。 このプロパティは、upgradeMode が 'Manual' に設定されている場合にのみユーザーを設定できます。 新しいクラスターで使用可能な Service Fabric バージョンの一覧を取得するには、ClusterVersion API使用します。 既存のクラスターで使用可能なバージョンの一覧を取得するには、availableClusterVersions使用します。
clusterEndpoint	Azure リソース プロバイダー エンドポイント。 クラスター内のシステム サービスがこのエンドポイントに接続します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
clusterId	クラスター リソースの一意識別子がサービスによって生成されました。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
clusterState	クラスターの現在の状態。 WaitingForNodes - クラスター リソースが作成され、リソース プロバイダーが Service Fabric VM 拡張機能の起動と報告を待機していることを示します。 デプロイ - Service Fabric ランタイムが VM にインストールされていることを示します。 クラスター リソースは、クラスターが起動し、システム サービスが稼働するまで、この状態になります。 BaselineUpgrade - クラスターのバージョンを確立するためにクラスターがアップグレード中であることを示します。 このアップグレードは、クラスターが初めて起動したときに自動的に開始されます。 UpdatingUserConfiguration - ユーザーが指定した構成でクラスターがアップグレードされていることを示します。 UpdatingUserCertificate - ユーザーが指定した証明書を使用してクラスターがアップグレードされていることを示します。 UpdatingInfrastructure - クラスターが最新の Service Fabric ランタイム バージョンでアップグレードされていることを示します。 これは、upgradeMode が "自動" に設定されている場合にのみ発生します。 EnforcingClusterVersion - クラスターが想定とは異なるバージョンにあり、クラスターが予想されるバージョンにアップグレードされていることを示します。 UpgradeServiceUnreachable - クラスター内のシステム サービスがリソース プロバイダーをポーリングしなくなったことを示します。 この状態のクラスターは、リソース プロバイダーによって管理できません。 自動スケール - クラスターの ReliabilityLevel が調整されていることを示します。 準備完了 - クラスターが安定した状態であることを示します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
diagnosticsStorageAccountConfig	Service Fabric 診断ログを格納するためのストレージ アカウント情報。
eventStoreServiceEnabled	イベント ストア サービスが有効かどうかを示します。
fabricSettings	クラスターを構成するためのカスタム ファブリック設定の一覧。
infrastructureServiceManager	インフラストラクチャ サービス マネージャーが有効かどうかを示します。
managementEndpoint	クラスターの http 管理エンドポイント。
nodeTypes	クラスター内のノードの種類の一覧。
notifications	クラスター イベントの通知チャネルの一覧を示します。
provisioningState	クラスター リソースのプロビジョニング状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
reliabilityLevel	信頼性レベルは、システム サービスのレプリカ セット サイズを設定します。 ReliabilityLevelについて説明します。 なし - ターゲット レプリカ セット数が 1 のシステム サービスを実行します。 これは、テスト クラスターにのみ使用する必要があります。 Bronze - ターゲット レプリカ セット数が 3 のシステム サービスを実行します。 これは、テスト クラスターにのみ使用する必要があります。 Silver - ターゲット レプリカ セット数が 5 のシステム サービスを実行します。 Gold - ターゲット レプリカ セット数が 7 のシステム サービスを実行します。 Platinum - ターゲット レプリカ セット数が 9 のシステム サービスを実行します。
reverseProxyCertificate	リバース プロキシによって使用されるサーバー証明書。
reverseProxyCertificateCommonNames	クラスターのセキュリティ保護に使用される共通名によって参照されるサーバー証明書の一覧について説明します。
sfZonalUpgradeMode	このプロパティは、アップグレード ドメイン (UUID) 内の VM の論理的なグループ化を制御します。 複数の可用性ゾーンを持つノードの種類がクラスターに既に存在する場合、このプロパティは変更できません。
upgradeDescription	クラスターのアップグレード時に使用するポリシー。
upgradeMode	新しい Service Fabric ランタイム バージョンが使用可能な場合のクラスターのアップグレード モード。
upgradePauseEndTimestampUtc	クラスター (UTC) 上の特定の期間、クラスターでのランタイム バージョンの自動アップグレードを一時停止する終了日時を示します。
upgradePauseStartTimestampUtc	クラスター (UTC) 上の特定の期間、クラスターのランタイム バージョンの自動アップグレードを一時停止する開始日時を示します。
upgradeWave	新しいクラスター ランタイム バージョンのアップグレードがリリース後に適用されるタイミングを示します。 既定では Wave0 です。 upgradeMode が "自動" に設定されている場合にのみ適用されます。
vmImage	VM イメージ VMSS が構成されています。 Windows や Linux などの汎用名を使用できます。
vmssZonalUpgradeMode	このプロパティは、仮想マシン スケール セットのアップグレード モードを定義します。複数の可用性ゾーンを持つノードの種類が追加される場合は必須です。
waveUpgradePaused	クラスターへのランタイム バージョンの自動アップグレードを一時停止するブール値。

継承されたプロパティ

etag	Azure リソースの電子タグ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
id	Azure リソース識別子。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
location	Azure リソースの場所。
name	Azure リソース名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
systemData	リソースの作成と最後の変更に関連するメタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
tags	Azure リソース タグ。
type	Azure リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

addOnFeatures

クラスターで有効にするアドオン機能の一覧。

addOnFeatures?: string[]

プロパティ値

string[]

applicationTypeVersionsCleanupPolicy

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

applicationTypeVersionsCleanupPolicy?: ApplicationTypeVersionsCleanupPolicy

プロパティ値

ApplicationTypeVersionsCleanupPolicy

availableClusterVersions

このクラスターで使用できる Service Fabric ランタイム バージョン。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

availableClusterVersions?: ClusterVersionDetails[]

プロパティ値

ClusterVersionDetails[]

azureActiveDirectory

クラスターの AAD 認証設定。

azureActiveDirectory?: AzureActiveDirectory

プロパティ値

AzureActiveDirectory

certificate

クラスターのセキュリティ保護に使用する証明書。 指定された証明書は、クラスター内のノード間のセキュリティ、クラスター管理エンドポイント用の SSL 証明書、および既定の管理クライアントに使用されます。

certificate?: CertificateDescription

プロパティ値

CertificateDescription

certificateCommonNames

クラスターのセキュリティ保護に使用される共通名によって参照されるサーバー証明書の一覧について説明します。

certificateCommonNames?: ServerCertificateCommonNames

プロパティ値

ServerCertificateCommonNames

clientCertificateCommonNames

クラスターの管理が許可されている共通名によって参照されるクライアント証明書の一覧。

clientCertificateCommonNames?: ClientCertificateCommonName[]

プロパティ値

ClientCertificateCommonName[]

clientCertificateThumbprints

クラスターの管理が許可されている拇印によって参照されるクライアント証明書の一覧。

clientCertificateThumbprints?: ClientCertificateThumbprint[]

プロパティ値

ClientCertificateThumbprint[]

clusterCodeVersion

クラスターの Service Fabric ランタイム バージョン。 このプロパティは、upgradeMode が 'Manual' に設定されている場合にのみユーザーを設定できます。 新しいクラスターで使用可能な Service Fabric バージョンの一覧を取得するには、ClusterVersion API使用します。 既存のクラスターで使用可能なバージョンの一覧を取得するには、availableClusterVersions使用します。

clusterCodeVersion?: string

プロパティ値

string

clusterEndpoint

Azure リソース プロバイダー エンドポイント。 クラスター内のシステム サービスがこのエンドポイントに接続します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

clusterEndpoint?: string

プロパティ値

string

clusterId

クラスター リソースの一意識別子がサービスによって生成されました。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

clusterId?: string

プロパティ値

string

clusterState

クラスターの現在の状態。

• WaitingForNodes - クラスター リソースが作成され、リソース プロバイダーが Service Fabric VM 拡張機能の起動と報告を待機していることを示します。
• デプロイ - Service Fabric ランタイムが VM にインストールされていることを示します。 クラスター リソースは、クラスターが起動し、システム サービスが稼働するまで、この状態になります。
• BaselineUpgrade - クラスターのバージョンを確立するためにクラスターがアップグレード中であることを示します。 このアップグレードは、クラスターが初めて起動したときに自動的に開始されます。
• UpdatingUserConfiguration - ユーザーが指定した構成でクラスターがアップグレードされていることを示します。
• UpdatingUserCertificate - ユーザーが指定した証明書を使用してクラスターがアップグレードされていることを示します。
• UpdatingInfrastructure - クラスターが最新の Service Fabric ランタイム バージョンでアップグレードされていることを示します。 これは、upgradeMode が "自動" に設定されている場合にのみ発生します。
• EnforcingClusterVersion - クラスターが想定とは異なるバージョンにあり、クラスターが予想されるバージョンにアップグレードされていることを示します。
• UpgradeServiceUnreachable - クラスター内のシステム サービスがリソース プロバイダーをポーリングしなくなったことを示します。 この状態のクラスターは、リソース プロバイダーによって管理できません。
• 自動スケール - クラスターの ReliabilityLevel が調整されていることを示します。
• 準備完了 - クラスターが安定した状態であることを示します。

注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

clusterState?: string

プロパティ値

string

diagnosticsStorageAccountConfig

Service Fabric 診断ログを格納するためのストレージ アカウント情報。

diagnosticsStorageAccountConfig?: DiagnosticsStorageAccountConfig

プロパティ値

DiagnosticsStorageAccountConfig

eventStoreServiceEnabled

イベント ストア サービスが有効かどうかを示します。

eventStoreServiceEnabled?: boolean

プロパティ値

boolean

fabricSettings

クラスターを構成するためのカスタム ファブリック設定の一覧。

fabricSettings?: SettingsSectionDescription[]

プロパティ値

SettingsSectionDescription[]

infrastructureServiceManager

インフラストラクチャ サービス マネージャーが有効かどうかを示します。

infrastructureServiceManager?: boolean

プロパティ値

boolean

managementEndpoint

クラスターの http 管理エンドポイント。

managementEndpoint?: string

プロパティ値

string

nodeTypes

クラスター内のノードの種類の一覧。

nodeTypes?: NodeTypeDescription[]

プロパティ値

NodeTypeDescription[]

notifications

クラスター イベントの通知チャネルの一覧を示します。

notifications?: Notification_2[]

プロパティ値

Notification[]

provisioningState

クラスター リソースのプロビジョニング状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

provisioningState?: string

プロパティ値

string

reliabilityLevel

信頼性レベルは、システム サービスのレプリカ セット サイズを設定します。 ReliabilityLevelについて説明します。

• なし - ターゲット レプリカ セット数が 1 のシステム サービスを実行します。 これは、テスト クラスターにのみ使用する必要があります。
• Bronze - ターゲット レプリカ セット数が 3 のシステム サービスを実行します。 これは、テスト クラスターにのみ使用する必要があります。
• Silver - ターゲット レプリカ セット数が 5 のシステム サービスを実行します。
• Gold - ターゲット レプリカ セット数が 7 のシステム サービスを実行します。
• Platinum - ターゲット レプリカ セット数が 9 のシステム サービスを実行します。

reliabilityLevel?: string

プロパティ値

string

reverseProxyCertificate

リバース プロキシによって使用されるサーバー証明書。

reverseProxyCertificate?: CertificateDescription

プロパティ値

CertificateDescription

reverseProxyCertificateCommonNames

クラスターのセキュリティ保護に使用される共通名によって参照されるサーバー証明書の一覧について説明します。

reverseProxyCertificateCommonNames?: ServerCertificateCommonNames

プロパティ値

ServerCertificateCommonNames

sfZonalUpgradeMode

このプロパティは、アップグレード ドメイン (UUID) 内の VM の論理的なグループ化を制御します。 複数の可用性ゾーンを持つノードの種類がクラスターに既に存在する場合、このプロパティは変更できません。

sfZonalUpgradeMode?: string

プロパティ値

string

upgradeDescription

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

upgradeDescription?: ClusterUpgradePolicy

プロパティ値

ClusterUpgradePolicy

upgradeMode

新しい Service Fabric ランタイム バージョンが使用可能な場合のクラスターのアップグレード モード。

upgradeMode?: string

プロパティ値

string

upgradePauseEndTimestampUtc

クラスター (UTC) 上の特定の期間、クラスターでのランタイム バージョンの自動アップグレードを一時停止する終了日時を示します。

upgradePauseEndTimestampUtc?: Date

プロパティ値

Date

upgradePauseStartTimestampUtc

クラスター (UTC) 上の特定の期間、クラスターのランタイム バージョンの自動アップグレードを一時停止する開始日時を示します。

upgradePauseStartTimestampUtc?: Date

プロパティ値

Date

upgradeWave

新しいクラスター ランタイム バージョンのアップグレードがリリース後に適用されるタイミングを示します。 既定では Wave0 です。 upgradeMode が "自動" に設定されている場合にのみ適用されます。

upgradeWave?: string

プロパティ値

string

vmImage

VM イメージ VMSS が構成されています。 Windows や Linux などの汎用名を使用できます。

vmImage?: string

プロパティ値

string

vmssZonalUpgradeMode

このプロパティは、仮想マシン スケール セットのアップグレード モードを定義します。複数の可用性ゾーンを持つノードの種類が追加される場合は必須です。

vmssZonalUpgradeMode?: string

プロパティ値

string

waveUpgradePaused

クラスターへのランタイム バージョンの自動アップグレードを一時停止するブール値。

waveUpgradePaused?: boolean

プロパティ値

boolean

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

etag

Azure リソースの電子タグ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

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 から継承された