CosmosDBSqlContainerResource.GetCosmosDBSqlUserDefinedFunctionAsync Method

Definition

Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}
  • Operation Id: SqlResources_GetSqlUserDefinedFunction
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBSqlUserDefinedFunctionResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlUserDefinedFunctionResource>> GetCosmosDBSqlUserDefinedFunctionAsync (string userDefinedFunctionName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetCosmosDBSqlUserDefinedFunctionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlUserDefinedFunctionResource>>
override this.GetCosmosDBSqlUserDefinedFunctionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBSqlUserDefinedFunctionResource>>
Public Overridable Function GetCosmosDBSqlUserDefinedFunctionAsync (userDefinedFunctionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBSqlUserDefinedFunctionResource))

Parameters

userDefinedFunctionName
String

Cosmos DB userDefinedFunction name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

userDefinedFunctionName is null.

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

Applies to