ApiManagementUserCollection.CreateOrUpdate Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ApiManagementUserCollection.cs

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 Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiManagementUserResource> CreateOrUpdate (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 CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.ApiManagement.Models.ApiManagementUserCreateOrUpdateContent * Nullable<bool> * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.ApiManagement.Models.ApiManagementUserCreateOrUpdateContent * Nullable<bool> * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>

Public Overridable Function CreateOrUpdate (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 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

ArmOperation<ApiManagementUserResource>

Exceptions

ArgumentException

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

ArgumentNullException

userId or content is null.