Azure Cosmos DB (la base de datos de Azure Cosmos)
Azure Cosmos DB es un servicio de base de datos multimodelo distribuido globalmente diseñado para permitirle escalar de forma elástica e independiente el rendimiento y el almacenamiento en cualquier número de regiones geográficas con un Acuerdo de Nivel de Servicio completo.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps |
| Power Apps | - | No disponible |
| Power Automate | Premium | Todas las regiones de Power Automate |
| Metadatos del conector | |
|---|---|
| Publicador | Microsoft |
Para usar esta integración, necesitará una cuenta de SQL API de Cosmos DB configurada en Azure Portal. Tenga en cuenta que actualmente no se admiten cuentas de API de Mongo DB.
Una vez creada la cuenta de SQL API, proporcione el identificador de cuenta (sin "documents.azure.com") al crear una conexión con el conector de Azure Cosmos DB si crea una conexión de Access Key tipo. Este identificador de cuenta también es necesario para las versiones de operación más recientes que admiten la autenticación de Id. de Microsoft Entra.
Autenticación de Microsoft Entra ID y conector de Cosmos DB
Para usar la autenticación de Id. de Entra de Microsoft, la cuenta que se usa debe asignarse a una asignación de roles específica, para obtener más información, visite Configuración del control de acceso basado en roles con el identificador de Entra de Microsoft para su cuenta de Azure Cosmos DB.
Nota:
Solo los roles definidos explícitamente para el acceso a datos permiten que una entidad de seguridad acceda a los datos de Cosmos DB. Los roles integrados, como Owner, o Contributorno proporcionan acceso a los datos de Cosmos DB dentro de esa cuenta a través de Microsoft Entra ID. Azure Cosmos DB expone 2 roles integrados:
-
Cosmos DB Built-in Data Reader(id. de definición de00000000-0000-0000-0000-000000000001rol ) -
Cosmos DB Built-in Data Contributor(id. de definición de00000000-0000-0000-0000-000000000002rol )
Se pueden asignar roles de varias maneras y se pueden crear roles personalizados para un acceso más pormenorizado.
Este es un ejemplo sobre quién asignar Cosmos DB Built-in Data Reader a través de PowerShell (más información sobre este comando New-AzCosmosDBSqlRoleAssignment):
$resourceGroupName = "<myResourceGroup>"
$accountName = "<myCosmosAccount>"
$principalId = "<myPrincipalId>"
$roleDefinitionId = "/subscriptions/<<mySubscription>>/resourceGroups/<<myResourceGroup>>/providers/Microsoft.DocumentDB/databaseAccounts/<<myCosmosAccount>>/sqlRoleDefinitions/00000000-0000-0000-0000-000000000001"
New-AzCosmosDBSqlRoleAssignment -AccountName $accountName `
-ResourceGroupName $resourceGroupName `
-RoleDefinitionId $roleDefinitionId `
-PrincipalId $principalId `
-AssignableScope "/"
Si no se agregan estas asignaciones de roles, terminarán con solicitudes no autorizadas como esta: Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.
Nota:
Azure Cosmos DB no admite ningún tipo de operaciones de administración con la autenticación de Id. de Entra de Microsoft (documentada aquí). Las siguientes operaciones solo funcionarán con Access Key conexiones:
- Creación de un procedimiento almacenado (versiones V1 y V2)
- Eliminar procedimiento almacenado (versiones V1 y V2)
- Actualización del procedimiento almacenado (versiones V1 y V2)
Operaciones no compatibles con la autenticación de Id. de Microsoft Entra
Al usar la autenticación de Id. de Microsoft Entra solo se admiten acciones con el nombre de cuenta de Cosmos DB como parámetro. Las acciones en desuso seguirán funcionando con Access Key la autenticación, pero se producirá un error si se usa con una conexión de Id. de Entra de Microsoft.
Problemas conocidos y limitaciones
El tamaño máximo de un documento compatible con el conector de DocumentDB (Azure Cosmos DB) es de 2 MB.
Las limitaciones de Azure Cosmos DB se documentan aquí.
El conector no admite la elección de una región de escritura y regiones de varias escrituras.
El "valor de clave de partición" debe proporcionarse según su tipo. Por ejemplo, un valor de cadena debe incluirse entre comillas, se debe proporcionar un número tal cual. Por ejemplo: "valor de cadena",123, 0,5.
El "valor de clave de partición" es necesario para las consultas con
ORDER BY,DISTINCT, etc., que se ejecutan en colecciones con particiones.Consultar documentos V2 [EN DESUSO], Consultar documentos V3, Obtener todos los documentos V2 (versión preliminar) usa el SDK de .NET de Azure Cosmos DB para SQL API (versión 2.13.1).
La acción Consultar documentos V4 (versión preliminar) usa el SDK de .NET de Azure Cosmos DB para SQL API (versión 3.15.0).
La acción Consultar documentos (V5) (versión preliminar) usa el SDK de .NET de Azure Cosmos DB para SQL API (versión 3.20.0).
El valor del parámetro "Número máximo de elementos" podría ser cualquier número comprendido entre 1 y 1000. Cualquier número fuera de este intervalo se convertirá implícitamente en "-1", lo que indica al servicio Cosmos DB que determine el recuento óptimo de elementos.
Si se deja vacío, las operaciones siguientes solo funcionarán con documentos que no tengan un valor de clave de partición. Los elementos con un valor de clave de partición se excluirán de estas acciones.
Debido a que Azure Cosmos DB no admite ningún tipo de operaciones de administración con autenticación de Id. de Entra de Microsoft (documentado aquí), la operación Ejecutar procedimiento almacenado (V2) (versión preliminar) solo mostrará los procedimientos almacenados disponibles (para el
SprocIdparámetro) al usar unaAccess Keyconexión basada.TokenLas autenticaciones basadas en (autenticaciones de id. de Microsoft Entra) mostrarán una lista vacía y sesprocIddeben escribir manualmente como un valor personalizado.
Importante
Las conexiones integradas de Id. de Entra de Microsoft (Azure Commercial) están deshabilitadas en entornos de administración pública de EE. UU. (GCC) de forma predeterminada. Para habilitar estos tipos de conexiones, el valor Conectarse a Azure Commercial debe estar habilitado en el Centro de administración de Power Platform por un administrador de inquilinos.
Al activar esta configuración, las conexiones a recursos de Azure Commercial que operan y envían datos fuera del límite de cumplimiento de Power Platform para la Administración Pública de Estados Unidos. Esto se usa específicamente para permitir el acceso a recursos comerciales desde versiones en la nube GCC de Power Platform Connectors.
Microsoft Entra ID Integrated (Azure Commercial) es el único tipo de autenticación que funciona desde entornos de administración pública de EE. UU. (GCC) a recursos comerciales de Azure.
Autenticación comercial de Azure deshabilitada de forma predeterminada: 
Configuración Conectarse a Azure Commercial en el Centro de administración de Power Platform: 
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Clave de acceso | Proporcione el nombre de cuenta y la clave de acceso para acceder a la cuenta de Cosmos DB. | Todas las regiones excepto Azure Government y el Departamento de Defensa (DoD) en Azure Government y us Government (GCC) y us Government (GCC-High) | Compartible |
| Clave de acceso (Azure Government) | Proporcione el nombre de cuenta y la clave de acceso para acceder a la cuenta de Cosmos DB. | Azure Government y department of Defense (DoD) en Azure Government y US Government (GCC) y us Government (GCC-High) solo | Compartible |
| Identidad administrada de Logic Apps | Creación de una conexión mediante una identidad administrada de LogicApps | Solo LOGICAPPS | Compartible |
| Microsoft Entra ID: integrado | Use Microsoft Entra ID para acceder a Azure Blob Storage. | Todas las regiones excepto Azure Government y el Departamento de Defensa (DoD) en Azure Government y us Government (GCC) y us Government (GCC-High) | No se puede compartir |
| Microsoft Entra ID integrado (Azure Commercial) | Use Microsoft Entra ID para acceder a Azure Blob Storage en Azure Commercial. | Solo gobierno de EE. UU. (GCC) | No se puede compartir |
| Microsoft Entra ID integrado (Azure Government) | Use Microsoft Entra ID para acceder a Azure Blob Storage. | Azure Government y department of Defense (DoD) en Azure Government y US Government (GCC) y us Government (GCC-High) solo | No se puede compartir |
| Valor predeterminado [EN DESUSO] | Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores. | Todas las regiones | No se puede compartir |
Clave de acceso
Identificador de autenticación: keyBasedAuth
Aplicable: todas las regiones excepto Azure Government y Departamento de Defensa (DoD) en Azure Government y us Government (GCC) y us Government (GCC-High)
Proporcione el nombre de cuenta y la clave de acceso para acceder a la cuenta de Cosmos DB.
Se trata de una conexión que se puede compartir. Si la aplicación de energía se comparte con otro usuario, también se comparte la conexión. Para más información, consulte introducción a los conectores para aplicaciones de lienzo: Power Apps | Microsoft Docs
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Id. de cuenta | cuerda / cadena | Nombre de la cuenta sin la parte "documents.azure.com" | Cierto |
| Clave de acceso a la cuenta de Azure Cosmos DB | securestring | Clave principal o secundaria | Cierto |
Clave de acceso (Azure Government)
Identificador de autenticación: keyBasedAuth
Aplicable: Azure Government y Departamento de Defensa (DoD) solo en Azure Government y us Government (GCC) y us Government (GCC-High)
Proporcione el nombre de cuenta y la clave de acceso para acceder a la cuenta de Cosmos DB.
Se trata de una conexión que se puede compartir. Si la aplicación de energía se comparte con otro usuario, también se comparte la conexión. Para más información, consulte introducción a los conectores para aplicaciones de lienzo: Power Apps | Microsoft Docs
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Id. de cuenta | cuerda / cadena | Nombre de la cuenta sin la parte "documents.azure.com" | Cierto |
| Clave de acceso a la cuenta de Azure Cosmos DB | securestring | Clave principal o secundaria | Cierto |
Identidad administrada de Logic Apps
Identificador de autenticación: managedIdentityAuth
Aplicable: SOLO LOGICAPPS
Creación de una conexión mediante una identidad administrada de LogicApps
Se trata de una conexión que se puede compartir. Si la aplicación de energía se comparte con otro usuario, también se comparte la conexión. Para más información, consulte introducción a los conectores para aplicaciones de lienzo: Power Apps | Microsoft Docs
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Identidad administrada de LogicApps | managedIdentity | Inicio de sesión con una identidad administrada de Logic Apps | Cierto |
Microsoft Entra ID integrado
Identificador de autenticación: tokenBasedAuth
Aplicable: todas las regiones excepto Azure Government y Departamento de Defensa (DoD) en Azure Government y us Government (GCC) y us Government (GCC-High)
Use Microsoft Entra ID para acceder a Azure Blob Storage.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
Microsoft Entra ID integrado (Azure Commercial)
Identificador de autenticación: oauthCom
Aplicable: Solo gobierno de EE. UU. (GCC)
Use Microsoft Entra ID para acceder a Azure Blob Storage en Azure Commercial.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
Microsoft Entra ID integrado (Azure Government)
Identificador de autenticación: tokenBasedAuth
Aplicable: Azure Government y Departamento de Defensa (DoD) solo en Azure Government y us Government (GCC) y us Government (GCC-High)
Use Microsoft Entra ID para acceder a Azure Blob Storage.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
Valor predeterminado [EN DESUSO]
Aplicable: Todas las regiones
Esta opción solo es para conexiones anteriores sin un tipo de autenticación explícito y solo se proporciona para la compatibilidad con versiones anteriores.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Id. de cuenta | cuerda / cadena | Nombre de la cuenta sin la parte "documents.azure.com" | Cierto |
| Clave de acceso a la cuenta de Azure Cosmos DB | securestring | Clave principal o secundaria | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 1500 | 60 segundos |
Acciones
| Consulta de documentos V5 |
Consultar documentos (V5). |
| Consultar documentos [EN DESUSO] |
Esta acción ha quedado en desuso. Use los documentos de consulta V5 en su lugar.
|
| Consultar documentos V2 [EN DESUSO] |
Esta acción ha quedado en desuso. Use los documentos de consulta V5 en su lugar.
|
| Consultar documentos V3 [EN DESUSO] |
Esta acción ha quedado en desuso. Use los documentos de consulta V5 en su lugar.
|
| Consultar documentos V4 [EN DESUSO] |
Esta acción ha quedado en desuso. Use los documentos de consulta V5 en su lugar.
|
| Creación de un procedimiento almacenado (V2) |
Cree un procedimiento almacenado (V2). |
| Crear o actualizar documento (V2) [EN DESUSO] |
Esta acción ha quedado en desuso. Use crear o actualizar el documento (V3) en su lugar.
|
| Crear o actualizar documento (V3) |
Cree o actualice el documento. Al crear un documento en DocumentDB, el cuerpo debe incluir una propiedad id. |
| Crear o actualizar el documento [EN DESUSO] |
Esta acción ha quedado en desuso. Use crear o actualizar el documento (V3) en su lugar.
|
| Crear procedimiento almacenado [EN DESUSO] |
Esta acción ha quedado en desuso. En su lugar, use Create stored procedure (V2) (Crear procedimiento almacenado [V2] ).
|
| Ejecutar procedimiento almacenado (V2) |
Ejecute el procedimiento almacenado en la colección especificada (V2). |
| Ejecutar procedimiento almacenado [EN DESUSO] |
Esta acción ha quedado en desuso. Use el procedimiento almacenado Execute (V2) en su lugar.
|
| Eliminar procedimiento almacenado (V2) |
Eliminar procedimiento almacenado (V2). |
| Eliminar procedimiento almacenado [EN DESUSO] |
Esta acción ha quedado en desuso. Use el procedimiento almacenado Delete (V2) en su lugar.
|
| Eliminar un documento (V2) |
Eliminar un documento (V2). |
| Eliminar un documento [EN DESUSO] |
Esta acción ha quedado en desuso. Use Eliminar un documento (V2) en su lugar.
|
| Obtener procedimientos almacenados (V2) |
Obtener procedimientos almacenados en la colección especificada (V2). |
| Obtener procedimientos almacenados [EN DESUSO] |
Esta acción ha quedado en desuso. En su lugar, use Obtener procedimientos almacenados (V2).
|
| Obtener todos los documentos (V3) |
Obtener todos los documentos (V3). |
| Obtener todos los documentos [EN DESUSO] |
Esta acción ha quedado en desuso. Use Obtener todos los documentos (V3) en su lugar.
|
| Obtener todos los documentos V2 [EN DESUSO] |
Esta acción ha quedado en desuso. Use Obtener todos los documentos (V3) en su lugar.
|
| Obtener un documento (V2) |
Obtener un documento (V2). |
| Obtener un documento [EN DESUSO] |
Esta acción ha quedado en desuso. Use Obtener un documento (V2) en su lugar.
|
| Reemplazar procedimiento almacenado (V2) |
Reemplace el procedimiento almacenado (V2). |
| Reemplazar procedimiento almacenado [EN DESUSO] |
Esta acción ha quedado en desuso. Use el procedimiento almacenado Replace (V2) en su lugar.
|
| Reemplazar un documento (V2) |
Reemplace un documento (V2). |
| Reemplazar un documento [EN DESUSO] |
Esta acción ha quedado en desuso. Use Reemplazar un documento (V2) en su lugar.
|
Consulta de documentos V5
Consultar documentos (V5).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
ID de contenedor
|
containerId | True | string |
El nombre del contenedor. |
|
Consulta de sintaxis SQL
|
queryText | string |
Consulta SQL. Si está vacío, devolverá todos los documentos. |
|
|
Valor de clave de partición
|
partitionKey | string |
El valor debe proporcionarse según su tipo ("string", 42, 0,5). Si está vacío, se usarán todas las particiones para buscar documentos. |
|
|
Número máximo de elementos
|
maxItemCount | integer |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
continuationToken | string |
Token para capturar resultados adicionales. |
|
|
Nivel de coherencia
|
consistencyLevel | string |
Nivel de coherencia necesario para la operación de fuente (fuente de consulta y lectura). |
|
|
Token de sesión
|
sessionToken | string |
Token de sesión para su uso con coherencia de sesión. |
Devoluciones
Matriz de documentos que coinciden con la consulta solicitada y los metadatos relacionados.
- Body
- DocumentsCollection
Consultar documentos [EN DESUSO]
Esta acción ha quedado en desuso. Use los documentos de consulta V5 en su lugar.
Consultar documentos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Habilitar la partición cruzada
|
x-ms-documentdb-query-enablecrosspartition | boolean |
Si la colección tiene particiones, debe establecerse en True para permitir la ejecución en varias particiones. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
query
|
query | string |
Devoluciones
- Body
- queryResponse
Consultar documentos V2 [EN DESUSO]
Esta acción ha quedado en desuso. Use los documentos de consulta V5 en su lugar.
Consulta de documentos V2.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Texto de consulta
|
QueryText | string |
Consulta de sintaxis SQL sobre documentos |
|
|
Valor de clave de partición
|
partitionKey | string |
Valor de clave de partición. |
|
|
Token de continuación
|
continuationToken | string |
Token para capturar resultados adicionales de la operación. |
Devoluciones
Matriz de documentos que coinciden con la consulta solicitada y los metadatos relacionados.
Consultar documentos V3 [EN DESUSO]
Esta acción ha quedado en desuso. Use los documentos de consulta V5 en su lugar.
Consulta de documentos V3.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Consulta de sintaxis SQL
|
queryText | True | string |
Consulta SQL. |
|
Valor de clave de partición
|
partitionKey | string |
Si está vacío, se usarán todas las particiones para buscar documentos. |
|
|
Número máximo de elementos
|
maxItemCount | integer |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
continuationToken | string |
Token para capturar resultados adicionales. |
|
|
Habilitar la partición cruzada
|
enableCrossPartition | boolean |
Indica si el usuario está habilitado para enviar más de una solicitud para ejecutar la consulta. |
|
|
Nivel de coherencia
|
consistencyLevel | string |
Nivel de coherencia necesario para la operación de fuente (fuente de consulta y lectura). |
|
|
Token de sesión
|
sessionToken | string |
Token de sesión para su uso con coherencia de sesión. |
Devoluciones
Matriz de documentos que coinciden con la consulta solicitada y los metadatos relacionados.
- Body
- DocumentsCollection
Consultar documentos V4 [EN DESUSO]
Esta acción ha quedado en desuso. Use los documentos de consulta V5 en su lugar.
Consulta de documentos V4.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
ID de contenedor
|
containerId | True | string |
El nombre del contenedor. |
|
Consulta de sintaxis SQL
|
queryText | string |
Consulta SQL. Si está vacío, devolverá todos los documentos. |
|
|
Valor de clave de partición
|
partitionKey | string |
Si está vacío, se usarán todas las particiones para buscar documentos. |
|
|
Número máximo de elementos
|
maxItemCount | integer |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
continuationToken | string |
Token para capturar resultados adicionales. |
|
|
Nivel de coherencia
|
consistencyLevel | string |
Nivel de coherencia necesario para la operación de fuente (fuente de consulta y lectura). |
|
|
Token de sesión
|
sessionToken | string |
Token de sesión para su uso con coherencia de sesión. |
Devoluciones
Matriz de documentos que coinciden con la consulta solicitada y los metadatos relacionados.
- Body
- DocumentsCollection
Creación de un procedimiento almacenado (V2)
Cree un procedimiento almacenado (V2).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Definición de función
|
body | string |
Función que define el procedimiento almacenado, por ejemplo, 'function(params){ ... }' |
|
|
id
|
id | string |
Nuevo identificador del procedimiento almacenado. |
|
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
Crear o actualizar documento (V2) [EN DESUSO]
Esta acción ha quedado en desuso. Use crear o actualizar el documento (V3) en su lugar.
Cree o actualice el documento. Al crear un documento en DocumentDB, el cuerpo debe incluir una propiedad id.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Si se establece en true, el documento se reemplazará si existe otra creación. |
|
|
Desencadenador previo
|
x-ms-documentdb-pre-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán antes de ejecutar la operación del documento. |
|
|
Desencadenador posterior
|
x-ms-documentdb-post-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán después de ejecutar la operación del documento. |
|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
Crear o actualizar documento (V3)
Cree o actualice el documento. Al crear un documento en DocumentDB, el cuerpo debe incluir una propiedad id.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Si se establece en true, el documento se reemplazará si existe otra creación. |
|
|
Desencadenador previo
|
x-ms-documentdb-pre-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán antes de ejecutar la operación del documento. |
|
|
Desencadenador posterior
|
x-ms-documentdb-post-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán después de ejecutar la operación del documento. |
|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
Crear o actualizar el documento [EN DESUSO]
Esta acción ha quedado en desuso. Use crear o actualizar el documento (V3) en su lugar.
Cree o actualice el documento. Al crear un documento en DocumentDB, el cuerpo debe incluir una propiedad id.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Si se establece en true, el documento se reemplazará si existe otra creación. |
|
|
Desencadenador previo
|
x-ms-documentdb-pre-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán antes de ejecutar la operación del documento. |
|
|
Desencadenador posterior
|
x-ms-documentdb-post-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán después de ejecutar la operación del documento. |
|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
Crear procedimiento almacenado [EN DESUSO]
Esta acción ha quedado en desuso. En su lugar, use Create stored procedure (V2) (Crear procedimiento almacenado [V2] ).
Cree un procedimiento almacenado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Definición de función
|
body | string |
Función que define el procedimiento almacenado, por ejemplo, 'function(params){ ... }' |
|
|
id
|
id | string |
Nuevo identificador del procedimiento almacenado. |
|
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
Ejecutar procedimiento almacenado (V2)
Ejecute el procedimiento almacenado en la colección especificada (V2).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Id. de Sproc
|
sprocId | True | string |
Nombre del procedimiento almacenado. |
|
Parámetros para el procedimiento almacenado
|
parameters | string |
Especifique JSON válido para los parámetros del procedimiento almacenado, por ejemplo, ["param1", "param2"]. |
|
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
- response
- ObjectWithoutType
Ejecutar procedimiento almacenado [EN DESUSO]
Esta acción ha quedado en desuso. Use el procedimiento almacenado Execute (V2) en su lugar.
Ejecute el procedimiento almacenado en la colección especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Id. de Sproc
|
sprocId | True | string |
Nombre del procedimiento almacenado. |
|
Parámetros para el procedimiento almacenado
|
parameters | string |
Especifique JSON válido para los parámetros del procedimiento almacenado, por ejemplo, ["param1", "param2"]. |
|
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
- response
- ObjectWithoutType
Eliminar procedimiento almacenado (V2)
Eliminar procedimiento almacenado (V2).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Id. de Sproc
|
sprocId | True | string |
Nombre del procedimiento almacenado. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
- response
- string
Eliminar procedimiento almacenado [EN DESUSO]
Esta acción ha quedado en desuso. Use el procedimiento almacenado Delete (V2) en su lugar.
Eliminar procedimiento almacenado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Id. de Sproc
|
sprocId | True | string |
Nombre del procedimiento almacenado. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
- response
- string
Eliminar un documento (V2)
Eliminar un documento (V2).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
Desencadenador previo
|
x-ms-documentdb-pre-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán antes de ejecutar la operación del documento. |
|
|
Desencadenador posterior
|
x-ms-documentdb-post-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán después de ejecutar la operación del documento. |
|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Id. de documento
|
documentId | True | string |
Identificador del documento. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Eliminar un documento [EN DESUSO]
Esta acción ha quedado en desuso. Use Eliminar un documento (V2) en su lugar.
Elimine un documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
Desencadenador previo
|
x-ms-documentdb-pre-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán antes de ejecutar la operación del documento. |
|
|
Desencadenador posterior
|
x-ms-documentdb-post-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán después de ejecutar la operación del documento. |
|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Id. de documento
|
documentId | True | string |
Identificador del documento. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Obtener procedimientos almacenados (V2)
Obtener procedimientos almacenados en la colección especificada (V2).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
Obtener procedimientos almacenados [EN DESUSO]
Esta acción ha quedado en desuso. En su lugar, use Obtener procedimientos almacenados (V2).
Obtiene los procedimientos almacenados de la colección especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
Obtener todos los documentos (V3)
Obtener todos los documentos (V3).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
- Body
- getDocumentsResponse
Obtener todos los documentos [EN DESUSO]
Esta acción ha quedado en desuso. Use Obtener todos los documentos (V3) en su lugar.
Obtenga todos los documentos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
- Body
- getDocumentsResponse
Obtener todos los documentos V2 [EN DESUSO]
Esta acción ha quedado en desuso. Use Obtener todos los documentos (V3) en su lugar.
Obtenga todos los documentos V2.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Valor de clave de partición
|
partitionKey | string |
Si está vacío, se usarán todas las particiones para buscar documentos. |
|
|
Número máximo de elementos
|
maxItemCount | integer |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
continuationToken | string |
Token para capturar resultados adicionales. |
|
|
Nivel de coherencia
|
consistencyLevel | string |
Nivel de coherencia necesario para la operación de fuente (fuente de consulta y lectura). |
|
|
Token de sesión
|
sessionToken | string |
Token de sesión para su uso con coherencia de sesión. |
Devoluciones
Matriz de documentos que coinciden con la consulta solicitada y los metadatos relacionados.
- Body
- DocumentsCollection
Obtener un documento (V2)
Obtener un documento (V2).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Id. de documento
|
documentId | True | string |
Identificador del documento. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
- response
- object
Obtener un documento [EN DESUSO]
Esta acción ha quedado en desuso. Use Obtener un documento (V2) en su lugar.
Obtener un documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Id. de documento
|
documentId | True | string |
Identificador del documento. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
- response
- object
Reemplazar procedimiento almacenado (V2)
Reemplace el procedimiento almacenado (V2).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Id. de Sproc
|
sprocId | True | string |
Nombre del procedimiento almacenado. |
|
Definición de función
|
body | string |
Función que define el procedimiento almacenado, por ejemplo, 'function(params){ ... }' |
|
|
id
|
id | string |
Identificador del procedimiento almacenado existente. |
|
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
Reemplazar procedimiento almacenado [EN DESUSO]
Esta acción ha quedado en desuso. Use el procedimiento almacenado Replace (V2) en su lugar.
Reemplace el procedimiento almacenado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Id. de Sproc
|
sprocId | True | string |
Nombre del procedimiento almacenado. |
|
Definición de función
|
body | string |
Función que define el procedimiento almacenado, por ejemplo, 'function(params){ ... }' |
|
|
id
|
id | string |
Identificador del procedimiento almacenado existente. |
|
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
Reemplazar un documento (V2)
Reemplace un documento (V2).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
Desencadenador previo
|
x-ms-documentdb-pre-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán antes de ejecutar la operación del documento. |
|
|
Desencadenador posterior
|
x-ms-documentdb-post-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán después de ejecutar la operación del documento. |
|
|
Nombre de la cuenta de Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nombre de la cuenta de Azure Cosmos DB (sin documents.azure.com). |
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Id. de documento
|
documentId | True | string |
Identificador del documento. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
- Body
- putDocumentResponse
Reemplazar un documento [EN DESUSO]
Esta acción ha quedado en desuso. Use Reemplazar un documento (V2) en su lugar.
Reemplace un documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Valor de clave de partición
|
x-ms-documentdb-raw-partitionkey | string |
Valor de clave de partición para la operación de documento o datos adjuntos solicitados. |
|
|
Número máximo de elementos
|
x-ms-max-item-count | number |
Entero que indica el número máximo de elementos que se van a devolver por página. |
|
|
Token de continuación
|
x-ms-continuation | string |
Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. |
|
|
Nivel de coherencia
|
x-ms-consistency-level | string |
Esta es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de más fuerte a débil). |
|
|
Token de sesión
|
x-ms-session-token | string |
Token de cadena usado con coherencia de nivel de sesión. |
|
|
Id. de actividad
|
x-ms-activity-id | string |
Identificador proporcionado por el cliente para la operación, que se devolverá en la respuesta del servidor. |
|
|
Desencadenador previo
|
x-ms-documentdb-pre-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán antes de ejecutar la operación del documento. |
|
|
Desencadenador posterior
|
x-ms-documentdb-post-trigger-include | string |
Lista separada por comas de nombres de desencadenador que se ejecutarán después de ejecutar la operación del documento. |
|
|
Identificador de base de datos
|
databaseId | True | string |
El nombre de la base de datos. |
|
Id. de colección
|
collectionId | True | string |
Nombre de la colección. |
|
Id. de documento
|
documentId | True | string |
Identificador del documento. |
|
Versión de API
|
x-ms-version | string |
Versión de API. |
Devoluciones
- Body
- putDocumentResponse
Definiciones
QueryDocumentsResponse
Matriz de documentos que coinciden con la consulta solicitada y los metadatos relacionados.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Documentos
|
Documents | array of ObjectWithoutType |
Matriz de documentos que coinciden con la solicitud. |
|
Número de documentos
|
_count | integer |
Número de documentos. |
|
Identificador de actividad
|
ActivityId | string |
Identificador de actividad del servicio Azure Cosmos DB. |
DocumentsCollection
Matriz de documentos que coinciden con la consulta solicitada y los metadatos relacionados.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Documentos
|
value | array of ObjectWithoutType | |
|
Token de continuación
|
ContinuationToken | string | |
|
Número de documentos
|
Count | integer | |
|
Cargo de solicitud
|
RequestCharge | double | |
|
Token de sesión
|
SessionToken | string | |
|
Id. de actividad
|
ActivityId | string |
postDocumentsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_ts
|
_ts | integer | |
|
_propio
|
_self | string | |
|
_etag
|
_etag | string | |
|
_Accesorios
|
_attachments | string | |
|
id
|
id | string |
putDocumentResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
id
|
id | string |
getDocumentsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
Documentos
|
Documents | array of object |
queryResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_contar
|
_count | number | |
|
Documentos
|
Documents | array of |
getStoredProceduresResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
_contar
|
_count | integer |
_contar |
|
_rid
|
_rid | string |
_rid |
|
Procedimientos almacenados
|
StoredProcedures | array of object |
Procedimientos almacenados |
|
_etag
|
StoredProcedures._etag | string |
_etag |
|
_rid
|
StoredProcedures._rid | string |
_rid |
|
_propio
|
StoredProcedures._self | string |
_propio |
|
_ts
|
StoredProcedures._ts | integer |
_ts |
|
body
|
StoredProcedures.body | string |
body |
|
id
|
StoredProcedures.id | string |
id |
createStoredProcedureResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
_etag
|
_etag | string |
_etag |
|
_rid
|
_rid | string |
_rid |
|
_propio
|
_self | string |
_propio |
|
_ts
|
_ts | integer |
_ts |
|
body
|
body | string |
body |
|
id
|
id | string |
id |
ObjectWithoutType
cuerda / cadena
Este es el tipo de datos básico "string".
objeto
Este es el tipo 'object'.