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

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AuthTokenBufferSize

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

Type:	Int64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AzureActiveDirectory

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-CloudServiceDNSNames

内部使用専用です。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CloudServiceName

内部使用専用です。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterSpn

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConnectionEndpoint

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

IPv4Address:ClientConnectionEndpoint [IPv6Address]:ClientConnectionEndpoint FQDN:ClientConnectionEndpoint

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ConnectionInitializationTimeoutInSec

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

Type:	Double
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DSTS

内部使用専用です。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-FindType

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

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

Type:	X509FindType
Accepted values:	FindByThumbprint, FindBySubjectName, FindBySubjectDistinguishedName, FindByIssuerName, FindByIssuerDistinguishedName, FindBySerialNumber, FindByTimeValid, FindByTimeNotYetValid, FindByTimeExpired, FindByTemplateName, FindByApplicationPolicy, FindByCertificatePolicy, FindByExtension, FindByKeyUsage, FindBySubjectKeyIdentifier
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-FindValue

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-GetMetadata

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HealthOperationTimeoutInSec

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

Type:	Double
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HealthReportRetrySendIntervalInSec

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

Type:	Double
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HealthReportSendIntervalInSec

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

Type:	Double
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Interactive

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

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-KeepAliveIntervalInSec

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

Type:	Double
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MetaDataEndpoint

内部使用専用です。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PartitionLocationCacheLimit

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

Type:	Int64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SecurityToken

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServerCertThumbprint

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServerCommonName

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServiceChangePollIntervalInSec

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

Type:	Double
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipChecks

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

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StoreLocation

証明書のストアの場所を指定します。このパラメーターの有効値は、次のとおりです。

CurrentUser
LocalMachine

Type:	StoreLocation
Accepted values:	CurrentUser, LocalMachine
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StoreName

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeoutSec

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WindowsCredential

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-X509Credential

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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: プライマリチェックなしでクラスターに接続する