EnrollmentGroupsClient.RunBulkOperationAsync メソッド

定義

名前空間:

Microsoft.Azure.Devices.Provisioning.Service

アセンブリ:

Microsoft.Azure.Devices.Provisioning.Service.dll

パッケージ:

Microsoft.Azure.Devices.Provisioning.Service v2.0.0-preview002

登録グループのセットを作成、更新、または削除します。

public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationResult> RunBulkOperationAsync (Microsoft.Azure.Devices.Provisioning.Service.BulkOperationMode bulkOperationMode, System.Collections.Generic.IEnumerable<Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup> enrollmentGroups, System.Threading.CancellationToken cancellationToken = default);

member this.RunBulkOperationAsync : Microsoft.Azure.Devices.Provisioning.Service.BulkOperationMode * seq<Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationResult>

Public Function RunBulkOperationAsync (bulkOperationMode As BulkOperationMode, enrollmentGroups As IEnumerable(Of EnrollmentGroup), Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkEnrollmentOperationResult)

パラメーター

bulkOperationMode

BulkOperationMode

BulkOperationMode登録グループに対して実行する 1 つの操作を定義する 。 null にすることはできません。

enrollmentGroups

IEnumerable<EnrollmentGroup>

各登録グループの EnrollmentGroup 説明を含む のコレクション。 null または空にすることはできません。

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task<BulkEnrollmentOperationResult>

各操作の結果を含む オブジェクト。

例外

Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException

クライアントが要求の送信に失敗した場合、またはサービスが一括操作を実行できなかった場合。

ArgumentNullException

指定 enrollmentGroups された が null の場合。

ArgumentException

指定 enrollmentGroups された が空のコレクションの場合。

ProvisioningServiceException

クライアントが要求の送信に失敗した場合、またはサービスが一括操作を実行できなかった場合。

OperationCanceledException

指定 cancellationToken された がキャンセルを要求した場合。

注釈

この API は、複数の登録グループに対して 1 つの操作を実行する手段を提供します。 有効な操作は によって BulkOperationMode決定され、'create'、'update'、'updateIfMatchETag'、または 'delete' にすることができます。