Connect-ServiceFabricCluster

リファレンス

モジュール:: ServiceFabric

Service Fabric クラスターへの接続を作成します。

構文

Connect-ServiceFabricCluster
       [[-ConnectionEndpoint] <String[]>]
       [-AllowNetworkConnectionOnly]
       [-ConnectionInitializationTimeoutInSec <Double>]
       [-HealthOperationTimeoutInSec <Double>]
       [-HealthReportSendIntervalInSec <Double>]
       [-HealthReportRetrySendIntervalInSec <Double>]
       [-KeepAliveIntervalInSec <Double>]
       [-ServiceChangePollIntervalInSec <Double>]
       [-PartitionLocationCacheLimit <Int64>]
       [-AuthTokenBufferSize <Int64>]
       [-SkipChecks <Boolean>]
       [-TimeoutSec <Int32>]
       [<CommonParameters>]

Connect-ServiceFabricCluster
       [-ConnectionEndpoint] <String[]>
       [-AllowNetworkConnectionOnly]
       [-WindowsCredential]
       [-ClusterSpn <String>]
       [-ConnectionInitializationTimeoutInSec <Double>]
       [-HealthOperationTimeoutInSec <Double>]
       [-HealthReportSendIntervalInSec <Double>]
       [-HealthReportRetrySendIntervalInSec <Double>]
       [-KeepAliveIntervalInSec <Double>]
       [-ServiceChangePollIntervalInSec <Double>]
       [-PartitionLocationCacheLimit <Int64>]
       [-AuthTokenBufferSize <Int64>]
       [-SkipChecks <Boolean>]
       [-TimeoutSec <Int32>]
       [<CommonParameters>]

Connect-ServiceFabricCluster
       [-ConnectionEndpoint] <String[]>
       [-AllowNetworkConnectionOnly]
       [-X509Credential]
       [-ServerCommonName <String[]>]
       [-ServerCertThumbprint <String[]>]
       -FindType <X509FindType>
       -FindValue <String>
       [-StoreLocation <StoreLocation>]
       [-StoreName <String>]
       [-ConnectionInitializationTimeoutInSec <Double>]
       [-HealthOperationTimeoutInSec <Double>]
       [-HealthReportSendIntervalInSec <Double>]
       [-HealthReportRetrySendIntervalInSec <Double>]
       [-KeepAliveIntervalInSec <Double>]
       [-ServiceChangePollIntervalInSec <Double>]
       [-PartitionLocationCacheLimit <Int64>]
       [-AuthTokenBufferSize <Int64>]
       [-SkipChecks <Boolean>]
       [-TimeoutSec <Int32>]
       [<CommonParameters>]

Connect-ServiceFabricCluster
       [-ConnectionEndpoint] <String[]>
       [-AllowNetworkConnectionOnly]
       [-ServerCommonName <String[]>]
       [-ServerCertThumbprint <String[]>]
       [-DSTS]
       -MetaDataEndpoint <String>
       [-CloudServiceName <String>]
       [-CloudServiceDNSNames <String[]>]
       [-ConnectionInitializationTimeoutInSec <Double>]
       [-HealthOperationTimeoutInSec <Double>]
       [-HealthReportSendIntervalInSec <Double>]
       [-HealthReportRetrySendIntervalInSec <Double>]
       [-KeepAliveIntervalInSec <Double>]
       [-ServiceChangePollIntervalInSec <Double>]
       [-PartitionLocationCacheLimit <Int64>]
       [-AuthTokenBufferSize <Int64>]
       [-Interactive <Boolean>]
       [-SkipChecks <Boolean>]
       [-TimeoutSec <Int32>]
       [<CommonParameters>]

Connect-ServiceFabricCluster
       [-ConnectionEndpoint] <String[]>
       [-AllowNetworkConnectionOnly]
       [-ServerCommonName <String[]>]
       [-ServerCertThumbprint <String[]>]
       [-AzureActiveDirectory]
       [-SecurityToken <String>]
       [-GetMetadata]
       [-ConnectionInitializationTimeoutInSec <Double>]
       [-HealthOperationTimeoutInSec <Double>]
       [-HealthReportSendIntervalInSec <Double>]
       [-HealthReportRetrySendIntervalInSec <Double>]
       [-KeepAliveIntervalInSec <Double>]
       [-ServiceChangePollIntervalInSec <Double>]
       [-PartitionLocationCacheLimit <Int64>]
       [-AuthTokenBufferSize <Int64>]
       [-SkipChecks <Boolean>]
       [-TimeoutSec <Int32>]
       [<CommonParameters>]

