FabricClient.HealthClient.GetApplicationHealthAsync メソッド

定義

オーバーロード

GetApplicationHealthAsync(ApplicationHealthQueryDescription)

指定したクエリの説明を使用して、指定した Service Fabric アプリケーションの正常性を非同期に取得します。

GetApplicationHealthAsync(Uri)

指定した Service Fabric アプリケーションの正常性を非同期に取得します。

GetApplicationHealthAsync(Uri, ApplicationHealthPolicy)

アプリケーション URI と正常性ポリシーを使用して、指定した Service Fabric アプリケーションの正常性を非同期に取得します。

GetApplicationHealthAsync(ApplicationHealthQueryDescription, TimeSpan, CancellationToken)

指定したクエリ入力、タイムアウト、およびキャンセル トークンを使用して、指定した Service Fabric アプリケーションの正常性を非同期に取得します。

GetApplicationHealthAsync(Uri, TimeSpan, CancellationToken)

指定したアプリケーション URI、タイムアウト、およびキャンセル トークンを使用して、指定した Service Fabric アプリケーションの正常性を非同期に取得します。

GetApplicationHealthAsync(Uri, ApplicationHealthPolicy, TimeSpan, CancellationToken)

指定したタイムアウトおよびキャンセル トークンを使用して、指定した Service Fabric アプリケーションの正常性を非同期的に取得します。

GetApplicationHealthAsync(ApplicationHealthQueryDescription)

指定したクエリの説明を使用して、指定した Service Fabric アプリケーションの正常性を非同期に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (System.Fabric.Description.ApplicationHealthQueryDescription queryDescription);
member this.GetApplicationHealthAsync : System.Fabric.Description.ApplicationHealthQueryDescription -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>
Public Function GetApplicationHealthAsync (queryDescription As ApplicationHealthQueryDescription) As Task(Of ApplicationHealth)

パラメーター

queryDescription
ApplicationHealthQueryDescription

アプリケーションの ApplicationHealthQueryDescription 正常性を取得するクエリを記述するインスタンス。

戻り値

指定した Service Fabric アプリケーションの正常性。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作の完了に指定した時間以上かかる場合に返されます。

次のいずれかが原因で発生します。

FabricHealthEntityNotFound.

InvalidNameUri が有効な Service Fabric 名でない場合 ApplicationName は が返されます。

CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。

InvalidCredentialType.

InvalidX509FindType.

InvalidX509StoreLocation.

InvalidX509StoreName.

InvalidX509Thumbprint.

InvalidProtectionLevel.

InvalidX509Store.

InvalidSubjectName.

InvalidAllowedCommonNameList.

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理しきれなすぎる場合に返されます。

次のいずれかが原因で発生します。

この操作に対してアクセスチェックが失敗すると、E_ACCESSDENIEDが返されます。

適用対象

GetApplicationHealthAsync(Uri)

指定した Service Fabric アプリケーションの正常性を非同期に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (Uri applicationName);
member this.GetApplicationHealthAsync : Uri -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>
Public Function GetApplicationHealthAsync (applicationName As Uri) As Task(Of ApplicationHealth)

パラメーター

applicationName
Uri

Service Fabric アプリケーションの URI。

戻り値

指定した Service Fabric アプリケーションの正常性。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作の完了に指定した時間以上かかる場合に返されます。

次のいずれかが原因で発生します。

FabricHealthEntityNotFound.

InvalidNameUri が有効な Service Fabric 名でない場合 applicationName は が返されます。

CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。

InvalidCredentialType.

InvalidX509FindType.

InvalidX509StoreLocation.

InvalidX509StoreName.

InvalidX509Thumbprint.

InvalidProtectionLevel.

InvalidX509Store.

InvalidSubjectName.

InvalidAllowedCommonNameList.

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理しきれなすぎる場合に返されます。

次のいずれかが原因で発生します。

この操作に対してアクセスチェックが失敗すると、E_ACCESSDENIEDが返されます。

注釈

次の例では、アプリケーションの正常性を取得します。

