CosmosDBSqlClientEncryptionKeyCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBSqlClientEncryptionKeyCollection.cs

Tries to get details for this resource from the service.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}
• Operation Id: SqlResources_GetClientEncryptionKey
• Default Api Version: 2024-09-01-preview
• Resource: CosmosDBSqlClientEncryptionKeyResource

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

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

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

Parameters

clientEncryptionKeyName

String

Cosmos DB ClientEncryptionKey name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<CosmosDBSqlClientEncryptionKeyResource>>

Exceptions

ArgumentException

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

ArgumentNullException

clientEncryptionKeyName is null.