你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
DocumentClient.CreateUserDefinedFunctionAsync 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
重载
CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions) |
在 Azure Cosmos DB 服务中将用户定义的函数创建为异步操作。 |
CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions) |
在 Azure Cosmos DB 服务中将用户定义的函数创建为异步操作。 |
CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)
在 Azure Cosmos DB 服务中将用户定义的函数创建为异步操作。
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> CreateUserDefinedFunctionAsync (string collectionLink, Microsoft.Azure.Documents.UserDefinedFunction function, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member CreateUserDefinedFunctionAsync : string * Microsoft.Azure.Documents.UserDefinedFunction * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
override this.CreateUserDefinedFunctionAsync : string * Microsoft.Azure.Documents.UserDefinedFunction * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
Public Function CreateUserDefinedFunctionAsync (collectionLink As String, function As UserDefinedFunction, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))
参数
- collectionLink
- String
要创建用户定义函数的 的链接 DocumentCollection 。 例如 dbs/db_rid/colls/col_rid/
- function
- UserDefinedFunction
要 UserDefinedFunction 创建的对象。
- options
- RequestOptions
(此请求的可选) Any RequestOptions。
返回
表示异步操作的服务响应的任务对象。
实现
例外
collectionLink
如果未设置 或 function
。
表示异步处理期间发生的故障的合并。 在 InnerExceptions 中查找实际异常 ()
此异常可以封装许多不同类型的错误。 若要确定特定错误,请始终查看 StatusCode 属性。 创建文档时可能会获取的一些常见代码包括:
StatusCode | 异常原因 |
---|---|
400 | BadRequest - 这意味着所提供的请求出现问题。 很可能没有为新的用户定义的函数提供 ID,或者 Body 格式不正确。 |
403 | 禁止 - 已达到提供的集合的用户定义函数配额。 请联系支持人员以增加此配额。 |
409 | 冲突 - 这表示 UserDefinedFunction ID 与所提供的 ID 匹配的 已存在。 |
413 | RequestEntityTooLarge - 这意味着尝试创建的 正文 UserDefinedFunction 太大。 |
示例
//Create a user defined function that converts a string to upper case
UserDefinedFunction udf = client.CreateUserDefinedFunctionAsync(collectionLink, new UserDefinedFunction
{
Id = "ToUpper",
Body = @"function toUpper(input) {
return input.toUpperCase();
}",
});
另请参阅
适用于
CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)
在 Azure Cosmos DB 服务中将用户定义的函数创建为异步操作。
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> CreateUserDefinedFunctionAsync (Uri documentCollectionUri, Microsoft.Azure.Documents.UserDefinedFunction function, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member CreateUserDefinedFunctionAsync : Uri * Microsoft.Azure.Documents.UserDefinedFunction * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
override this.CreateUserDefinedFunctionAsync : Uri * Microsoft.Azure.Documents.UserDefinedFunction * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
Public Function CreateUserDefinedFunctionAsync (documentCollectionUri As Uri, function As UserDefinedFunction, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))
参数
- documentCollectionUri
- Uri
要创建用户定义函数的文档集合的 URI。
- function
- UserDefinedFunction
Microsoft.Azure.Documents.UserDefinedFunction 对象。
- options
- RequestOptions
请求的请求选项。
返回
表示异步操作的服务响应的任务对象。