Azure Cosmos DB, un servizio di database distribuito globale di Microsoft
Azure Cosmos DB è un servizio di database multimodello distribuito a livello globale progettato per consentire di ridimensionare in modo elastico e indipendente la velocità effettiva e l'archiviazione in qualsiasi numero di aree geografiche con un contratto di servizio completo.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate |
| App per la logica | Normale | Tutte le aree di App per la logica |
| Power Apps | - | Non disponibile |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate |
| Metadati del connettore | |
|---|---|
| Editore | Microsoft |
Per usare questa integrazione, è necessario un account API SQL di Cosmos DB configurato nel portale di Azure. Si noti che gli account API Mongo DB non sono attualmente supportati.
Dopo aver creato l'account API SQL, specificare l'ID account (senza "documents.azure.com") durante la creazione di una connessione con il connettore Azure Cosmos DB se si crea una connessione di Access Key tipo. Questo ID account è necessario anche per le versioni più recenti dell'operazione che supportano l'autenticazione di Microsoft Entra ID.
Autenticazione con ID Microsoft Entra e connettore Cosmos DB
Per usare l'autenticazione di Microsoft Entra ID, all'account usato deve essere assegnato un'assegnazione di ruolo specifica. Per altre informazioni, vedere Configurare il controllo degli accessi in base al ruolo con l'ID Microsoft Entra per l'account Azure Cosmos DB.
Annotazioni
Solo i ruoli definiti in modo esplicito per l'accesso ai dati consentono a un'entità di sicurezza di accedere ai dati di Cosmos DB. Ruoli predefiniti, Ownerad esempio , o Contributornon forniscono l'accesso ai dati di Cosmos DB all'interno di tale account tramite Microsoft Entra ID. Esistono due ruoli predefiniti esposti da Azure Cosmos DB:
-
Cosmos DB Built-in Data Reader(ID00000000-0000-0000-0000-000000000001definizione ruolo ) -
Cosmos DB Built-in Data Contributor(ID00000000-0000-0000-0000-000000000002definizione ruolo )
Ai ruoli possono essere assegnati numerosi modi e i ruoli personalizzati possono essere creati per un accesso più granulare.
Ecco un esempio su chi assegnare Cosmos DB Built-in Data Reader tramite PowerShell (altre informazioni su questo 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 "/"
Se non si aggiungono queste assegnazioni di ruolo, si verifica una richiesta non autorizzata come quella seguente: Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.
Annotazioni
Azure Cosmos DB non supporta alcun tipo di operazioni di gestione con l'autenticazione CON ID Entra di Microsoft (documentata qui). Le operazioni seguenti funzioneranno solo con Access Key le connessioni:
- Creare una stored procedure (versioni V1 e V2)
- Eliminare la stored procedure (versioni V1 e V2)
- Aggiornare la stored procedure (versioni V1 e V2)
Operazioni non supportate con l'autenticazione di Microsoft Entra ID
Quando si usa l'autenticazione di Microsoft Entra ID , sono supportate solo le azioni con il nome dell'account Cosmos DB come parametro. Le azioni deprecate continueranno a funzionare con Access Key l'autenticazione, ma non riusciranno se usate con una connessione Microsoft Entra ID.
Problemi noti e limitazioni
Le dimensioni massime di un documento supportato dal connettore DocumentDB (Azure Cosmos DB) sono di 2 MB.
Le limitazioni di Azure Cosmos DB sono documentate qui.
La scelta di un'area di scrittura e di aree in più scrittura non è supportata dal connettore.
Il valore della chiave di partizione deve essere fornito in base al tipo. Ad esempio, un valore stringa deve essere racchiuso tra virgolette, un numero deve essere fornito così come è. Ad esempio: "valore stringa",123, 0,5.
Il "valore della chiave di partizione" è necessario per le query con
ORDER BY,DISTINCTe così via, eseguite nelle raccolte partizionate.Eseguire query sui documenti V2 [DEPRECATO], Eseguire query sui documenti V3, Ottenere tutti i documenti V2 (anteprima) azioni usa Azure Cosmos DB .NET SDK per l'API SQL (versione 2.13.1).
Eseguire query su documenti V4 (anteprima) usa Azure Cosmos DB .NET SDK per l'API SQL (versione 3.15.0).
L'azione Query documents (V5) (Anteprima) usa Azure Cosmos DB .NET SDK per l'API SQL (versione 3.20.0).
Il valore del parametro "Numero massimo di elementi" può essere qualsiasi numero compreso tra 1 e 1000. Qualsiasi numero al di fuori di questo intervallo verrà convertito in modo implicito in "-1", che indica al servizio Cosmos DB di determinare il numero di elementi ottimale.
Se lasciato vuoto, le operazioni seguenti funzioneranno solo con i documenti che non hanno un valore di chiave di partizione. Gli elementi con un valore di chiave di partizione verranno esclusi da queste azioni.
A causa del fatto che Azure Cosmos DB non supporta alcun tipo di operazioni di gestione con l'autenticazione CON ID di Microsoft Entra (documentata qui), l'operazione Esegui stored procedure (V2) (anteprima) visualizzerà solo le stored procedure disponibili (per il
SprocIdparametro) quando si usa unaAccess Keyconnessione basata.Tokenle autenticazioni basate su (autenticazioni microsoft Entra ID) mostreranno un elenco vuoto e devesprocIdessere immesso manualmente come valore personalizzato.
Importante
Le connessioni Microsoft Entra ID Integrated (Azure Commercial) sono disabilitate negli ambienti GCC (US Government) per impostazione predefinita. Per abilitare questi tipi di connessioni, l'impostazione Connetti ad Azure Commercial deve essere abilitata nell'interfaccia di amministrazione di Power Platform da un amministratore tenant.
L'attivazione di questa impostazione consente le connessioni alle risorse in Azure Commercial che operano e inviano dati al di fuori del limite di conformità di Power Platform US Government. Viene usato in modo specifico per consentire l'accesso alle risorse commerciali dalle versioni cloud GCC di Power Platform Connectors.
Microsoft Entra ID Integrated (Azure Commercial) è l'unico tipo di autenticazione che funziona dagli ambienti GCC (US Government) alle risorse commerciali di Azure.
Autenticazione commerciale di Azure disabilitata per 
L'impostazione Connetti ad Azure Commercial nell'interfaccia di amministrazione di Power Platform: 
Creazione di una connessione
Il connettore supporta i tipi di autenticazione seguenti:
| chiave di accesso | Specificare il nome dell'account e la chiave di accesso per accedere all'account Cosmos DB. | Tutte le aree ad eccezione di Azure per enti pubblici e del dipartimento della difesa (DoD) in Azure per enti pubblici e us government (GCC) e US Government (GCC-High) | Condivisibile |
| Chiave di accesso (Azure per enti pubblici) | Specificare il nome dell'account e la chiave di accesso per accedere all'account Cosmos DB. | Azure per enti pubblici e reparto di difesa (DoD) solo in Azure per enti pubblici e us government (GCC) e US Government (GCC-High) | Condivisibile |
| Identità gestita di App per la logica | Creare una connessione usando un'identità gestita di LogicApps | Solo LOGICAPPS | Condivisibile |
| Microsoft Entra ID integrato | Usare Microsoft Entra ID per accedere all'archivio BLOB di Azure. | Tutte le aree ad eccezione di Azure per enti pubblici e del dipartimento della difesa (DoD) in Azure per enti pubblici e us government (GCC) e US Government (GCC-High) | Non condivisibile |
| Microsoft Entra ID Integrated (Azure Commercial) | Usare Microsoft Entra ID per accedere all'archiviazione BLOB di Azure in Azure Commercial. | Solo US Government (GCC) | Non condivisibile |
| Microsoft Entra ID Integrated (Azure per enti pubblici) | Usare Microsoft Entra ID per accedere all'archivio BLOB di Azure. | Azure per enti pubblici e reparto di difesa (DoD) solo in Azure per enti pubblici e us government (GCC) e US Government (GCC-High) | Non condivisibile |
| Impostazione predefinita [DEPRECATO] | Questa opzione è solo per le connessioni meno recenti senza un tipo di autenticazione esplicito e viene fornita solo per la compatibilità con le versioni precedenti. | Tutte le aree geografiche | Non condivisibile |
Chiave di Accesso
ID autenticazione: keyBasedAuth
Applicabile: tutte le aree ad eccezione di Azure per enti pubblici e del dipartimento della difesa (DoD) in Azure per enti pubblici e us government (GCC) e US Government (GCC-High)
Specificare il nome dell'account e la chiave di accesso per accedere all'account Cosmos DB.
Si tratta di una connessione condivisibile. Se l'app per l'alimentazione viene condivisa con un altro utente, anche la connessione viene condivisa. Per altre informazioni, vedere Panoramica dei connettori per le app canvas - Power Apps | Microsoft Docs
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| Account ID | corda | Nome dell'account senza parte 'documents.azure.com' | Vero |
| Chiave di accesso all'account Azure Cosmos DB | securestring | Chiave primaria o secondaria | Vero |
Chiave di accesso (Azure per enti pubblici)
ID autenticazione: keyBasedAuth
Applicabile: Azure per enti pubblici e reparto di difesa (DoD) solo in Azure per enti pubblici e us government (GCC) e US Government (GCC-High)
Specificare il nome dell'account e la chiave di accesso per accedere all'account Cosmos DB.
Si tratta di una connessione condivisibile. Se l'app per l'alimentazione viene condivisa con un altro utente, anche la connessione viene condivisa. Per altre informazioni, vedere Panoramica dei connettori per le app canvas - Power Apps | Microsoft Docs
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| Account ID | corda | Nome dell'account senza parte 'documents.azure.com' | Vero |
| Chiave di accesso all'account Azure Cosmos DB | securestring | Chiave primaria o secondaria | Vero |
Identità gestita di App per la logica
ID autenticazione: managedIdentityAuth
Applicabile: solo LOGICAPPS
Creare una connessione usando un'identità gestita di LogicApps
Si tratta di una connessione condivisibile. Se l'app per l'alimentazione viene condivisa con un altro utente, anche la connessione viene condivisa. Per altre informazioni, vedere Panoramica dei connettori per le app canvas - Power Apps | Microsoft Docs
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| Identità gestita di LogicApps | Identità gestita | Accedere con un'identità gestita di App per la logica | Vero |
Microsoft Entra ID Integrato
ID autenticazione: tokenBasedAuth
Applicabile: tutte le aree ad eccezione di Azure per enti pubblici e del dipartimento della difesa (DoD) in Azure per enti pubblici e us government (GCC) e US Government (GCC-High)
Usare Microsoft Entra ID per accedere all'archivio BLOB di Azure.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
Microsoft Entra ID Integrated (Azure Commercial)
ID autenticazione: oauthCom
Applicabile: solo US Government (GCC)
Usare Microsoft Entra ID per accedere all'archiviazione BLOB di Azure in Azure Commercial.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
Microsoft Entra ID Integrated (Azure per enti pubblici)
ID autenticazione: tokenBasedAuth
Applicabile: Azure per enti pubblici e reparto di difesa (DoD) solo in Azure per enti pubblici e us government (GCC) e US Government (GCC-High)
Usare Microsoft Entra ID per accedere all'archivio BLOB di Azure.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
Impostazione predefinita [DEPRECATO]
Applicabile: tutte le aree
Questa opzione è solo per le connessioni meno recenti senza un tipo di autenticazione esplicito e viene fornita solo per la compatibilità con le versioni precedenti.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| Account ID | corda | Nome dell'account senza parte 'documents.azure.com' | Vero |
| Chiave di accesso all'account Azure Cosmos DB | securestring | Chiave primaria o secondaria | Vero |
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 1500 | 60 secondi |
Azioni
| Creare o aggiornare il documento (V2) [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Crea o aggiorna documento (V3).
|
| Creare o aggiornare il documento (V3) |
Creare o aggiornare il documento. Quando si crea un documento in DocumentDB, il corpo deve includere una proprietà id. |
| Creare o aggiornare il documento [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Crea o aggiorna documento (V3).
|
| Creare una stored procedure (V2) |
Creare una stored procedure (V2). |
| Creare una stored procedure [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Create stored procedure (V2).
|
| Eliminare la stored procedure [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Delete stored procedure (V2).
|
| Eliminare un documento (V2) |
Eliminare un documento (V2). |
| Eliminare un documento [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Elimina un documento (V2).
|
| Eliminare una stored procedure (V2) |
Eliminare la stored procedure (V2). |
| Eseguire la stored procedure (V2) |
Eseguire la stored procedure nella raccolta specificata (V2). |
| Eseguire la stored procedure [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Execute stored procedure (V2).
|
| Eseguire query sui documenti [DEPRECATO] |
Questa azione è stata deprecata. Usare invece documenti di query V5 .
|
| Eseguire query sui documenti V2 [DEPRECATO] |
Questa azione è stata deprecata. Usare invece documenti di query V5 .
|
| Eseguire query sui documenti V3 [DEPRECATO] |
Questa azione è stata deprecata. Usare invece documenti di query V5 .
|
| Eseguire query sui documenti V4 [DEPRECATO] |
Questa azione è stata deprecata. Usare invece documenti di query V5 .
|
| Eseguire query sui documenti V5 |
Eseguire query sui documenti (V5). |
| Ottenere stored procedure (V2) |
Ottenere stored procedure nella raccolta specificata (V2). |
| Ottenere stored procedure [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Get stored procedure (V2).
|
| Ottenere tutti i documenti (V3) |
Ottenere tutti i documenti (V3). |
| Ottenere tutti i documenti [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Recupera tutti i documenti (V3).
|
| Ottenere tutti i documenti V2 [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Recupera tutti i documenti (V3).
|
| Ottenere un documento (V2) |
Ottenere un documento (V2). |
| Ottenere un documento [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Recupera un documento (V2).
|
| Sostituire la stored procedure (V2) |
Sostituire la stored procedure (V2). |
| Sostituire la stored procedure [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Replace stored procedure (V2).
|
| Sostituire un documento (V2) |
Sostituire un documento (V2). |
| Sostituire un documento [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Sostituisci un documento (V2).
|
Creare o aggiornare il documento (V2) [DEPRECATO]
Questa azione è stata deprecata. Usare invece Crea o aggiorna documento (V3).
Creare o aggiornare il documento. Quando si crea un documento in DocumentDB, il corpo deve includere una proprietà id.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Se impostato su true, il documento verrà sostituito se esiste un altro elemento creato. |
|
|
Pre-trigger
|
x-ms-documentdb-pre-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire prima dell'esecuzione dell'operazione di documento. |
|
|
Post-trigger
|
x-ms-documentdb-post-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire dopo l'esecuzione dell'operazione di documento. |
|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- Corpo
- postDocumentsResponse
Creare o aggiornare il documento (V3)
Creare o aggiornare il documento. Quando si crea un documento in DocumentDB, il corpo deve includere una proprietà id.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Se impostato su true, il documento verrà sostituito se esiste un altro elemento creato. |
|
|
Pre-trigger
|
x-ms-documentdb-pre-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire prima dell'esecuzione dell'operazione di documento. |
|
|
Post-trigger
|
x-ms-documentdb-post-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire dopo l'esecuzione dell'operazione di documento. |
|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- Corpo
- postDocumentsResponse
Creare o aggiornare il documento [DEPRECATO]
Questa azione è stata deprecata. Usare invece Crea o aggiorna documento (V3).
Creare o aggiornare il documento. Quando si crea un documento in DocumentDB, il corpo deve includere una proprietà id.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Se impostato su true, il documento verrà sostituito se esiste un altro elemento creato. |
|
|
Pre-trigger
|
x-ms-documentdb-pre-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire prima dell'esecuzione dell'operazione di documento. |
|
|
Post-trigger
|
x-ms-documentdb-post-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire dopo l'esecuzione dell'operazione di documento. |
|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- Corpo
- postDocumentsResponse
Creare una stored procedure (V2)
Creare una stored procedure (V2).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Definizione della funzione
|
body | string |
Funzione che definisce la stored procedure, ad esempio 'function(params){ ... }' |
|
|
id
|
id | string |
Nuovo ID della stored procedure. |
|
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
Creare una stored procedure [DEPRECATO]
Questa azione è stata deprecata. Usare invece Create stored procedure (V2).
Creare una stored procedure.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Definizione della funzione
|
body | string |
Funzione che definisce la stored procedure, ad esempio 'function(params){ ... }' |
|
|
id
|
id | string |
Nuovo ID della stored procedure. |
|
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
Eliminare la stored procedure [DEPRECATO]
Questa azione è stata deprecata. Usare invece Delete stored procedure (V2).
Eliminare la stored procedure.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Sproc ID
|
sprocId | True | string |
Nome della stored procedure. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- response
- string
Eliminare un documento (V2)
Eliminare un documento (V2).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
Pre-trigger
|
x-ms-documentdb-pre-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire prima dell'esecuzione dell'operazione di documento. |
|
|
Post-trigger
|
x-ms-documentdb-post-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire dopo l'esecuzione dell'operazione di documento. |
|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
ID documento
|
documentId | True | string |
Identificatore del documento. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Eliminare un documento [DEPRECATO]
Questa azione è stata deprecata. Usare invece Elimina un documento (V2).
Eliminare un documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
Pre-trigger
|
x-ms-documentdb-pre-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire prima dell'esecuzione dell'operazione di documento. |
|
|
Post-trigger
|
x-ms-documentdb-post-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire dopo l'esecuzione dell'operazione di documento. |
|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
ID documento
|
documentId | True | string |
Identificatore del documento. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Eliminare una stored procedure (V2)
Eliminare la stored procedure (V2).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Sproc ID
|
sprocId | True | string |
Nome della stored procedure. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- response
- string
Eseguire la stored procedure (V2)
Eseguire la stored procedure nella raccolta specificata (V2).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Sproc ID
|
sprocId | True | string |
Nome della stored procedure. |
|
Parametri per la stored procedure
|
parameters | string |
Specificare json valido per i parametri della stored procedure, ad esempio ["param1", "param2"]. |
|
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- response
- ObjectWithoutType
Eseguire la stored procedure [DEPRECATO]
Questa azione è stata deprecata. Usare invece Execute stored procedure (V2).
Eseguire la stored procedure nella raccolta specificata.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Sproc ID
|
sprocId | True | string |
Nome della stored procedure. |
|
Parametri per la stored procedure
|
parameters | string |
Specificare json valido per i parametri della stored procedure, ad esempio ["param1", "param2"]. |
|
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- response
- ObjectWithoutType
Eseguire query sui documenti [DEPRECATO]
Questa azione è stata deprecata. Usare invece documenti di query V5 .
Eseguire query sui documenti.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Abilitare la partizione incrociata
|
x-ms-documentdb-query-enablecrosspartition | boolean |
Se la raccolta è partizionata, deve essere impostata su True per consentire l'esecuzione tra più partizioni. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
query
|
query | string |
Restituisce
- Corpo
- queryResponse
Eseguire query sui documenti V2 [DEPRECATO]
Questa azione è stata deprecata. Usare invece documenti di query V5 .
Eseguire query sui documenti V2.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Testo della Query
|
QueryText | string |
Query sulla sintassi SQL sui documenti |
|
|
Valore della chiave di partizione
|
partitionKey | string |
Valore della chiave di partizione. |
|
|
Token di continuazione
|
continuationToken | string |
Token per recuperare risultati aggiuntivi dall'operazione. |
Restituisce
Matrice di documenti che corrispondono alla query richiesta e ai metadati correlati.
- Corpo
- QueryDocumentsResponse
Eseguire query sui documenti V3 [DEPRECATO]
Questa azione è stata deprecata. Usare invece documenti di query V5 .
Eseguire query sui documenti V3.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Query sulla sintassi SQL
|
queryText | True | string |
Query SQL. |
|
Valore della chiave di partizione
|
partitionKey | string |
Se vuoto, tutte le partizioni verranno usate per la ricerca di documenti. |
|
|
Numero massimo di elementi
|
maxItemCount | integer |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
continuationToken | string |
Token per recuperare risultati aggiuntivi. |
|
|
Abilitare la partizione incrociata
|
enableCrossPartition | boolean |
Indica se l'utente è abilitato per inviare più di una richiesta per eseguire la query. |
|
|
Livello di coerenza
|
consistencyLevel | string |
Livello di coerenza necessario per l'operazione feed (feed di query/lettura). |
|
|
Token di sessione
|
sessionToken | string |
Token di sessione da usare con la coerenza della sessione. |
Restituisce
Matrice di documenti che corrispondono alla query richiesta e ai metadati correlati.
- Corpo
- DocumentsCollection
Eseguire query sui documenti V4 [DEPRECATO]
Questa azione è stata deprecata. Usare invece documenti di query V5 .
Eseguire query sui documenti V4.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID contenitore
|
containerId | True | string |
Nome del contenitore. |
|
Query sulla sintassi SQL
|
queryText | string |
Query SQL. Se vuoto, restituirà tutti i documenti. |
|
|
Valore della chiave di partizione
|
partitionKey | string |
Se vuoto, tutte le partizioni verranno usate per la ricerca di documenti. |
|
|
Numero massimo di elementi
|
maxItemCount | integer |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
continuationToken | string |
Token per recuperare risultati aggiuntivi. |
|
|
Livello di coerenza
|
consistencyLevel | string |
Livello di coerenza necessario per l'operazione feed (feed di query/lettura). |
|
|
Token di sessione
|
sessionToken | string |
Token di sessione da usare con la coerenza della sessione. |
Restituisce
Matrice di documenti che corrispondono alla query richiesta e ai metadati correlati.
- Corpo
- DocumentsCollection
Eseguire query sui documenti V5
Eseguire query sui documenti (V5).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID contenitore
|
containerId | True | string |
Nome del contenitore. |
|
Query sulla sintassi SQL
|
queryText | string |
Query SQL. Se vuoto, restituirà tutti i documenti. |
|
|
Valore della chiave di partizione
|
partitionKey | string |
Il valore deve essere specificato in base al tipo ("string", 42, 0,5). Se vuoto, tutte le partizioni verranno usate per la ricerca di documenti. |
|
|
Numero massimo di elementi
|
maxItemCount | integer |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
continuationToken | string |
Token per recuperare risultati aggiuntivi. |
|
|
Livello di coerenza
|
consistencyLevel | string |
Livello di coerenza necessario per l'operazione feed (feed di query/lettura). |
|
|
Token di sessione
|
sessionToken | string |
Token di sessione da usare con la coerenza della sessione. |
Restituisce
Matrice di documenti che corrispondono alla query richiesta e ai metadati correlati.
- Corpo
- DocumentsCollection
Ottenere stored procedure (V2)
Ottenere stored procedure nella raccolta specificata (V2).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
Ottenere stored procedure [DEPRECATO]
Questa azione è stata deprecata. Usare invece Get stored procedure (V2).
Ottenere stored procedure nella raccolta specificata.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
Ottenere tutti i documenti (V3)
Ottenere tutti i documenti (V3).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- Corpo
- getDocumentsResponse
Ottenere tutti i documenti [DEPRECATO]
Questa azione è stata deprecata. Usare invece Recupera tutti i documenti (V3).
Ottenere tutti i documenti.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- Corpo
- getDocumentsResponse
Ottenere tutti i documenti V2 [DEPRECATO]
Questa azione è stata deprecata. Usare invece Recupera tutti i documenti (V3).
Ottenere tutti i documenti V2.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Valore della chiave di partizione
|
partitionKey | string |
Se vuoto, tutte le partizioni verranno usate per la ricerca di documenti. |
|
|
Numero massimo di elementi
|
maxItemCount | integer |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
continuationToken | string |
Token per recuperare risultati aggiuntivi. |
|
|
Livello di coerenza
|
consistencyLevel | string |
Livello di coerenza necessario per l'operazione feed (feed di query/lettura). |
|
|
Token di sessione
|
sessionToken | string |
Token di sessione da usare con la coerenza della sessione. |
Restituisce
Matrice di documenti che corrispondono alla query richiesta e ai metadati correlati.
- Corpo
- DocumentsCollection
Ottenere un documento (V2)
Ottenere un documento (V2).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
ID documento
|
documentId | True | string |
Identificatore del documento. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- response
- object
Ottenere un documento [DEPRECATO]
Questa azione è stata deprecata. Usare invece Recupera un documento (V2).
Ottenere un documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
ID documento
|
documentId | True | string |
Identificatore del documento. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- response
- object
Sostituire la stored procedure (V2)
Sostituire la stored procedure (V2).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Sproc ID
|
sprocId | True | string |
Nome della stored procedure. |
|
Definizione della funzione
|
body | string |
Funzione che definisce la stored procedure, ad esempio 'function(params){ ... }' |
|
|
id
|
id | string |
ID della stored procedure esistente. |
|
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
Sostituire la stored procedure [DEPRECATO]
Questa azione è stata deprecata. Usare invece Replace stored procedure (V2).
Sostituire la stored procedure.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
Sproc ID
|
sprocId | True | string |
Nome della stored procedure. |
|
Definizione della funzione
|
body | string |
Funzione che definisce la stored procedure, ad esempio 'function(params){ ... }' |
|
|
id
|
id | string |
ID della stored procedure esistente. |
|
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
Sostituire un documento (V2)
Sostituire un documento (V2).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
Pre-trigger
|
x-ms-documentdb-pre-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire prima dell'esecuzione dell'operazione di documento. |
|
|
Post-trigger
|
x-ms-documentdb-post-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire dopo l'esecuzione dell'operazione di documento. |
|
|
Nome dell'account Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nome dell'account Azure Cosmos DB (senza documents.azure.com). |
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
ID documento
|
documentId | True | string |
Identificatore del documento. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- Corpo
- putDocumentResponse
Sostituire un documento [DEPRECATO]
Questa azione è stata deprecata. Usare invece Sostituisci un documento (V2).
Sostituire un documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Valore della chiave di partizione
|
x-ms-documentdb-raw-partitionkey | string |
Valore della chiave di partizione per l'operazione richiesta di documento o allegato. |
|
|
Numero massimo di elementi
|
x-ms-max-item-count | number |
Intero che indica il numero massimo di elementi da restituire per pagina. |
|
|
Token di continuazione
|
x-ms-continuation | string |
Token stringa restituito per le query e le operazioni di lettura del feed se sono presenti altri risultati da leggere. |
|
|
Livello di coerenza
|
x-ms-consistency-level | string |
Si tratta dell'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine da più sicuro a più debole). |
|
|
Token di sessione
|
x-ms-session-token | string |
Token stringa usato con coerenza a livello di sessione. |
|
|
ID attività
|
x-ms-activity-id | string |
Identificatore fornito dal client per l'operazione, che verrà restituito nella risposta del server. |
|
|
Pre-trigger
|
x-ms-documentdb-pre-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire prima dell'esecuzione dell'operazione di documento. |
|
|
Post-trigger
|
x-ms-documentdb-post-trigger-include | string |
Elenco delimitato da virgole di nomi di trigger da eseguire dopo l'esecuzione dell'operazione di documento. |
|
|
ID del database
|
databaseId | True | string |
Nome del database. |
|
ID raccolta
|
collectionId | True | string |
Nome della raccolta. |
|
ID documento
|
documentId | True | string |
Identificatore del documento. |
|
Versione dell'API
|
x-ms-version | string |
Versione API. |
Restituisce
- Corpo
- putDocumentResponse
Definizioni
QueryDocumentsResponse
Matrice di documenti che corrispondono alla query richiesta e ai metadati correlati.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documents
|
Documents | array of ObjectWithoutType |
Matrice di documenti che corrispondono alla richiesta. |
|
Numero di documenti
|
_count | integer |
Numero di documenti. |
|
ID attività
|
ActivityId | string |
ID attività del servizio Azure Cosmos DB. |
DocumentsCollection
Matrice di documenti che corrispondono alla query richiesta e ai metadati correlati.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documents
|
value | array of ObjectWithoutType | |
|
Token di continuazione
|
ContinuationToken | string | |
|
Numero di documenti
|
Count | integer | |
|
Addebito richiesta
|
RequestCharge | double | |
|
Token di sessione
|
SessionToken | string | |
|
ID attività
|
ActivityId | string |
postDocumentsResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_ts
|
_ts | integer | |
|
_stesso
|
_self | string | |
|
_etag
|
_etag | string | |
|
_Allegati
|
_attachments | string | |
|
id
|
id | string |
putDocumentResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
id
|
id | string |
getDocumentsResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
Documents
|
Documents | array of object |
queryResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_contare
|
_count | number | |
|
Documents
|
Documents | array of |
getStoredProceduresResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
_contare
|
_count | integer |
_contare |
|
_rid
|
_rid | string |
_rid |
|
Stored procedure
|
StoredProcedures | array of object |
Stored procedure |
|
_etag
|
StoredProcedures._etag | string |
_etag |
|
_rid
|
StoredProcedures._rid | string |
_rid |
|
_stesso
|
StoredProcedures._self | string |
_stesso |
|
_ts
|
StoredProcedures._ts | integer |
_ts |
|
body
|
StoredProcedures.body | string |
body |
|
id
|
StoredProcedures.id | string |
id |
createStoredProcedureResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
_etag
|
_etag | string |
_etag |
|
_rid
|
_rid | string |
_rid |
|
_stesso
|
_self | string |
_stesso |
|
_ts
|
_ts | integer |
_ts |
|
body
|
body | string |
body |
|
id
|
id | string |
id |
ObjectWithoutType
corda
Si tratta del tipo di dati di base 'string'.
oggetto
Si tratta del tipo 'object'.