ApiManagementUserCollection.GetIfExistsAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApiManagement
Assembly:
Azure.ResourceManager.ApiManagement.dll
Package:
Azure.ResourceManager.ApiManagement v1.2.0
Package:
Azure.ResourceManager.ApiManagement v1.3.0-beta.1
Source:
ApiManagementUserCollection.cs
Source:
ApiManagementUserCollection.cs

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}
  • Operation Id: User_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementUserResource
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>> GetIfExistsAsync (string userId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>>
Public Overridable Function GetIfExistsAsync (userId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of ApiManagementUserResource))

Parameters

userId
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<ApiManagementUserResource>>

Exceptions

ArgumentException

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

ArgumentNullException

userId is null.

Applies to