public static bool GetApplicationHealth(string clusterConnection)
            {
                ApplicationHealth applicationHealth;
                Uri applicationName = new Uri("fabric:/myapp/todo");

                // Connect to the cluster.
                FabricClient fabricClient = new FabricClient(clusterConnection);

                // Get the application health.
                try
                {
                    applicationHealth = fabricClient.HealthManager.GetApplicationHealthAsync(applicationName).Result;
                }
                catch (Exception e)
                {
                    Console.WriteLine("Error: " + e.Message);

                    if (e.InnerException != null)
            Console.WriteLine("  Inner Exception: " + e.InnerException.Message);

                    return false;
                }

                // Display the application health information.
                Console.WriteLine("Get Application Health:");
                Console.WriteLine("  Application {0}: {1}", applicationHealth.ApplicationName, applicationHealth.AggregatedHealthState);

                // List the deployed application health states.
                Console.WriteLine("    Deployed applications:");
                IList<DeployedApplicationHealthState> deployedAppHealthStateList = applicationHealth.DeployedApplicationHealthStates;
                foreach (DeployedApplicationHealthState deployedAppHealthState in deployedAppHealthStateList)
                {
                    Console.WriteLine("      Application: " + deployedAppHealthState.ApplicationName);
                    Console.WriteLine("        Aggregated Health State: " + deployedAppHealthState.AggregatedHealthState);
                    Console.WriteLine("        Node Name: " + deployedAppHealthState.NodeName);
                }

                // List the deployed services health states.
                Console.WriteLine("    Service Health States:");
                IList<ServiceHealthState> deployedSvcsHealthStateList = applicationHealth.ServiceHealthStates;
                foreach (ServiceHealthState serviceHealthState in deployedSvcsHealthStateList)
                {
                    Console.WriteLine("      Service {0}: {1}", serviceHealthState.ServiceName, serviceHealthState.AggregatedHealthState);
                }

                // List the health events.
                Console.WriteLine("    Health Events:");
                IList<HealthEvent> healthEvents = applicationHealth.HealthEvents;
                foreach (HealthEvent healthEvent in healthEvents)
                {
                    Console.WriteLine("      Health Event:");
                    Console.WriteLine("        Last Modified: " + healthEvent.LastModifiedUtcTimestamp);
                    Console.WriteLine("        Source UTC Timestamp: " + healthEvent.SourceUtcTimestamp);
                    Console.WriteLine("        Is Expired: " + healthEvent.IsExpired);
                    Console.WriteLine("        Health Information:");
                    Console.WriteLine("          Description: " + healthEvent.HealthInformation.Description);
                    Console.WriteLine("          Source ID: " + healthEvent.HealthInformation.SourceId);
                    Console.WriteLine("          Health State: " + healthEvent.HealthInformation.HealthState);
                    Console.WriteLine("          Property: " + healthEvent.HealthInformation.Property);
                    Console.WriteLine("          Remove When Expired: " + healthEvent.HealthInformation.RemoveWhenExpired);
                    Console.WriteLine("          Sequence Number: " + healthEvent.HealthInformation.SequenceNumber);
                    Console.WriteLine("          Time to Live: " + healthEvent.HealthInformation.TimeToLive);
                }

                Console.WriteLine();
                return true;
            }

適用対象

GetApplicationHealthAsync(Uri, ApplicationHealthPolicy)

アプリケーション URI と正常性ポリシーを使用して、指定した Service Fabric アプリケーションの正常性を非同期に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (Uri applicationName, System.Fabric.Health.ApplicationHealthPolicy healthPolicy);
member this.GetApplicationHealthAsync : Uri * System.Fabric.Health.ApplicationHealthPolicy -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>
Public Function GetApplicationHealthAsync (applicationName As Uri, healthPolicy As ApplicationHealthPolicy) As Task(Of ApplicationHealth)

パラメーター

applicationName
Uri

Service Fabric アプリケーションの URI。

healthPolicy
ApplicationHealthPolicy

アプリケーションの ApplicationHealthPolicy 評価に使用されるインスタンス。

戻り値

指定した Service Fabric アプリケーションの正常性レポート。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作の完了に指定した時間以上かかる場合に返されます。

次のいずれかが原因で発生します。

FabricHealthEntityNotFound.

InvalidNameUri が有効な Service Fabric 名でない場合 applicationName は が返されます。

CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。

InvalidCredentialType.

InvalidX509FindType.

InvalidX509StoreLocation.

InvalidX509StoreName.

InvalidX509Thumbprint.

InvalidProtectionLevel.

InvalidX509Store.

InvalidSubjectName.

InvalidAllowedCommonNameList.

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理しきれなすぎる場合に返されます。

次のいずれかが原因で発生します。

この操作に対してアクセスチェックが失敗すると、E_ACCESSDENIEDが返されます。

適用対象

GetApplicationHealthAsync(ApplicationHealthQueryDescription, TimeSpan, CancellationToken)

