MongoDBUserDefinitionCollection.GetIfExistsAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.12

Source:: MongoDBUserDefinitionCollection.cs

Source:: MongoDBUserDefinitionCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Tries to get details for this resource from the service.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}
Operation Id: MongoDBResources_GetMongoUserDefinition
Default Api Version: 2024-12-01-preview
Resource: MongoDBUserDefinitionResource

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>> GetIfExistsAsync (string mongoUserDefinitionId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBUserDefinitionResource>>

Public Overridable Function GetIfExistsAsync (mongoUserDefinitionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of MongoDBUserDefinitionResource))

Parameters

mongoUserDefinitionId: String

The ID for the User Definition {dbName.userName}.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<MongoDBUserDefinitionResource>>

Exceptions

ArgumentException

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

ArgumentNullException

mongoUserDefinitionId is null.

Applies to

Partilhar via