Partager via

Répertorier les fonctions définies par l’utilisateur

  • Article

L’exécution d’un GET sur la ressource UDF d’une base de données particulière, c’est-à-dire le chemin de l’URI udfs, retourne une liste des fonctions définies par l’utilisateur dans la collection.

Requête

Méthode URI de demande Description
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/udfs {databaseaccount} est le nom du compte Azure Cosmos DB créé dans le cadre de votre abonnement. La valeur {db-id} est le nom/l’ID généré par l’utilisateur de la base de données où résident les fonctions définies par l’utilisateur, et non l’ID généré par le système (rid) de la base de données. La valeur {coll-id} est le nom de la collection où résident les fonctions définies par l’utilisateur.

En-têtes

Consultez En-têtes de requête REST Azure Cosmos DB communs pour les en-têtes utilisés par toutes les requêtes Cosmos DB.

Corps

Aucun.

response

En-têtes

Consultez En-têtes de réponse REST Azure Cosmos DB communs pour les en-têtes retournés par toutes les réponses Cosmos DB.

Codes d’état

Le tableau suivant répertorie les codes d'état courants renvoyés par cette opération. Pour obtenir la liste complète des codes status, consultez Codes d’état HTTP.

Code d'état HTTP Description
200 Ok L'opération a réussi.

body

Propriété Description
_Débarrasser Il s’agit d’une propriété générée par le système. L’ID de ressource (_rid) est un identificateur unique qui est également hiérarchique en fonction de la pile de ressources sur le modèle de ressource. Il est utilisé en interne pour le placement de la ressource de fonction définie par l'utilisateur et la navigation vers celle-ci.
_Compter Nombre de fonctions définies par l’utilisateur retournées.
UserDefinedFunctions
id Nom unique identifiant la fonction définie par l'utilisateur.
body Il s’agit du corps de la fonction UDF.
_Débarrasser Il s’agit d’une propriété générée par le système. L’ID de ressource (_rid) est un identificateur unique qui est également hiérarchique en fonction de la pile de ressources sur le modèle de ressource. Il est utilisé en interne pour le placement de la ressource de fonction définie par l'utilisateur et la navigation vers celle-ci.
_Ts Il s’agit d’une propriété générée par le système. Elle spécifie l'horodateur de la dernière mise à jour de la ressource. La valeur est un horodateur.
_self Il s’agit d’une propriété générée par le système. Il s'agit de l'URI adressable unique pour la ressource.
_Etag Il s’agit d’une propriété générée par le système qui spécifie l’etag de ressource requis pour le contrôle d’accès concurrentiel optimiste. 
{  
    "_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  
}

Exemple

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  
}

Voir aussi