IPersonGroupOperations.ListWithHttpMessagesAsync メソッド

定義

ユーザー グループの personGroupId、名前、userData、recognitionModel を一覧表示します。<Br/>

  • ユーザー グループは、personGroupId のアルファベット順に格納されます。
  • "start" パラメーター (string、 省略可能) は、返されるエントリの ID が文字列比較によって大きくなるユーザー指定の personGroupId 値です。 "start" は空に設定され、最初の項目からの戻り値を示します。
  • "top" パラメーター (int, optional) は、返されるエントリの数を指定します。 1 回の呼び出しで最大 1000 エントリを返すことができます。 さらにフェッチするには、現在の呼び出しの最後に再調整されたエントリの ID で "start" を指定できます。 <br /> たとえば、合計 5 人のグループ: "group1"、...、"group5" です。 <br /> "start=&top=" は、5 つのグループをすべて返します。 <br /> "start=&top=2" は "group1", "group2" を返します。 <br /> "start=group2&top=3" は、"group3"、"group4"、"group5" を返します。
public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>>> ListWithHttpMessagesAsync (string start = default, int? top = 1000, bool? returnRecognitionModel = False, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ListWithHttpMessagesAsync : string * Nullable<int> * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>>>
Public Function ListWithHttpMessagesAsync (Optional start As String = Nothing, Optional top As Nullable(Of Integer) = 1000, Optional returnRecognitionModel As Nullable(Of Boolean) = False, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of IList(Of PersonGroup)))

パラメーター

start
String

"start" より大きい最小 personGroupId からユーザー グループを一覧表示します。

top
Nullable<Int32>

一覧表示するユーザー グループの数。

returnRecognitionModel
Nullable<Boolean>

操作が応答で 'recognitionModel' を返す必要があるかどうかを示す値。

customHeaders
Dictionary<String,List<String>>

要求に追加されるヘッダー。

cancellationToken
CancellationToken

キャンセル トークン。

戻り値

例外

操作が無効な状態コードを返したときにスローされます

応答を逆シリアル化できない場合にスローされます

必須パラメーターが null の場合にスローされます

適用対象