EnrollmentGroupsClient.xml

<Type Name="EnrollmentGroupsClient" FullName="Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroupsClient">
  <TypeSignature Language="C#" Value="public class EnrollmentGroupsClient" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EnrollmentGroupsClient extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroupsClient" />
  <TypeSignature Language="VB.NET" Value="Public Class EnrollmentGroupsClient" />
  <TypeSignature Language="F#" Value="type EnrollmentGroupsClient = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Subclient of <see cref="T:Microsoft.Azure.Devices.Provisioning.Service.ProvisioningServiceClient" /> that handles all enrollment group operations including
            getting/creating/setting/deleting enrollment groups, querying enrollment groups, and getting attestation mechanisms
            for particular enrollment groups.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected EnrollmentGroupsClient ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroupsClient.#ctor" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Creates an instance of this class. Provided for unit testing purposes only.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateOrUpdateAsync">
      <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt; CreateOrUpdateAsync (Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup enrollmentGroup, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt; CreateOrUpdateAsync(class Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup enrollmentGroup, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroupsClient.CreateOrUpdateAsync(Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Function CreateOrUpdateAsync (enrollmentGroup As EnrollmentGroup, Optional cancellationToken As CancellationToken = Nothing) As Task(Of EnrollmentGroup)" />
      <MemberSignature Language="F#" Value="member this.CreateOrUpdateAsync : Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt;" Usage="enrollmentGroupsClient.CreateOrUpdateAsync (enrollmentGroup, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="enrollmentGroup" Type="Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="enrollmentGroup">The enrollment group to create or update.</param>
        <param name="cancellationToken">The cancellation token.</param>
        <summary>
            Create or update an enrollment group.
            </summary>
        <returns>The created or updated enrollment group.</returns>
        <remarks>
            This API creates a new enrollment group or update a existed one. All enrollment group in the Device
            Provisioning Service contains a unique identifier called enrollmentGroupId. If this API is called
            with an enrollmentGroupId that already exists, it will replace the existed enrollment group information
            by the new one. On the other hand, if the enrollmentGroupId does not exit, it will be created.
            </remarks>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException">
            If the service was not able to create or update the enrollment.
            </exception>
        <exception cref="T:System.ArgumentNullException">If the provided <paramref name="enrollmentGroup" /> is null.</exception>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.ProvisioningServiceException">
            If the service was not able to create or update the enrollment.
            </exception>
        <exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
      </Docs>
    </Member>
    <Member MemberName="CreateQuery">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Provisioning.Service.Query CreateQuery (string query, int pageSize = 0, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Devices.Provisioning.Service.Query CreateQuery(string query, int32 pageSize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroupsClient.CreateQuery(System.String,System.Int32,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Function CreateQuery (query As String, Optional pageSize As Integer = 0, Optional cancellationToken As CancellationToken = Nothing) As Query" />
      <MemberSignature Language="F#" Value="member this.CreateQuery : string * int * System.Threading.CancellationToken -&gt; Microsoft.Azure.Devices.Provisioning.Service.Query" Usage="enrollmentGroupsClient.CreateQuery (query, pageSize, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Devices.Provisioning.Service.Query</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="query" Type="System.String" />
        <Parameter Name="pageSize" Type="System.Int32" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="query">The <see cref="T:Microsoft.Azure.Devices.Provisioning.Service.QuerySpecification" /> with the SQL query. It cannot be null.</param>
        <param name="pageSize">The int with the maximum number of items per iteration. It can be 0 for default, but not negative.</param>
        <param name="cancellationToken">The cancellation token.</param>
        <summary>
             Create an enrollment group query.
             </summary>
        <returns>The iterable set of query results.</returns>
        <remarks>
             The service expects a SQL-like query such as
            
             <c>"SELECT * FROM enrollments"</c>.
            
             For each iteration, the query will return a page of results. The maximum number of
             items per page can be specified by the pageSize parameter.
             </remarks>
        <exception cref="T:System.ArgumentNullException">If the provided <paramref name="query" /> is null.</exception>
        <exception cref="T:System.ArgumentException">If the provided <paramref name="query" /> is empty or white space.</exception>
        <exception cref="T:System.ArgumentOutOfRangeException">If the provided <paramref name="pageSize" /> value is less than zero.</exception>
        <exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
      </Docs>
    </Member>
    <Member MemberName="DeleteAsync">
      <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeleteAsync (Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup enrollmentGroup, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeleteAsync(class Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup enrollmentGroup, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroupsClient.DeleteAsync(Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Function DeleteAsync (enrollmentGroup As EnrollmentGroup, Optional cancellationToken As CancellationToken = Nothing) As Task" />
      <MemberSignature Language="F#" Value="member this.DeleteAsync : Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="enrollmentGroupsClient.DeleteAsync (enrollmentGroup, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="enrollmentGroup" Type="Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="enrollmentGroup">The <see cref="T:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup" /> that identifies the enrollmentGroup. It cannot be null.</param>
        <param name="cancellationToken">The cancellation token.</param>
        <summary>
            Delete the enrollment group information.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException">
            If the service was not able to delete the enrollment group information for the provided <paramref name="enrollmentGroup" />.
            </exception>
        <exception cref="T:System.ArgumentNullException">If the provided <paramref name="enrollmentGroup" /> is null.</exception>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.ProvisioningServiceException">
            If the service was not able to delete the enrollment group information for the provided <paramref name="enrollmentGroup" />.
            </exception>
        <exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
      </Docs>
    </Member>
    <Member MemberName="DeleteAsync">
      <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeleteAsync (string enrollmentGroupId, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeleteAsync(string enrollmentGroupId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroupsClient.DeleteAsync(System.String,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Function DeleteAsync (enrollmentGroupId As String, Optional cancellationToken As CancellationToken = Nothing) As Task" />
      <MemberSignature Language="F#" Value="member this.DeleteAsync : string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="enrollmentGroupsClient.DeleteAsync (enrollmentGroupId, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="enrollmentGroupId" Type="System.String" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="enrollmentGroupId">The string that identifies the enrollmentGroup. It cannot be null or empty.</param>
        <param name="cancellationToken">The cancellation token.</param>
        <summary>
            Delete an enrollment group.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException">
            If the service was not able to delete the enrollment group information for the provided <paramref name="enrollmentGroupId" />.
            </exception>
        <exception cref="T:System.ArgumentNullException">If the provided <paramref name="enrollmentGroupId" /> is null.</exception>
        <exception cref="T:System.ArgumentException">If the provided <paramref name="enrollmentGroupId" /> is empty or white space.</exception>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.ProvisioningServiceException">
            If the service was not able to delete the enrollment group information for the provided <paramref name="enrollmentGroupId" />.
            </exception>
        <exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
      </Docs>
    </Member>
    <Member MemberName="GetAsync">
      <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt; GetAsync (string enrollmentGroupId, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt; GetAsync(string enrollmentGroupId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroupsClient.GetAsync(System.String,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetAsync (enrollmentGroupId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of EnrollmentGroup)" />
      <MemberSignature Language="F#" Value="member this.GetAsync : string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt;" Usage="enrollmentGroupsClient.GetAsync (enrollmentGroupId, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="enrollmentGroupId" Type="System.String" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="enrollmentGroupId">The Id of the enrollmentGroup.</param>
        <param name="cancellationToken">The cancellation token.</param>
        <summary>
            Get an enrollment group by its Id.
            </summary>
        <returns>The retrieved enrollment group.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException">
            If the service was not able to retrieve the enrollment group information for the provided <paramref name="enrollmentGroupId" />.
            </exception>
        <exception cref="T:System.ArgumentNullException">If the provided <paramref name="enrollmentGroupId" /> is null.</exception>
        <exception cref="T:System.ArgumentException">If the provided <paramref name="enrollmentGroupId" /> is empty or white space.</exception>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.ProvisioningServiceException">
            If the service was not able to retrieve the enrollment group information for the provided <paramref name="enrollmentGroupId" />.
            </exception>
        <exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
      </Docs>
    </Member>
    <Member MemberName="GetAttestationAsync">
      <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.AttestationMechanism&gt; GetAttestationAsync (string enrollmentGroupId, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Devices.Provisioning.Service.AttestationMechanism&gt; GetAttestationAsync(string enrollmentGroupId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroupsClient.GetAttestationAsync(System.String,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetAttestationAsync (enrollmentGroupId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AttestationMechanism)" />
      <MemberSignature Language="F#" Value="member this.GetAttestationAsync : string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.AttestationMechanism&gt;" Usage="enrollmentGroupsClient.GetAttestationAsync (enrollmentGroupId, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.AttestationMechanism&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="enrollmentGroupId" Type="System.String" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="enrollmentGroupId">The Id of the enrollment group.</param>
        <param name="cancellationToken">The cancellation token.</param>
        <summary>
            Get an enrollment group's attestation information.
            </summary>
        <returns>The attestation mechanism of the enrollment group.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException">
            If the service was not able to retrieve the enrollment group attestation information for the provided <paramref name="enrollmentGroupId" />.
            </exception>
        <exception cref="T:System.ArgumentNullException">If the provided <paramref name="enrollmentGroupId" /> is null.</exception>
        <exception cref="T:System.ArgumentException">If the provided <paramref name="enrollmentGroupId" /> is empty or white space.</exception>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.ProvisioningServiceException">
            If the service was not able to retrieve the enrollment group attestation information for the provided <paramref name="enrollmentGroupId" />.
            </exception>
        <exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
      </Docs>
    </Member>
    <Member MemberName="RunBulkOperationAsync">
      <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationResult&gt; RunBulkOperationAsync (Microsoft.Azure.Devices.Provisioning.Service.BulkOperationMode bulkOperationMode, System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt; enrollmentGroups, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationResult&gt; RunBulkOperationAsync(valuetype Microsoft.Azure.Devices.Provisioning.Service.BulkOperationMode bulkOperationMode, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt; enrollmentGroups, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroupsClient.RunBulkOperationAsync(Microsoft.Azure.Devices.Provisioning.Service.BulkOperationMode,System.Collections.Generic.IEnumerable{Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup},System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Function RunBulkOperationAsync (bulkOperationMode As BulkOperationMode, enrollmentGroups As IEnumerable(Of EnrollmentGroup), Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkEnrollmentOperationResult)" />
      <MemberSignature Language="F#" Value="member this.RunBulkOperationAsync : Microsoft.Azure.Devices.Provisioning.Service.BulkOperationMode * seq&lt;Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt; * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationResult&gt;" Usage="enrollmentGroupsClient.RunBulkOperationAsync (bulkOperationMode, enrollmentGroups, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Devices.Provisioning.Service.BulkEnrollmentOperationResult&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="bulkOperationMode" Type="Microsoft.Azure.Devices.Provisioning.Service.BulkOperationMode" />
        <Parameter Name="enrollmentGroups" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup&gt;" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="bulkOperationMode">The <see cref="T:Microsoft.Azure.Devices.Provisioning.Service.BulkOperationMode" /> that defines the single operation to do over the enrollment group. It cannot be null. </param>
        <param name="enrollmentGroups">The collection of <see cref="T:Microsoft.Azure.Devices.Provisioning.Service.EnrollmentGroup" /> that contains the description of each enrollment group. It cannot be null or empty.</param>
        <param name="cancellationToken">The cancellation token.</param>
        <summary>
            Create, update or delete a set of enrollment groups.
            </summary>
        <returns>An object with the result of each operation.</returns>
        <remarks>
            This API provide the means to do a single operation over multiple enrollment groups. A valid operation
            is determined by <see cref="T:Microsoft.Azure.Devices.Provisioning.Service.BulkOperationMode" />, and can be 'create', 'update', 'updateIfMatchETag', or 'delete'.
            </remarks>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.DeviceProvisioningServiceException">
            If the client failed to send the request or service was not able to execute the bulk operation.
            </exception>
        <exception cref="T:System.ArgumentNullException">If the provided <paramref name="enrollmentGroups" /> is null.</exception>
        <exception cref="T:System.ArgumentException">If the provided <paramref name="enrollmentGroups" /> is an empty collection.</exception>
        <exception cref="T:Microsoft.Azure.Devices.Provisioning.Service.ProvisioningServiceException">
            If the client failed to send the request or service was not able to execute the bulk operation.
            </exception>
        <exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
      </Docs>
    </Member>
  </Members>
</Type>