列出使用者定義函式

在特定資料庫的 UDF 資源上執行 GET,也就是 udfs URI 路徑,會傳回集合中 UDF 的清單。

要求

方法 要求 URI 描述
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/udfs {databaseaccount} 是您訂用帳戶下建立的 Azure Cosmos DB 帳戶名稱。 {db-id} 值是使用者產生 UDF 所在資料庫的名稱/識別碼,而不是系統產生的識別碼 (在資料庫的 rid) 。 {coll-id} 值是 UDF 所在的集合名稱。

標題

如需所有 Cosmos DB 要求所使用的標頭,請參閱常見的 Azure Cosmos DB REST 要求標頭 。

主體

無。

回應

標題

如需所有 Cosmos DB 回應所傳回的標頭,請參閱 常見的 Azure Cosmos DB REST 回應標頭 。

狀態碼

下表列出此作業所傳回的常見狀態碼。 如需狀態碼的完整清單,請參閱 HTTP 狀態碼。

HTTP 狀態碼 Description
200 確定 作業成功。

主體

屬性 Description
_擺脫 它是系統產生的屬性。 資源識別碼 (_rid) 是資源模型上每個資源堆疊的階層式唯一識別碼。 供內部進行放置和導覽 UDF 資源時使用。
_計數 傳回的 UDF 數目。
UserDefinedFunctions
id 這是用來識別 UDF 的唯一名稱。
body 它是 UDF 的主體。
_擺脫 它是系統產生的屬性。 資源識別碼 (_rid) 是資源模型上每個資源堆疊的階層式唯一識別碼。 供內部進行放置和導覽 UDF 資源時使用。
_Ts 它是系統產生的屬性。 代表資源的上次更新時間戳記。 值為時間戳記。
_自我 它是系統產生的屬性。 代表資源的唯一可定址 URI。
_Etag 它是系統產生的屬性,指定開放式並行控制所需的資源 etag。
{  
    "_rid": "Sl8fALN4sw4=",  
    "UserDefinedFunctions": [{  
        "body": "function tax(income) {\r\n    if(income == undefined) \r\n        throw 'no input';\r\n    if (income < 1000) \r\n        return income * 0.1;\r\n    else if (income < 10000) \r\n        return income * 0.2;\r\n    else\r\n        return income * 0.4;\r\n}",  
        "id": "simpleTaxUDF",  
        "_rid": "Sl8fALN4sw4BAAAAAAAAYA==",  
        "_ts": 1449688293,  
        "_self": "dbs\/Sl8fAA==\/colls\/Sl8fALN4sw4=\/udfs\/Sl8fALN4sw4BAAAAAAAAYA==\/",  
        "_etag": "\"060072e4-0000-0000-0000-56687ce50000\""  
    }],  
    "_count": 1  
}  
  

範例

GET https://contosomarketing.documents.azure.com/dbs/volcanodb/colls/volcano1/udfs HTTP/1.1  
x-ms-session-token: 39  
x-ms-date: Wed, 09 Dec 2015 19:15:47 GMT  
authorization: type%3dmaster%26ver%3d1.0%26sig%3dFwVMfm53ehSj5bK4rVu1PUvwRljDiBqD3PLfv1rkymk%3d  
Cache-Control: no-cache  
User-Agent: contoso/1.0  
x-ms-version: 2015-08-06  
Accept: application/json  
Host: contosomarketing.documents.azure.com  
Cookie: x-ms-session-token=39  
Connection: Keep-Alive  
  
HTTP/1.1 200 Ok  
Cache-Control: no-store, no-cache  
Pragma: no-cache  
Content-Type: application/json  
Content-Location: https://contosomarketing.documents.azure.com/dbs/volcanodb/colls/volcano1/udfs  
Server: Microsoft-HTTPAPI/2.0  
Strict-Transport-Security: max-age=31536000  
x-ms-last-state-change-utc: Thu, 26 Nov 2015 05:55:14.602 GMT  
x-ms-resource-quota: functions=25;  
x-ms-resource-usage: functions=1;  
x-ms-item-count: 1  
x-ms-schemaversion: 1.1  
x-ms-alt-content-path: dbs/volcanodb/colls/volcano1  
x-ms-content-path: Sl8fALN4sw4=  
x-ms-session-token: 39  
x-ms-request-charge: 1  
x-ms-serviceversion: version=1.5.57.3  
x-ms-activity-id: 06e8f9c5-00a2-4bb2-8b09-b00b47ddf914  
Set-Cookie: x-ms-session-token=39; Domain=contosomarketing.documents.azure.com; Path=/dbs/volcanodb/colls/volcano1  
x-ms-gatewayversion: version=1.5.57.3  
Date: Wed, 09 Dec 2015 19:15:48 GMT  
Content-Length: 528  
  
{  
    "_rid": "Sl8fALN4sw4=",  
    "UserDefinedFunctions": [{  
        "body": "function tax(income) {\r\n    if(income == undefined) \r\n        throw 'no input';\r\n    if (income < 1000) \r\n        return income * 0.1;\r\n    else if (income < 10000) \r\n        return income * 0.2;\r\n    else\r\n        return income * 0.4;\r\n}",  
        "id": "simpleTaxUDF",  
        "_rid": "Sl8fALN4sw4BAAAAAAAAYA==",  
        "_ts": 1449688293,  
        "_self": "dbs\/Sl8fAA==\/colls\/Sl8fALN4sw4=\/udfs\/Sl8fALN4sw4BAAAAAAAAYA==\/",  
        "_etag": "\"060072e4-0000-0000-0000-56687ce50000\""  
    }],  
    "_count": 1  
}  
  

另請參閱