ApiManagementUserCollection.CreateOrUpdateAsync Method

Definition

Creates or Updates a user.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}
  • Operation Id: User_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementUserResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string userId, Azure.ResourceManager.ApiManagement.Models.ApiManagementUserCreateOrUpdateContent content, bool? notify = default, Azure.ETag? ifMatch = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.ApiManagement.Models.ApiManagementUserCreateOrUpdateContent * Nullable<bool> * Nullable<Azure.ETag> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.ApiManagement.Models.ApiManagementUserCreateOrUpdateContent * Nullable<bool> * Nullable<Azure.ETag> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>>
Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, userId As String, content As ApiManagementUserCreateOrUpdateContent, Optional notify As Nullable(Of Boolean) = Nothing, Optional ifMatch As Nullable(Of ETag) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of ApiManagementUserResource))

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

userId
String

User identifier. Must be unique in the current API Management service instance.

content
ApiManagementUserCreateOrUpdateContent

Create or update parameters.

notify
Nullable<Boolean>

Send an Email notification to the User.

ifMatch
Nullable<ETag>

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

userId is an empty string, and was expected to be non-empty.

userId or content is null.

Applies to