指定したクエリ入力、タイムアウト、およびキャンセル トークンを使用して、指定した Service Fabric アプリケーションの正常性を非同期に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (System.Fabric.Description.ApplicationHealthQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetApplicationHealthAsync : System.Fabric.Description.ApplicationHealthQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>
Public Function GetApplicationHealthAsync (queryDescription As ApplicationHealthQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ApplicationHealth)

パラメーター

queryDescription
ApplicationHealthQueryDescription

アプリケーションの ApplicationHealthQueryDescription 正常性を取得するクエリを記述するインスタンス。

timeout
TimeSpan

Service Fabric が を返す TimeoutException前にこの操作を続行できる最大時間。

cancellationToken
CancellationToken

操作が監視しているキャンセル トークン。 操作を取り消す必要があることを示す通知を送信するために使用できます。 取り消しはアドバイザリであり、取り消された場合でも操作が完了する可能性があることに注意してください。

戻り値

指定した Service Fabric アプリケーションの正常性レポート。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作が完了するために指定 timeout されたユーザーよりも多くかかる場合に返されます。

次のいずれかが原因で発生します。

FabricHealthEntityNotFound.

InvalidNameUri が有効な Service Fabric 名でない場合 ApplicationName は が返されます。

CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。

InvalidCredentialType.

InvalidX509FindType.

InvalidX509StoreLocation.

InvalidX509StoreName.

InvalidX509Thumbprint.

InvalidProtectionLevel.

InvalidX509Store.

InvalidSubjectName.

InvalidAllowedCommonNameList.

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理しきれなすぎる場合に返されます。

次のいずれかが原因で発生します。

この操作に対してアクセスチェックが失敗すると、E_ACCESSDENIEDが返されます。

適用対象

GetApplicationHealthAsync(Uri, TimeSpan, CancellationToken)

指定したアプリケーション URI、タイムアウト、およびキャンセル トークンを使用して、指定した Service Fabric アプリケーションの正常性を非同期に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (Uri applicationName, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetApplicationHealthAsync : Uri * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>
Public Function GetApplicationHealthAsync (applicationName As Uri, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ApplicationHealth)

パラメーター

applicationName
Uri

Service Fabric アプリケーションの URI。

timeout
TimeSpan

Service Fabric が を返す TimeoutException前にこの操作を続行できる最大時間。

cancellationToken
CancellationToken

操作が監視しているキャンセル トークン。 操作を取り消す必要があることを示す通知を送信するために使用できます。 取り消しはアドバイザリであり、取り消された場合でも操作が完了する可能性があることに注意してください。

戻り値

指定した Service Fabric アプリケーションの正常性レポート。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作が完了するために指定 timeout されたユーザーよりも多くかかる場合に返されます。

次のいずれかが原因で発生します。

FabricHealthEntityNotFound.

InvalidNameUri が有効な Service Fabric 名でない場合 applicationName は が返されます。

CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。

InvalidCredentialType.

InvalidX509FindType.

InvalidX509StoreLocation.

InvalidX509StoreName.

InvalidX509Thumbprint.

InvalidProtectionLevel.

InvalidX509Store.

InvalidSubjectName.

InvalidAllowedCommonNameList.

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理しきれなすぎる場合に返されます。

次のいずれかが原因で発生します。

この操作に対してアクセスチェックが失敗すると、E_ACCESSDENIEDが返されます。

適用対象

GetApplicationHealthAsync(Uri, ApplicationHealthPolicy, TimeSpan, CancellationToken)

指定したタイムアウトおよびキャンセル トークンを使用して、指定した Service Fabric アプリケーションの正常性を非同期的に取得します。

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (Uri applicationName, System.Fabric.Health.ApplicationHealthPolicy healthPolicy, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetApplicationHealthAsync : Uri * System.Fabric.Health.ApplicationHealthPolicy * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>
Public Function GetApplicationHealthAsync (applicationName As Uri, healthPolicy As ApplicationHealthPolicy, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ApplicationHealth)

パラメーター

applicationName
Uri

Service Fabric アプリケーションの URI。

healthPolicy
ApplicationHealthPolicy

アプリケーションの正常性を評価するために使用されるアプリケーション正常性ポリシー。

timeout
TimeSpan

Service Fabric が を返す TimeoutException前にこの操作を続行できる最大時間。

cancellationToken
CancellationToken

操作が監視しているキャンセル トークン。 操作を取り消す必要があることを示す通知を送信するために使用できます。 取り消しはアドバイザリであり、取り消された場合でも操作が完了する可能性があることに注意してください。

戻り値

指定した Service Fabric アプリケーションの正常性レポート。

例外

オブジェクトは FabricClient 閉じた状態です。 使用しているオブジェクトを FabricClient 破棄し、新しい FabricClient オブジェクトをインスタンス化します。

null 参照が有効な引数として受け入れられないメソッドに渡されるときに返されます。

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

次のいずれかが原因で発生します。

OperationTimedOut は、操作が完了するために指定 timeout されたユーザーよりも多くかかる場合に返されます。

次のいずれかが原因で発生します。

FabricHealthEntityNotFound.

InvalidNameUri が有効な Service Fabric 名でない場合 applicationName は が返されます。

CommunicationError は、通信エラーが原因で操作が失敗した場合に返されます。

InvalidCredentialType.

InvalidX509FindType.

InvalidX509StoreLocation.

InvalidX509StoreName.

InvalidX509Thumbprint.

InvalidProtectionLevel.

InvalidX509Store.

InvalidSubjectName.

InvalidAllowedCommonNameList.

次のいずれかが原因で発生します。

ServiceTooBusy は、サービスがビジー状態で操作を処理しきれなすぎる場合に返されます。

次のいずれかが原因で発生します。

この操作に対してアクセスチェックが失敗すると、E_ACCESSDENIEDが返されます。

適用対象