Azure Cosmos DB is a globally distributed multi-model database service designed to enable you to elastically and independently scale throughput and storage across any number of geographical regions with a comprehensive SLA.
Status: Production |
Tier: Premium |
Version: 1.0.0 |
Name |
Summary |
Query documents V2 |
|
Query documents V3 |
|
Query documents V4 |
|
Get all documents V2 |
|
Test connection |
|
Get all databases |
|
Get a database |
|
Get all collections |
|
Get a collection |
|
Get all documents |
|
Create or update document |
|
Create or update document (V2) |
|
Query documents |
|
Get a document |
|
Replace a document |
|
Delete a document |
|
Get stored procedures |
|
Create stored procedure |
|
Replace stored procedure |
|
Execute stored procedure |
|
Delete stored procedure |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Query documents V2
Description: Query documents V2.
Syntax:
AzureCosmosDB.QueryDocumentsV2 (string databaseId, string collectionId, DocumentsQuery query, [advanced][Optional]string partitionKey, [advanced][Optional]string continuationToken)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
query |
|
Documents query parameters |
True |
|
partitionKey |
string (Partition key value) |
Partition key value. |
False |
|
continuationToken |
string (Continuation Token) |
A token to fetch additional results from the operation. |
False |
Returns:
Description: Array of documents that match the requested query and the related metadata.
Summary: Query documents V3
Description: Query documents V3.
Syntax:
AzureCosmosDB.QueryDocumentsV3 (string databaseId, string collectionId, string queryText, [Optional]string partitionKey, [advanced][Optional]integer maxItemCount, [advanced][Optional]string continuationToken, [advanced][Optional]boolean enableCrossPartition, [advanced][Optional]string consistencyLevel, [advanced][Optional]string sessionToken)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
queryText |
string (SQL Syntax Query) |
SQL query. |
True |
|
partitionKey |
string (Partition key value) |
If empty, all partitions will be used to search for documents. |
False |
|
maxItemCount |
integer(int32) (Max Item Count) |
An integer indicating the maximum number of items to be returned per page. |
False |
|
continuationToken |
string (Continuation Token) |
A token to fetch additional results. |
False |
|
enableCrossPartition |
boolean (Enable Cross Partition) |
Indicates whether user are enabled to send more than one request to execute the query. |
False |
|
consistencyLevel |
string (Consistency Level)Values: [Strong, BoundedStaleness, Session, Eventual, ConsistentPrefix] |
Consistency level required for the feed (query/read feed) operation. |
False |
|
sessionToken |
string (Session Token) |
The session token for use with session consistency. |
False |
Returns:
Type:DocumentsCollection
Description: Array of documents that match the requested query and the related metadata.
Summary: Query documents V4
Description: Query documents V4.
Syntax:
AzureCosmosDB.QueryDocumentsV4 (string databaseId, string containerId, [Optional]string queryText, [Optional]string partitionKey, [advanced][Optional]integer maxItemCount, [advanced][Optional]string continuationToken, [advanced][Optional]string consistencyLevel, [advanced][Optional]string sessionToken)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
|
containerId |
string (Container ID) |
The name of the container. |
True |
|
queryText |
string (SQL Syntax Query) |
SQL query. If empty, will return all documents. |
False |
|
partitionKey |
string (Partition key value) |
If empty, all partitions will be used to search for documents. |
False |
|
maxItemCount |
integer(int32) (Max Item Count) |
An integer indicating the maximum number of items to be returned per page. |
False |
|
continuationToken |
string (Continuation Token) |
A token to fetch additional results. |
False |
|
consistencyLevel |
string (Consistency Level)Values: [Strong, BoundedStaleness, Session, Eventual, ConsistentPrefix] |
Consistency level required for the feed (query/read feed) operation. |
False |
|
sessionToken |
string (Session Token) |
The session token for use with session consistency. |
False |
Returns:
Type:DocumentsCollection
Description: Array of documents that match the requested query and the related metadata.
Summary: Get all documents V2
Description: Get all documents V2.
Syntax:
AzureCosmosDB.GetDocumentsV2 (string databaseId, string collectionId, [Optional]string partitionKey, [advanced][Optional]integer maxItemCount, [advanced][Optional]string continuationToken, [advanced][Optional]string consistencyLevel, [advanced][Optional]string sessionToken)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
partitionKey |
string (Partition key value) |
If empty, all partitions will be used to search for documents. |
False |
|
maxItemCount |
integer(int32) (Max Item Count) |
An integer indicating the maximum number of items to be returned per page. |
False |
|
continuationToken |
string (Continuation Token) |
A token to fetch additional results. |
False |
|
consistencyLevel |
string (Consistency Level)Values: [Strong, BoundedStaleness, Session, Eventual, ConsistentPrefix] |
Consistency level required for the feed (query/read feed) operation. |
False |
|
sessionToken |
string (Session Token) |
The session token for use with session consistency. |
False |
Returns:
Type:DocumentsCollection
Description: Array of documents that match the requested query and the related metadata.
Summary: Test connection
Description: Tests connection of the resource.
Syntax:
AzureCosmosDB.TestConnection ()
Returns:
Type:getAccountResponse
Summary: Get all databases
Description: Get all databases.
Syntax:
AzureCosmosDB.GetDatabases ()
Returns:
Type:getDatabasesResponse
Summary: Get a database
Description: Get a database.
Syntax:
AzureCosmosDB.GetDatabase (string databaseId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
Returns:
Type:getDatabaseResponse
Summary: Get all collections
Description: Get all collections.
Syntax:
AzureCosmosDB.GetCollections (string databaseId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
Returns:
Summary: Get a collection
Description: Get a collection.
Syntax:
AzureCosmosDB.GetCollection (string databaseId, string collectionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
Returns:
Type:array of (GetCollectionResponseItem)
Summary: Get all documents
Description: Get all documents.
Syntax:
AzureCosmosDB.GetDocuments ([Optional]string x-ms-documentdb-raw-partitionkey, [internal][Optional]string x-ms-documentdb-partitionkey, [advanced][Optional]number x-ms-max-item-count, [advanced][Optional]string x-ms-continuation, [advanced][Optional]string x-ms-consistency-level, [advanced][Optional]string x-ms-session-token, [advanced][Optional]string x-ms-activity-id, string databaseId, string collectionId, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
x-ms-documentdb-raw-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-documentdb-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-max-item-count |
number (Max Item Count) |
An integer indicating the maximum number of items to be returned per page. |
False |
|
x-ms-continuation |
string (Continuation Token) |
A string token returned for queries and read-feed operations if there are more results to be read. |
False |
|
x-ms-consistency-level |
string (Consistency Level)Values: [Strong, Bounded, Session, Eventual] |
This is the consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). |
False |
|
x-ms-session-token |
string (Session Token) |
A string token used with session level consistency. |
False |
|
x-ms-activity-id |
string (Activity id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
|
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Type:getDocumentsResponse
Summary: Create or update document
Description: Create or update document. When creating a document in DocumentDB, the body must include an id property.
Syntax:
AzureCosmosDB.CreateDocument ([Optional]string x-ms-documentdb-raw-partitionkey, [internal][Optional]string x-ms-documentdb-partitionkey, [advanced][Optional]number x-ms-max-item-count, [advanced][Optional]string x-ms-continuation, [advanced][Optional]string x-ms-consistency-level, [advanced][Optional]string x-ms-session-token, [advanced][Optional]string x-ms-activity-id, [Optional]boolean x-ms-documentdb-is-upsert, [advanced][Optional]string x-ms-documentdb-pre-trigger-include, [advanced][Optional]string x-ms-documentdb-post-trigger-include, string databaseId, string collectionId, postDocumentsRequest body, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
x-ms-documentdb-raw-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-documentdb-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-max-item-count |
number (Max Item Count) |
An integer indicating the maximum number of items to be returned per page. |
False |
|
x-ms-continuation |
string (Continuation Token) |
A string token returned for queries and read-feed operations if there are more results to be read. |
False |
|
x-ms-consistency-level |
string (Consistency Level)Values: [Strong, Bounded, Session, Eventual] |
This is the consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). |
False |
|
x-ms-session-token |
string (Session Token) |
A string token used with session level consistency. |
False |
|
x-ms-activity-id |
string (Activity id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
|
x-ms-documentdb-is-upsert |
boolean (IsUpsert) |
If set to true, the document will be replaced if it exists else created. |
False |
|
x-ms-documentdb-pre-trigger-include |
string (Pre-Trigger) |
Comma-separated list of trigger names to run before the document operation is executed. |
False |
|
x-ms-documentdb-post-trigger-include |
string (Post-Trigger) |
Comma-separated list of trigger names to run after the document operation is executed. |
False |
|
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
body |
|
|
True |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Summary: Create or update document (V2)
Description: Create or update document. When creating a document in DocumentDB, the body must include an id property.
Syntax:
AzureCosmosDB.CreateDocumentV2 ([advanced][Optional]number x-ms-max-item-count, [advanced][Optional]string x-ms-continuation, [advanced][Optional]string x-ms-consistency-level, [advanced][Optional]string x-ms-session-token, [advanced][Optional]string x-ms-activity-id, [Optional]boolean x-ms-documentdb-is-upsert, [advanced][Optional]string x-ms-documentdb-pre-trigger-include, [advanced][Optional]string x-ms-documentdb-post-trigger-include, string databaseId, string collectionId, postDocumentsRequest body, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
x-ms-max-item-count |
number (Max Item Count) |
An integer indicating the maximum number of items to be returned per page. |
False |
|
x-ms-continuation |
string (Continuation Token) |
A string token returned for queries and read-feed operations if there are more results to be read. |
False |
|
x-ms-consistency-level |
string (Consistency Level)Values: [Strong, Bounded, Session, Eventual] |
This is the consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). |
False |
|
x-ms-session-token |
string (Session Token) |
A string token used with session level consistency. |
False |
|
x-ms-activity-id |
string (Activity id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
|
x-ms-documentdb-is-upsert |
boolean (IsUpsert) |
If set to true, the document will be replaced if it exists else created. |
False |
|
x-ms-documentdb-pre-trigger-include |
string (Pre-Trigger) |
Comma-separated list of trigger names to run before the document operation is executed. |
False |
|
x-ms-documentdb-post-trigger-include |
string (Post-Trigger) |
Comma-separated list of trigger names to run after the document operation is executed. |
False |
|
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
body |
|
|
True |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Summary: Query documents
Description: Query documents.
Syntax:
AzureCosmosDB.QueryDocuments ([Optional]string x-ms-documentdb-raw-partitionkey, [internal][Optional]string x-ms-documentdb-partitionkey, [advanced][Optional]number x-ms-max-item-count, [advanced][Optional]string x-ms-continuation, [advanced][Optional]boolean x-ms-documentdb-query-enablecrosspartition, [advanced][Optional]string x-ms-consistency-level, [advanced][Optional]string x-ms-session-token, [advanced][Optional]string x-ms-activity-id, string databaseId, string collectionId, queryRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
x-ms-documentdb-raw-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-documentdb-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-max-item-count |
number (Max Item Count) |
An integer indicating the maximum number of items to be returned per page. |
False |
|
x-ms-continuation |
string (Continuation Token) |
A string token returned for queries and read-feed operations if there are more results to be read. |
False |
|
x-ms-documentdb-query-enablecrosspartition |
boolean (Enable Cross Partition) |
If the collection is partitioned, this must be set to True to allow execution across multiple partitions. |
False |
|
x-ms-consistency-level |
string (Consistency Level)Values: [Strong, Bounded, Session, Eventual] |
This is the consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). |
False |
|
x-ms-session-token |
string (Session Token) |
A string token used with session level consistency. |
False |
|
x-ms-activity-id |
string (Activity id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
|
databaseId |
string (Database ID) |
The name of the database |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
body |
|
|
True |
Returns:
Type:queryResponse
Summary: Get a document
Description: Get a document.
Syntax:
AzureCosmosDB.GetDocument ([Optional]string x-ms-documentdb-raw-partitionkey, [internal][Optional]string x-ms-documentdb-partitionkey, [advanced][Optional]number x-ms-max-item-count, [advanced][Optional]string x-ms-continuation, [advanced][Optional]string x-ms-consistency-level, [advanced][Optional]string x-ms-session-token, [advanced][Optional]string x-ms-activity-id, string databaseId, string collectionId, string documentId, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
x-ms-documentdb-raw-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-documentdb-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-max-item-count |
number (Max Item Count) |
An integer indicating the maximum number of items to be returned per page. |
False |
|
x-ms-continuation |
string (Continuation Token) |
A string token returned for queries and read-feed operations if there are more results to be read. |
False |
|
x-ms-consistency-level |
string (Consistency Level)Values: [Strong, Bounded, Session, Eventual] |
This is the consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). |
False |
|
x-ms-session-token |
string (Session Token) |
A string token used with session level consistency. |
False |
|
x-ms-activity-id |
string (Activity id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
|
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
documentId |
string (Document ID) |
The identifier for the document. |
True |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Type:getDocumentResponse
Summary: Replace a document
Description: Replace a document.
Syntax:
AzureCosmosDB.ReplaceDocument ([Optional]string x-ms-documentdb-raw-partitionkey, [internal][Optional]string x-ms-documentdb-partitionkey, [advanced][Optional]number x-ms-max-item-count, [advanced][Optional]string x-ms-continuation, [advanced][Optional]string x-ms-consistency-level, [advanced][Optional]string x-ms-session-token, [advanced][Optional]string x-ms-activity-id, [advanced][Optional]string x-ms-documentdb-pre-trigger-include, [advanced][Optional]string x-ms-documentdb-post-trigger-include, string databaseId, string collectionId, string documentId, putDocumentRequest body, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
x-ms-documentdb-raw-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-documentdb-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-max-item-count |
number (Max Item Count) |
An integer indicating the maximum number of items to be returned per page. |
False |
|
x-ms-continuation |
string (Continuation Token) |
A string token returned for queries and read-feed operations if there are more results to be read. |
False |
|
x-ms-consistency-level |
string (Consistency Level)Values: [Strong, Bounded, Session, Eventual] |
This is the consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). |
False |
|
x-ms-session-token |
string (Session Token) |
A string token used with session level consistency. |
False |
|
x-ms-activity-id |
string (Activity id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
|
x-ms-documentdb-pre-trigger-include |
string (Pre-Trigger) |
Comma-separated list of trigger names to run before replacing the document. |
False |
|
x-ms-documentdb-post-trigger-include |
string (Post-Trigger) |
Comma-separated list of trigger names to run after replacing the document. |
False |
|
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
documentId |
string (Document ID) |
The identifier of the document. |
True |
|
body |
|
|
True |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Type:putDocumentResponse
Summary: Delete a document
Description: Delete a document.
Syntax:
AzureCosmosDB.DeleteDocument ([Optional]string x-ms-documentdb-raw-partitionkey, [internal][Optional]string x-ms-documentdb-partitionkey, [advanced][Optional]number x-ms-max-item-count, [advanced][Optional]string x-ms-continuation, [advanced][Optional]string x-ms-consistency-level, [advanced][Optional]string x-ms-session-token, [advanced][Optional]string x-ms-activity-id, [advanced][Optional]string x-ms-documentdb-pre-trigger-include, [advanced][Optional]string x-ms-documentdb-post-trigger-include, string databaseId, string collectionId, string documentId, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
x-ms-documentdb-raw-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-documentdb-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-max-item-count |
number (Max Item Count) |
An integer indicating the maximum number of items to be returned per page. |
False |
|
x-ms-continuation |
string (Continuation Token) |
A string token returned for queries and read-feed operations if there are more results to be read. |
False |
|
x-ms-consistency-level |
string (Consistency Level)Values: [Strong, Bounded, Session, Eventual] |
This is the consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). |
False |
|
x-ms-session-token |
string (Session Token) |
A string token used with session level consistency. |
False |
|
x-ms-activity-id |
string (Activity id) |
A client supplied identifier for the operation, which will be echoed in the server response. |
False |
|
x-ms-documentdb-pre-trigger-include |
string (Pre-Trigger) |
Comma-separated list of trigger names to run before the document is deleted. |
False |
|
x-ms-documentdb-post-trigger-include |
string (Post-Trigger) |
Comma-separated list of trigger names to run after the document id deleted. |
False |
|
databaseId |
string (Database ID) |
The name of the document. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
documentId |
string (Document ID) |
The identifier of the document. |
True |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Summary: Get stored procedures
Description: Get stored procedures in the specified collection.
Syntax:
AzureCosmosDB.GetStoredProcedures (string databaseId, string collectionId, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Type:getStoredProceduresResponse
Summary: Create stored procedure
Description: Create stored procedure.
Syntax:
AzureCosmosDB.CreateStoredProcedure (string databaseId, string collectionId, CreateStoredProcedureParameterBody body, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
body |
CreateStoredProcedureParameterBody
|
|
True |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Type:createStoredProcedureResponse
Summary: Replace stored procedure
Description: Replace stored procedure.
Syntax:
AzureCosmosDB.ReplaceStoredProcedure (string databaseId, string collectionId, string sprocId, ReplaceStoredProcedureParameterBody body, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
sprocId |
string (Sproc ID) |
The name of the stored procedure. |
True |
|
body |
ReplaceStoredProcedureParameterBody
|
|
True |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Type:createStoredProcedureResponse
Summary: Execute stored procedure
Description: Execute stored procedure in specified collection.
Syntax:
AzureCosmosDB.ExecuteStoredProcedure (string databaseId, string collectionId, [Optional]string x-ms-documentdb-raw-partitionkey, [internal][Optional]string x-ms-documentdb-partitionkey, string sprocId, [Optional]string parameters, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
x-ms-documentdb-raw-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
x-ms-documentdb-partitionkey |
string (Partition key value) |
The partition key value for the requested document or attachment operation. |
False |
|
sprocId |
string (Sproc ID) |
The name of the stored procedure. |
True |
|
parameters |
string
|
|
False |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Type:ObjectWithoutType
Summary: Delete stored procedure
Description: Delete stored procedure.
Syntax:
AzureCosmosDB.DeleteStoredProcedure (string databaseId, string collectionId, string sprocId, [advanced][Optional]string x-ms-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
databaseId |
string (Database ID) |
The name of the database. |
True |
|
collectionId |
string (Collection ID) |
The name of the collection. |
True |
|
sprocId |
string (Sproc ID) |
The name of the stored procedure. |
True |
|
x-ms-version |
string (API version)Values: [2017-05-03, 2018-12-31] |
API version. |
False |
Returns:
Type:string
Summary:
Description:
Properties:
Name |
Type |
Summary |
body |
string Function definition |
Function that defines the stored procedure, e.g. 'function(params){ ... }' |
id |
string id |
New id of the stored procedure. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
_etag |
string _etag |
_etag |
_rid |
string _rid |
_rid |
_self |
string _self |
_self |
_ts |
integer(int32) _ts |
_ts |
body |
string body |
body |
id |
string id |
id |
Summary:
Description: Array of documents that match the requested query and the related metadata.
Properties:
Name |
Type |
Summary |
value |
array of (ObjectWithoutType) Documents |
|
ContinuationToken |
string Continuation Token |
|
Count |
integer(int32) Number of Documents |
|
RequestCharge |
number(double) Request Charge |
|
SessionToken |
string Session Token |
|
ActivityId |
string Activity Id |
|
Summary:
Description: Documents query parameters
Properties:
Name |
Type |
Summary |
QueryText |
string
|
SQL Syntax Query over documents |
Summary:
Description:
Properties:
Name |
Type |
Summary |
_self |
string
|
|
_rid |
string
|
|
id |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
indexingPolicy |
|
|
_rid |
string
|
|
_ts |
integer(int32)
|
|
_self |
string
|
|
_etag |
string
|
|
_docs |
string
|
|
_sprocs |
string
|
|
_triggers |
string
|
|
_udfs |
string
|
|
_conflicts |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
indexingMode |
string
|
|
automatic |
string
|
|
includedPaths |
array of (IncludedPathsItem)
|
|
excludedPaths |
array of (string)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
path |
string
|
|
indexes |
array of (IndexesItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
kind |
string
|
|
dataType |
string
|
|
precision |
integer(int32)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
_rid |
string
|
|
DocumentCollections |
array of (DocumentCollectionsItem)
|
|
_count |
integer(int32)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
indexingPolicy |
|
|
_rid |
string
|
|
_ts |
integer(int32)
|
|
_self |
string
|
|
_etag |
string
|
|
_docs |
string
|
|
_sprocs |
string
|
|
_triggers |
string
|
|
_udfs |
string
|
|
_conflicts |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
indexingMode |
string
|
|
automatic |
string
|
|
includedPaths |
array of (IncludedPathsItem)
|
|
excludedPaths |
array of (string)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
path |
string
|
|
indexes |
array of (IndexesItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
kind |
string
|
|
dataType |
string
|
|
precision |
integer(int32)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
_rid |
string
|
|
_self |
string
|
|
_etag |
string
|
|
_colls |
string
|
|
_users |
string
|
|
_ts |
integer(int32)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
_rid |
string
|
|
Databases |
array of (DatabasesItem)
|
|
_count |
integer(int32)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
_rid |
string
|
|
_self |
string
|
|
_etag |
string
|
|
_colls |
string
|
|
_users |
string
|
|
_ts |
integer(int32)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
_rid |
string
|
|
Documents |
array of (DocumentsItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
_count |
integer(int32) _count |
_count |
_rid |
string _rid |
_rid |
StoredProcedures |
array of (StoredProceduresItem) StoredProcedures |
StoredProcedures |
Summary:
Description:
Properties:
Name |
Type |
Summary |
_etag |
string _etag |
_etag |
_rid |
string _rid |
_rid |
_self |
string _self |
_self |
_ts |
integer(int32) _ts |
_ts |
body |
string body |
body |
id |
string id |
id |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
_rid |
string
|
|
_ts |
integer(int32)
|
|
_self |
string
|
|
_etag |
string
|
|
_attachments |
string
|
|
id |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
_rid |
string
|
|
id |
string
|
|
Summary:
Description: Array of documents that match the requested query and the related metadata.
Properties:
Name |
Type |
Summary |
Documents |
array of (ObjectWithoutType) Documents |
Array of documents that match the request. |
_count |
integer(int32) Number of Documents |
Number of documents. |
ActivityId |
string Activity ID |
Azure Cosmos DB service activity ID. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
query |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
_rid |
string
|
|
_count |
number
|
|
Documents |
array of (DocumentsItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
body |
string Function definition |
Function that defines the stored procedure, e.g. 'function(params){ ... }' |
id |
string id |
Id of the existing stored procedure. |