説明

Connect-ServiceFabricCluster コマンドレットは、スタンドアロンの Service Fabric クラスターへの接続を作成し、そのクラスターの管理アクションを実行できるようにします。クラスターに接続した後、Get-ServiceFabricClusterConnection コマンドレットを使用して、接続の設定を表示できます。

Service Fabric クラスターを管理するには、[管理者として実行] オプションを使用して Windows PowerShell を起動します。

例

例 1: クラスターに接続する

PS C:\> Connect-ServiceFabricCluster -ConnectionEndpoint "ServiceFabric01.ContosoCloudApp.net:19000"

このコマンドは、指定されたクラスターへの接続を作成します。

例 2: X.509 証明書を使用してクラスターに接続する

PS C:\> $ConnectArgs = @{  
    ConnectionEndpoint = 'mycluster.cloudapp.net:19000'
    X509Credential = $True
    StoreLocation = 'CurrentUser'
    StoreName = "MY"
    ServerCommonName = "mycluster.cloudapp.net"
    FindType = 'FindByThumbprint'
    FindValue = "AA11BB22CC33DD44EE55FF66AA77BB88CC99DD00"   
}
PS C:\> Connect-ServiceFabricCluster @ConnectArgs

このコマンドは、X.509 証明書を使用してクラスターに接続します。このコマンドでは、Windows PowerShell のスプラッティング機能を使用してパラメーターのハッシュテーブルを作成し、それらを Connect-ServiceFabricCluster コマンドレットに提供します。

例 3: X.509 証明書を使用してマネージドクラスターに接続する

PS C:\> $resourceGroup = 'mycluster'
PS C:\> $managedCluster = Get-AzServiceFabricManagedCluster -ResourceGroupName $resourceGroup
PS C:\> $ConnectArgs = @{  
    ConnectionEndpoint = "$($managedCluster.Fqdn):$($managedCluster.ClientConnectionPort)"
    X509Credential = $true
    StoreLocation = 'CurrentUser'
    StoreName = "MY"
    ServerCertThumbprint = (Get-AzResource -ResourceId $managedCluster.Id).Properties.clusterCertificateThumbprints
    FindType = 'FindByThumbprint'
    FindValue = "AA11BB22CC33DD44EE55FF66AA77BB88CC99DD00"   
}
PS C:\> Connect-ServiceFabricCluster @ConnectArgs

注: マネージドクラスターに接続するには、サーバー証明書の拇印を照会するために PowerShell 'Az.ServiceFabric' モジュールと 'Az.Resources' モジュールが必要です。

このコマンドは、最初にマネージドクラスターリソースに対して現在のサーバー証明書の拇印を照会してから、X509 証明書を使用してクラスターに接続します。マネージドクラスターの完全なリソース ID を含む接続情報を取得するマネージドクラスターのリソースグループの名前を指定します。「Service Fabric マネージドクラスターへの接続」を参照してください。

このコマンドは、X.509 証明書を使用してクラスターに接続します。

例 4: Azure Active Directory を使用してクラスターに接続する

PS C:\> $ConnectArgs = @{  
    ConnectionEndpoint = 'mycluster.cloudapp.net:19000'
    AzureActiveDirectory = $True
    ServerCertThumbprint = "AA11BB22CC33DD44EE55FF66AA77BB88CC99DD00"
}
PS C:\> Connect-ServiceFabricCluster @ConnectArgs

このコマンドは、Azure Active Directory (AAD) 認証を使用してクラスターに接続します。このコマンドでは、Windows PowerShell のスプラッティング機能を使用してパラメーターのハッシュテーブルを作成し、それらを Connect-ServiceFabricCluster コマンドレットに提供します。

例 5: グループ管理サービスアカウントでセキュリティ保護されたクラスターに接続する

PS C:\> $ConnectArgs = @{  
    ConnectionEndpoint = 'mycluster.cloudapp.net:19000'
    WindowsCredential = $True
    ClusterSpn = 'ServiceFabric/MyCluster.MyDomain.MyOrg'
}
PS C:\> Connect-ServiceFabricCluster @connectArgs

このコマンドでは、Windows PowerShell のスプラッティング機能を使用してパラメーターのハッシュテーブルを作成し、それらを Connect-ServiceFabricCluster コマンドレットに提供します。

例 6: マシンアカウントで保護されたクラスターに接続する

PS C:\> $connectArgs = @{  
    ConnectionEndpoint = 'mycluster.cloudapp.net:19000'
    WindowsCredential = $True
}
PS C:\> Connect-ServiceFabricCluster @connectArgs

このコマンドは、マシンアカウントで保護されたクラスターに接続します。

例 7: プライマリチェックなしでクラスターに接続する

PS C:\> Connect-ServiceFabricCluster -ConnectionEndpoint -SkipChecks $True "ServiceFabric01.ContosoCloudApp.net:19000"

このコマンドは、指定されたクラスターへの接続を作成します。

パラメーター

-AllowNetworkConnectionOnly

基になるネットワーク接続を確立できる限り、システムサービスが応答しない場合でも、コマンドレットでクラスターへの接続が許可されることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-AuthTokenBufferSize

AzureActiveDirectoryで接続する場合は、セキュリティトークンの取得に割り当てるバッファーサイズを指定します。

型:	Int64
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-AzureActiveDirectory

認証と承認に Azure Active Directory を使用することを指定します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CloudServiceDNSNames

このパラメーターは内部でのみ使用されます。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CloudServiceName

このパラメーターは内部でのみ使用されます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ClusterSpn

Windows 資格情報に使用するクラスターセキュリティプリンシパル名を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ConnectionEndpoint

ClusterAddress: ClientConnectionEndpoint という形式でクラスターの接続エンドポイントの配列を指定します。ClusterAddress は、接続先のクラスターノードの IPv4 アドレス、IPv6 アドレス、または完全修飾ドメイン名 (FQDN) で、ClientConnectionEndpoint はクラスターマニフェストで指定されたクライアント接続ポートです。 IPv6 アドレスを角かっこ ([]) で囲みます。有効なエンドポイントの形式は次のとおりです。

IPv4Address:ClientConnectionEndpoint [IPv6Address]:ClientConnectionEndpoint FQDN:ClientConnectionEndpoint

型:	String[]
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ConnectionInitializationTimeoutInSec

操作のタイムアウト期間を秒単位で指定します。

型:	Double
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DSTS

このパラメーターは内部でのみ使用されます。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-FindType

証明書ストア 証明書を検索するための FindValue の種類を指定します。次のフィルターの種類がサポートされています。

FindByThumbprint。証明書の拇印で証明書を検索します。
FindBySubjectName。サブジェクト識別名または共通名による証明書ストア内の検索証明書。サブジェクト識別名が FindValueで指定されている場合、ネイティブ Windows 暗号化 API の制限により、証明書内のサブジェクト名を ASN エンコードでエンコードする必要があります。 FindValueで共通名を指定する場合、このような制限はありません。
FindBySubjectDistinguishedName
FindByIssuerName
FindByIssuerDistinguishedName
FindBySerialNumber
FindByTimeValid
FindByTimeNotYetValid
FindByTimeExpired
FindByTemplateName
FindByApplicationPolicy
FindByCertificatePolicy
FindByExtension
FindByKeyUsage
FindBySubjectKeyIdentifier

型:	X509FindType
指定可能な値:	FindByThumbprint, FindBySubjectName, FindBySubjectDistinguishedName, FindByIssuerName, FindByIssuerDistinguishedName, FindBySerialNumber, FindByTimeValid, FindByTimeNotYetValid, FindByTimeExpired, FindByTemplateName, FindByApplicationPolicy, FindByCertificatePolicy, FindByExtension, FindByKeyUsage, FindBySubjectKeyIdentifier
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-FindValue

証明書ストア内の証明書を検索するフィルター値を指定します。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-GetMetadata

AzureActiveDirectoryを使用して接続すると、トークンの取得に使用されるメタデータが匿名で取得され、認証は試行されません。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HealthOperationTimeoutInSec

正常性レポートを送信するためのタイムアウト期間を秒単位で指定します。正常性操作がタイムアウトするか、通信エラーで失敗すると、正常性クライアントは内部的に操作を再試行します。

型:	Double
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HealthReportRetrySendIntervalInSec

正常性クライアントが、送信に失敗した、または正常性ストアに保持されるレポートの送信を再試行する間隔を秒単位で指定します。サポートされる最小値は 1 秒です。

型:	Double
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HealthReportSendIntervalInSec

正常性クライアントが正常性レポートを正常性ストアに送信する間隔を秒単位で指定します。 0 に設定すると、正常性クライアントはすぐにレポートを送信します。

型:	Double
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Interactive

コマンドレットが対話形式で動作するかどうかを示します。

型:	Boolean
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-KeepAliveIntervalInSec

接続のキープアライブ期間を秒単位で指定します。この間隔により、非同期的に実行される操作中に非アクティブであるため、接続が終了するのを防ぐことができます。

型:	Double
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-MetaDataEndpoint

このパラメーターは内部でのみ使用されます。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PartitionLocationCacheLimit

サービス解決のためにキャッシュされるパーティションの数を指定します。既定値は 0 で、これは制限がないことを意味します。

型:	Int64
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SecurityToken

AzureActiveDirectory使用して接続する場合、指定されたセキュリティトークンは、対話型ユーザーログインを実行するのではなく、認証と承認に直接使用されます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ServerCertThumbprint

クラスター側に予期される拇印の配列を指定します。これらの拇印は、x509 または Azure Active Directory 相互認証中にコマンドレットが正しいクラスターのエンドポイントに接続することを認証するために使用されます。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ServerCommonName

クラスター側に予期される共通名の配列を指定します。これらの名前は、x509 または Azure Active Directory 相互認証中にコマンドレットが正しいクラスターのエンドポイントに接続することを認証するために使用されます。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ServiceChangePollIntervalInSec

ファブリッククライアントがサービスの変更をポーリングする間隔を秒単位で指定します。この間隔は、ポーリングベースのサービスアドレス変更通知の古いモデルで使用されます。

型:	Double
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SkipChecks

クラスターに接続するときにシステムサービスの応答性検証チェックをバイパスすることを示します。

型:	Boolean
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-StoreLocation

証明書のストアの場所を指定します。このパラメーターに使用できる値は次のとおりです。

CurrentUser
LocalMachine

型:	StoreLocation
指定可能な値:	CurrentUser, LocalMachine
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-StoreName

クライアント証明書を読み込む証明書ストアの名前を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TimeoutSec

操作のタイムアウト期間を秒単位で指定します。

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WindowsCredential

コマンドレットが Windows 資格情報を使用して Service Fabric クラスターに接続することを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-X509Credential

コマンドレットが x509 証明書を使用して Service Fabric クラスターとの相互認証を実行することを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

None

出力

System.Object

次の方法で共有

Connect-ServiceFabricCluster

構文

説明

例

例 1: クラスターに接続する

例 2: X.509 証明書を使用してクラスターに接続する

例 3: X.509 証明書を使用してマネージド クラスターに接続する

例 4: Azure Active Directory を使用してクラスターに接続する

例 5: グループ管理サービス アカウントでセキュリティ保護されたクラスターに接続する

例 6: マシン アカウントで保護されたクラスターに接続する

例 7: プライマリ チェックなしでクラスターに接続する

パラメーター

-AllowNetworkConnectionOnly

-AuthTokenBufferSize

-AzureActiveDirectory

-CloudServiceDNSNames

-CloudServiceName

-ClusterSpn

-ConnectionEndpoint

-ConnectionInitializationTimeoutInSec

-DSTS

-FindType

-FindValue

-GetMetadata

-HealthOperationTimeoutInSec

-HealthReportRetrySendIntervalInSec

-HealthReportSendIntervalInSec

-Interactive

-KeepAliveIntervalInSec

-MetaDataEndpoint

-PartitionLocationCacheLimit

-SecurityToken

-ServerCertThumbprint

-ServerCommonName

-ServiceChangePollIntervalInSec

-SkipChecks

-StoreLocation

-StoreName

-TimeoutSec

-WindowsCredential

-X509Credential

入力

出力

関連リンク

その他のリソース

例 3: X.509 証明書を使用してマネージドクラスターに接続する

例 5: グループ管理サービスアカウントでセキュリティ保護されたクラスターに接続する

例 6: マシンアカウントで保護されたクラスターに接続する

例 7: プライマリチェックなしでクラスターに接続する