Azure Cosmos DB
Azure Cosmos DB to globalnie rozproszona wielomodelowa usługa bazy danych, która umożliwia elastyczne i niezależne skalowanie przepływności i magazynowania w dowolnej liczbie regionów geograficznych z kompleksową umową SLA.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps |
| Power Apps | - | Niedostępne |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate |
| Contact | |
|---|---|
| Name | Azure Cosmos DB |
| adres URL | https://learn.microsoft.com/en-us/connectors/documentdb/ |
| idcknowledgeeco@microsoft.com |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
| Website | https://www.office.com/ |
| Zasady ochrony prywatności | https://privacy.microsoft.com/ |
| Categories | AI; Analiza biznesowa |
Aby korzystać z tej integracji, musisz mieć konto interfejsu API SQL usługi Cosmos DB skonfigurowane w witrynie Azure Portal. Pamiętaj, że konta interfejsu API bazy danych Mongo DB nie są obecnie obsługiwane.
Po utworzeniu konta interfejsu API SQL podaj identyfikator konta (bez "documents.azure.com") podczas tworzenia połączenia z łącznikiem usługi Azure Cosmos DB, jeśli utworzysz połączenie Access Key typu. Ten identyfikator konta jest również wymagany w przypadku nowszych wersji operacji, które obsługują uwierzytelnianie identyfikatora Entra firmy Microsoft.
Uwierzytelnianie identyfikatora entra firmy Microsoft i łącznik usługi Cosmos DB
Aby można było używać uwierzytelniania identyfikatora Entra firmy Microsoft, używane konto musi mieć przypisane określone przypisanie roli, aby uzyskać więcej informacji, odwiedź stronę Konfigurowanie kontroli dostępu opartej na rolach przy użyciu identyfikatora Entra firmy Microsoft dla konta usługi Azure Cosmos DB.
Uwaga / Notatka
Tylko role jawnie zdefiniowane dla dostępu do danych zezwalają podmiotowi zabezpieczeń na dostęp do danych usługi Cosmos DB. Wbudowane role, takie jak Owner, lub Contributornie zapewniają dostępu do danych usługi Cosmos DB na tym koncie za pośrednictwem identyfikatora Entra firmy Microsoft. Istnieją 2 wbudowane role uwidocznione przez usługę Azure Cosmos DB:
-
Cosmos DB Built-in Data Reader(identyfikator00000000-0000-0000-0000-000000000001definicji roli ) -
Cosmos DB Built-in Data Contributor(identyfikator00000000-0000-0000-0000-000000000002definicji roli )
Role można przypisywać na wiele sposobów, a role niestandardowe można tworzyć w celu uzyskania bardziej szczegółowego dostępu.
Oto przykład przypisywania Cosmos DB Built-in Data Reader przy użyciu programu PowerShell (więcej informacji na temat tego polecenia 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 "/"
Nie można dodać tych przypisań ról, a w końcu zostaną wyświetlone nieautoryzowane żądania podobne do następujących: Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.
Uwaga / Notatka
Usługa Azure Cosmos DB nie obsługuje żadnych operacji zarządzania za pomocą uwierzytelniania microsoft Entra ID (udokumentowane tutaj). Następujące operacje będą działać tylko z połączeniami Access Key :
- Tworzenie procedury składowanej (wersje V1 i V2)
- Usuwanie procedury składowanej (wersje V1 i V2)
- Aktualizowanie procedury składowanej (wersje V1 i V2)
Operacje nieobsługiwane przy użyciu uwierzytelniania identyfikatora Entra firmy Microsoft
W przypadku korzystania z uwierzytelniania identyfikatora Entra firmy Microsoft obsługiwane są tylko akcje z nazwą konta usługi Cosmos DB jako parametrem. Przestarzałe akcje będą nadal działać z Access Key uwierzytelnianiem, ale w przypadku użycia z połączeniem Microsoft Entra ID zakończy się niepowodzeniem.
Znane problemy i ograniczenia
Maksymalny rozmiar dokumentu obsługiwanego przez łącznik usługi DocumentDB (Azure Cosmos DB) wynosi 2 MB.
Ograniczenia usługi Azure Cosmos DB zostały opisane tutaj.
Wybranie regionu zapisu i regionów z wieloma zapisami nie jest obsługiwane przez łącznik.
Wartość klucza partycji musi być podana zgodnie z jego typem. Na przykład wartość ciągu powinna być ujęta w cudzysłowy, a liczba powinna być podana w taki sposób, jak jest. Na przykład: "wartość ciągu", 123, 0,5.
"Wartość klucza partycji" jest wymagana w przypadku zapytań z elementami
ORDER BY,DISTINCTitp., które są uruchamiane w kolekcjach podzielonych na partycje.Wykonywanie zapytań dotyczących dokumentów w wersji 2 [PRZESTARZAŁE], Wykonywanie zapytań dotyczących dokumentów w wersji 3, Pobieranie wszystkich dokumentów w wersji 2 (wersja zapoznawcza) używa zestawu SDK Azure Cosmos DB .NET dla interfejsu API SQL (wersja 2.13.1).
Akcja wykonywanie zapytań dotyczących dokumentów w wersji 4 (wersja zapoznawcza) używa zestawu SDK Azure Cosmos DB .NET dla interfejsu API SQL (wersja 3.15.0).
Akcja Wykonywanie zapytań dotyczących dokumentów (V5) (wersja zapoznawcza) używa zestawu SDK Azure Cosmos DB .NET dla interfejsu API SQL (wersja 3.20.0).
Wartość parametru "Maksymalna liczba elementów" może być dowolną liczbą z zakresu od 1 do 1000. Dowolna liczba spoza tego zakresu zostanie niejawnie przekonwertowana na wartość "-1", która informuje usługę Cosmos DB o określeniu optymalnej liczby elementów.
W przypadku pozostawienia pustego następujące operacje będą działać tylko z dokumentami, które nie mają wartości klucza partycji. Elementy z wartością klucza partycji zostaną wykluczone z tych akcji.
Ze względu na to, że usługa Azure Cosmos DB nie obsługuje żadnych operacji zarządzania za pomocą uwierzytelniania microsoft Entra ID (udokumentowane tutaj), operacja Wykonaj procedurę składowaną (wersja zapoznawcza) (wersja zapoznawcza) będzie wyświetlać tylko dostępne procedury składowane (dla parametru
SprocId) podczas korzystania z połączenia opartegoAccess Key.TokenUwierzytelnianie na podstawie (Microsoft Entra ID uwierzytelniania) spowoduje wyświetlenie pustej listy isprocIdnależy wprowadzić je ręcznie jako wartość niestandardową.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| [variables('keyBasedAuthDefaultDisplayName')] | [variables('keyBasedAuthDefaultDescription')] | Wszystkie regiony z wyjątkiem Azure Government i Departamentu Obrony (DoD) w Azure Government i MOONCAKE i rząd USA (GCC-High) i rząd USA (GCC) | Udostępnialne |
| [variables('oauthDefaultDisplayName')] | [variables('oauthDefaultDescription')] | Wszystkie regiony z wyjątkiem Azure Government i Departamentu Obrony (DoD) w Azure Government i MOONCAKE i rząd USA (GCC-High) i rząd USA (GCC) | Nie można udostępniać |
| Klucz dostępu | Podaj nazwę konta i klucz dostępu, aby uzyskać dostęp do konta usługi Cosmos DB. | Tylko MOONCAKE | Udostępnialne |
| Klucz dostępu (Azure Government) | Podaj nazwę konta i klucz dostępu, aby uzyskać dostęp do konta usługi Cosmos DB. | Azure Government i Departament Obrony (DoD) tylko w Azure Government i instytucjach rządowych USA (GCC-High) i rządu USA (GCC) | Udostępnialne |
| Tożsamość zarządzana | Tworzenie połączenia przy użyciu tożsamości zarządzanej | Tylko USŁUGA LOGICAPPS | Udostępnialne |
| integracja Microsoft Entra ID | Użyj identyfikatora Entra firmy Microsoft, aby uzyskać dostęp do usługi Azure Blob Storage. | Tylko MOONCAKE | Nie można udostępniać |
| Microsoft Entra ID Integrated (Azure Commercial) | Użyj identyfikatora Entra firmy Microsoft, aby uzyskać dostęp do usługi Azure Blob Storage w usłudze Azure Commercial. | Tylko instytucje rządowe USA (GCC) | Nie można udostępniać |
| Microsoft Entra ID Integrated (Azure Government) | Użyj identyfikatora Entra firmy Microsoft, aby uzyskać dostęp do usługi Azure Blob Storage. | Azure Government i Departament Obrony (DoD) tylko w Azure Government i instytucjach rządowych USA (GCC-High) i rządu USA (GCC) | Nie można udostępniać |
| Domyślne [PRZESTARZAŁE] | Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami. | Wszystkie regiony | Nie można udostępniać |
[variables('keyBasedAuthDefaultDisplayName')]
Identyfikator uwierzytelniania: keyBasedAuth
Dotyczy: Wszystkie regiony z wyjątkiem Azure Government i Departamentu Obrony (DoD) w Azure Government i MOONCAKE i rząd USA (GCC-High) i rząd USA (GCC)
[variables('keyBasedAuthDefaultDescription')]
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz Omówienie łączników dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Identyfikator konta | ciąg | Nazwa konta bez części "documents.azure.com" | Prawda |
| Klucz dostępu do konta usługi Azure Cosmos DB | securestring | Klucz podstawowy lub pomocniczy | Prawda |
[variables('oauthDefaultDisplayName')]
Identyfikator uwierzytelniania: tokenBasedAuth
Dotyczy: Wszystkie regiony z wyjątkiem Azure Government i Departamentu Obrony (DoD) w Azure Government i MOONCAKE i rząd USA (GCC-High) i rząd USA (GCC)
[variables('oauthDefaultDescription')]
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
Klawisz dostępu
Identyfikator uwierzytelniania: keyBasedAuth
Dotyczy: tylko MOONCAKE
Podaj nazwę konta i klucz dostępu, aby uzyskać dostęp do konta usługi Cosmos DB.
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz Omówienie łączników dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Identyfikator konta | ciąg | Nazwa konta bez części "documents.azure.com" | Prawda |
| Klucz dostępu do konta usługi Azure Cosmos DB | securestring | Klucz podstawowy lub pomocniczy | Prawda |
Klucz dostępu (Azure Government)
Identyfikator uwierzytelniania: keyBasedAuth
Dotyczy: Azure Government i Departament Obrony (DoD) tylko w Azure Government i rządu USA (GCC-High) i rządu USA (GCC)
Podaj nazwę konta i klucz dostępu, aby uzyskać dostęp do konta usługi Cosmos DB.
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz Omówienie łączników dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Identyfikator konta | ciąg | Nazwa konta bez części "documents.azure.com" | Prawda |
| Klucz dostępu do konta usługi Azure Cosmos DB | securestring | Klucz podstawowy lub pomocniczy | Prawda |
Zarządzana Tożsamość
Identyfikator uwierzytelniania: managedIdentityAuth
Dotyczy: tylko USŁUGA LOGICAPPS
Tworzenie połączenia przy użyciu tożsamości zarządzanej
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz Omówienie łączników dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Zarządzana Tożsamość | managedIdentity | Logowanie przy użyciu tożsamości zarządzanej | Prawda |
Microsoft Entra ID Zintegrowany
Identyfikator uwierzytelniania: tokenBasedAuth
Dotyczy: tylko MOONCAKE
Użyj identyfikatora Entra firmy Microsoft, aby uzyskać dostęp do usługi Azure Blob Storage.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
Microsoft Entra ID Integrated (Azure Commercial)
Identyfikator uwierzytelniania: oauthCom
Dotyczy: tylko rząd USA (GCC)
Użyj identyfikatora Entra firmy Microsoft, aby uzyskać dostęp do usługi Azure Blob Storage w usłudze Azure Commercial.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
Microsoft Entra ID Integrated (Azure Government)
Identyfikator uwierzytelniania: tokenBasedAuth
Dotyczy: Azure Government i Departament Obrony (DoD) tylko w Azure Government i rządu USA (GCC-High) i rządu USA (GCC)
Użyj identyfikatora Entra firmy Microsoft, aby uzyskać dostęp do usługi Azure Blob Storage.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
Domyślne [PRZESTARZAŁE]
Dotyczy: wszystkie regiony
Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Identyfikator konta | ciąg | Nazwa konta bez części "documents.azure.com" | Prawda |
| Klucz dostępu do konta usługi Azure Cosmos DB | securestring | Klucz podstawowy lub pomocniczy | Prawda |
Limity ograniczania
| Nazwisko | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 1500 | 60 sekund |
Akcje
| Pobieranie dokumentu (wersja 2) |
Pobierz dokument (wersja 2). |
| Pobieranie dokumentu [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj polecenia Pobierz dokument (wersja 2).
|
| Pobieranie procedur składowanych (wersja 2) |
Pobierz procedury składowane w określonej kolekcji (V2). |
| Pobieranie procedur składowanych [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj opcji Pobierz procedury składowane (V2).
|
| Pobieranie wszystkich dokumentów (wersja 3) |
Pobierz wszystkie dokumenty (wersja 3). |
| Pobierz wszystkie dokumenty [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj opcji Pobierz wszystkie dokumenty (V3).
|
| Pobierz wszystkie dokumenty w wersji 2 [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj opcji Pobierz wszystkie dokumenty (V3).
|
| Tworzenie lub aktualizowanie dokumentu (wersja 2) [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj polecenia Utwórz lub zaktualizuj dokument (V3).
|
| Tworzenie lub aktualizowanie dokumentu (wersja 3) |
Tworzenie lub aktualizowanie dokumentu. Podczas tworzenia dokumentu w usłudze DocumentDB treść musi zawierać właściwość id. |
| Tworzenie lub aktualizowanie dokumentu [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj polecenia Utwórz lub zaktualizuj dokument (V3).
|
| Tworzenie procedury składowanej (wersja 2) |
Utwórz procedurę składowaną (wersja 2). |
| Tworzenie procedury składowanej [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj opcji Utwórz procedurę składowaną (V2).
|
| Usuwanie dokumentu (wersja 2) |
Usuń dokument (wersja 2). |
| Usuwanie dokumentu [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj polecenia Usuń dokument (wersja 2).
|
| Usuwanie procedury składowanej (wersja 2) |
Usuń procedurę składowaną (V2). |
| Usuwanie procedury składowanej [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj procedury składowanej Delete (V2).
|
| Wykonaj procedurę składowaną [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj opcji Wykonaj procedurę składowaną (V2).
|
| Wykonywanie procedury składowanej (wersja 2) |
Wykonaj procedurę składowaną w określonej kolekcji (V2). |
| Wykonywanie zapytań dotyczących dokumentów [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego należy użyć funkcji Query documents V5 .
|
| Wykonywanie zapytań dotyczących dokumentów w wersji 2 [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego należy użyć funkcji Query documents V5 .
|
| Wykonywanie zapytań dotyczących dokumentów w wersji 3 [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego należy użyć funkcji Query documents V5 .
|
| Wykonywanie zapytań dotyczących dokumentów w wersji 4 [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego należy użyć funkcji Query documents V5 .
|
| Wykonywanie zapytań dotyczących dokumentów w wersji 5 |
Wykonywanie zapytań dotyczących dokumentów (V5). |
| Zamień procedurę składowaną (wersja 2) |
Zastąp procedurę składowaną (wersja 2). |
| Zamień procedurę składowaną [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego należy użyć opcji Zamień procedurę składowaną (V2).
|
| Zastępowanie dokumentu (wersja 2) |
Zastąp dokument (wersja 2). |
| Zastępowanie dokumentu [PRZESTARZAŁE] |
Ta akcja została przestarzała. Zamiast tego użyj polecenia Zamień dokument (wersja 2).
|
Pobieranie dokumentu (wersja 2)
Pobierz dokument (wersja 2).
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Wyodrębnianie etykiety poufności
|
extractSensitivityLabel | boolean |
Określ, czy mają być wyodrębnione etykiety MIP. |
|
|
Nazwa konta usługi Purview
|
purviewAccountName | string |
Domyślna kolekcja będzie odpytywane, chyba że zostanie określona. |
|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
@metadata
|
@metadata | array of DataWithSensitivityLabelInfo |
Lista kolumn wraz z etykietami poufności |
Pobieranie dokumentu [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj polecenia Pobierz dokument (wersja 2).
Pobierz dokument.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
- response
- object
Pobieranie procedur składowanych (wersja 2)
Pobierz procedury składowane w określonej kolekcji (V2).
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
Pobieranie procedur składowanych [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj opcji Pobierz procedury składowane (V2).
Pobierz procedury składowane w określonej kolekcji.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
Pobieranie wszystkich dokumentów (wersja 3)
Pobierz wszystkie dokumenty (wersja 3).
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
|
|
Wyodrębnianie etykiety poufności
|
extractSensitivityLabel | boolean |
Określ, czy mają być wyodrębnione etykiety MIP. |
|
|
Nazwa konta usługi Purview
|
purviewAccountName | string |
Domyślna kolekcja będzie odpytywane, chyba że zostanie określona. |
Zwraca
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
_Rid
|
_rid | string | |
|
Documents
|
Documents | array of object | |
|
@metadata
|
@metadata | array of DataWithSensitivityLabelInfo |
Lista kolumn wraz z etykietami poufności |
Pobierz wszystkie dokumenty [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj opcji Pobierz wszystkie dokumenty (V3).
Pobierz wszystkie dokumenty.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
- Body
- getDocumentsResponse
Pobierz wszystkie dokumenty w wersji 2 [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj opcji Pobierz wszystkie dokumenty (V3).
Pobierz wszystkie dokumenty w wersji 2.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Wartość klucza partycji
|
partitionKey | string |
Jeśli są puste, wszystkie partycje będą używane do wyszukiwania dokumentów. |
|
|
Maksymalna liczba elementów
|
maxItemCount | integer |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
continuationToken | string |
Token umożliwiający pobranie dodatkowych wyników. |
|
|
Poziom spójności
|
consistencyLevel | string |
Wymagany poziom spójności dla operacji kanału informacyjnego (zapytania/źródła danych odczytu). |
|
|
Token sesji
|
sessionToken | string |
Token sesji do użycia ze spójnością sesji. |
Zwraca
Tablica dokumentów pasujących do żądanego zapytania i powiązanych metadanych.
- Body
- DocumentsCollection
Tworzenie lub aktualizowanie dokumentu (wersja 2) [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj polecenia Utwórz lub zaktualizuj dokument (V3).
Tworzenie lub aktualizowanie dokumentu. Podczas tworzenia dokumentu w usłudze DocumentDB treść musi zawierać właściwość id.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Jeśli zostanie ustawiona wartość true, dokument zostanie zastąpiony, jeśli istnieje jeszcze utworzony. |
|
|
Wyzwalacz wstępny
|
x-ms-documentdb-pre-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia przed wykonaniem operacji dokumentu. |
|
|
Wyzwalacz po uruchomieniu
|
x-ms-documentdb-post-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia po wykonaniu operacji dokumentu. |
|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
Tworzenie lub aktualizowanie dokumentu (wersja 3)
Tworzenie lub aktualizowanie dokumentu. Podczas tworzenia dokumentu w usłudze DocumentDB treść musi zawierać właściwość id.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Jeśli zostanie ustawiona wartość true, dokument zostanie zastąpiony, jeśli istnieje jeszcze utworzony. |
|
|
Wyzwalacz wstępny
|
x-ms-documentdb-pre-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia przed wykonaniem operacji dokumentu. |
|
|
Wyzwalacz po uruchomieniu
|
x-ms-documentdb-post-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia po wykonaniu operacji dokumentu. |
|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
Tworzenie lub aktualizowanie dokumentu [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj polecenia Utwórz lub zaktualizuj dokument (V3).
Tworzenie lub aktualizowanie dokumentu. Podczas tworzenia dokumentu w usłudze DocumentDB treść musi zawierać właściwość id.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Jeśli zostanie ustawiona wartość true, dokument zostanie zastąpiony, jeśli istnieje jeszcze utworzony. |
|
|
Wyzwalacz wstępny
|
x-ms-documentdb-pre-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia przed wykonaniem operacji dokumentu. |
|
|
Wyzwalacz po uruchomieniu
|
x-ms-documentdb-post-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia po wykonaniu operacji dokumentu. |
|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
Tworzenie procedury składowanej (wersja 2)
Utwórz procedurę składowaną (wersja 2).
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Definicja funkcji
|
body | string |
Funkcja, która definiuje procedurę składowaną, np. "function(params){ ... }" |
|
|
id
|
id | string |
Nowy identyfikator procedury składowanej. |
|
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
Tworzenie procedury składowanej [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj opcji Utwórz procedurę składowaną (V2).
Utwórz procedurę składowaną.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Definicja funkcji
|
body | string |
Funkcja, która definiuje procedurę składowaną, np. "function(params){ ... }" |
|
|
id
|
id | string |
Nowy identyfikator procedury składowanej. |
|
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
Usuwanie dokumentu (wersja 2)
Usuń dokument (wersja 2).
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
Wyzwalacz wstępny
|
x-ms-documentdb-pre-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia przed wykonaniem operacji dokumentu. |
|
|
Wyzwalacz po uruchomieniu
|
x-ms-documentdb-post-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia po wykonaniu operacji dokumentu. |
|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Usuwanie dokumentu [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj polecenia Usuń dokument (wersja 2).
Usuń dokument.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
Wyzwalacz wstępny
|
x-ms-documentdb-pre-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia przed wykonaniem operacji dokumentu. |
|
|
Wyzwalacz po uruchomieniu
|
x-ms-documentdb-post-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia po wykonaniu operacji dokumentu. |
|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Usuwanie procedury składowanej (wersja 2)
Usuń procedurę składowaną (V2).
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Identyfikator sproc
|
sprocId | True | string |
Nazwa procedury składowanej. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
- response
- string
Usuwanie procedury składowanej [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj procedury składowanej Delete (V2).
Usuń procedurę składowaną.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Identyfikator sproc
|
sprocId | True | string |
Nazwa procedury składowanej. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
- response
- string
Wykonaj procedurę składowaną [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj opcji Wykonaj procedurę składowaną (V2).
Wykonaj procedurę składowaną w określonej kolekcji.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Identyfikator sproc
|
sprocId | True | string |
Nazwa procedury składowanej. |
|
Parametry procedury składowanej
|
parameters | string |
Określ prawidłowy kod JSON dla parametrów procedury składowanej, np. ["param1", "param2". |
|
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
- response
- ObjectWithoutType
Wykonywanie procedury składowanej (wersja 2)
Wykonaj procedurę składowaną w określonej kolekcji (V2).
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Identyfikator sproc
|
sprocId | True | string |
Nazwa procedury składowanej. |
|
Parametry procedury składowanej
|
parameters | string |
Określ prawidłowy kod JSON dla parametrów procedury składowanej, np. ["param1", "param2". |
|
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
- response
- ObjectWithoutType
Wykonywanie zapytań dotyczących dokumentów [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego należy użyć funkcji Query documents V5 .
Wykonywanie zapytań dotyczących dokumentów.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Włącz partycję krzyżową
|
x-ms-documentdb-query-enablecrosspartition | boolean |
Jeśli kolekcja jest podzielona na partycje, należy ustawić wartość True, aby zezwolić na wykonywanie w wielu partycjach. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
kwerenda
|
query | string |
Zwraca
- Body
- queryResponse
Wykonywanie zapytań dotyczących dokumentów w wersji 2 [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego należy użyć funkcji Query documents V5 .
Wykonywanie zapytań dotyczących dokumentów w wersji 2.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Tekst zapytania
|
QueryText | string |
Zapytanie składniOWE SQL dotyczące dokumentów |
|
|
Wartość klucza partycji
|
partitionKey | string |
Wartość klucza partycji. |
|
|
Token kontynuacji
|
continuationToken | string |
Token umożliwiający pobranie dodatkowych wyników z operacji. |
Zwraca
Tablica dokumentów pasujących do żądanego zapytania i powiązanych metadanych.
Wykonywanie zapytań dotyczących dokumentów w wersji 3 [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego należy użyć funkcji Query documents V5 .
Wykonywanie zapytań dotyczących dokumentów w wersji 3.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Zapytanie składniOWE SQL
|
queryText | True | string |
Zapytanie SQL. |
|
Wartość klucza partycji
|
partitionKey | string |
Jeśli są puste, wszystkie partycje będą używane do wyszukiwania dokumentów. |
|
|
Maksymalna liczba elementów
|
maxItemCount | integer |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
continuationToken | string |
Token umożliwiający pobranie dodatkowych wyników. |
|
|
Włącz partycję krzyżową
|
enableCrossPartition | boolean |
Wskazuje, czy użytkownik jest włączony do wysyłania więcej niż jednego żądania w celu wykonania zapytania. |
|
|
Poziom spójności
|
consistencyLevel | string |
Wymagany poziom spójności dla operacji kanału informacyjnego (zapytania/źródła danych odczytu). |
|
|
Token sesji
|
sessionToken | string |
Token sesji do użycia ze spójnością sesji. |
Zwraca
Tablica dokumentów pasujących do żądanego zapytania i powiązanych metadanych.
- Body
- DocumentsCollection
Wykonywanie zapytań dotyczących dokumentów w wersji 4 [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego należy użyć funkcji Query documents V5 .
Wykonywanie zapytań dotyczących dokumentów w wersji 4.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kontenera
|
containerId | True | string |
Nazwa kontenera. |
|
Zapytanie składniOWE SQL
|
queryText | string |
Zapytanie SQL. Jeśli jest pusty, zwróci wszystkie dokumenty. |
|
|
Wartość klucza partycji
|
partitionKey | string |
Jeśli są puste, wszystkie partycje będą używane do wyszukiwania dokumentów. |
|
|
Maksymalna liczba elementów
|
maxItemCount | integer |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
continuationToken | string |
Token umożliwiający pobranie dodatkowych wyników. |
|
|
Poziom spójności
|
consistencyLevel | string |
Wymagany poziom spójności dla operacji kanału informacyjnego (zapytania/źródła danych odczytu). |
|
|
Token sesji
|
sessionToken | string |
Token sesji do użycia ze spójnością sesji. |
Zwraca
Tablica dokumentów pasujących do żądanego zapytania i powiązanych metadanych.
- Body
- DocumentsCollection
Wykonywanie zapytań dotyczących dokumentów w wersji 5
Wykonywanie zapytań dotyczących dokumentów (V5).
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kontenera
|
containerId | True | string |
Nazwa kontenera. |
|
Zapytanie składniOWE SQL
|
queryText | string |
Zapytanie SQL. Jeśli jest pusty, zwróci wszystkie dokumenty. |
|
|
Wartość klucza partycji
|
partitionKey | string |
Wartość musi być podana zgodnie z typem ("ciąg", 42, 0,5). Jeśli są puste, wszystkie partycje będą używane do wyszukiwania dokumentów. |
|
|
Maksymalna liczba elementów
|
maxItemCount | integer |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
continuationToken | string |
Token umożliwiający pobranie dodatkowych wyników. |
|
|
Poziom spójności
|
consistencyLevel | string |
Wymagany poziom spójności dla operacji kanału informacyjnego (zapytania/źródła danych odczytu). |
|
|
Token sesji
|
sessionToken | string |
Token sesji do użycia ze spójnością sesji. |
|
|
Wyodrębnianie etykiety poufności
|
extractSensitivityLabel | boolean |
Określ, czy mają być wyodrębnione etykiety MIP. |
|
|
Nazwa konta usługi Purview
|
purviewAccountName | string |
Domyślna kolekcja będzie odpytywane, chyba że zostanie określona. |
Zwraca
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Documents
|
value | array of ObjectWithoutType | |
|
Token kontynuacji
|
ContinuationToken | string | |
|
Liczba dokumentów
|
Count | integer | |
|
Opłata za żądanie
|
RequestCharge | double | |
|
Token sesji
|
SessionToken | string | |
|
Identyfikator działania
|
ActivityId | string | |
|
@metadata
|
@metadata | array of DataWithSensitivityLabelInfo |
Lista kolumn wraz z etykietami poufności |
Zamień procedurę składowaną (wersja 2)
Zastąp procedurę składowaną (wersja 2).
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Identyfikator sproc
|
sprocId | True | string |
Nazwa procedury składowanej. |
|
Definicja funkcji
|
body | string |
Funkcja, która definiuje procedurę składowaną, np. "function(params){ ... }" |
|
|
id
|
id | string |
Identyfikator istniejącej procedury składowanej. |
|
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
Zamień procedurę składowaną [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego należy użyć opcji Zamień procedurę składowaną (V2).
Zastąp procedurę składowaną.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Identyfikator sproc
|
sprocId | True | string |
Nazwa procedury składowanej. |
|
Definicja funkcji
|
body | string |
Funkcja, która definiuje procedurę składowaną, np. "function(params){ ... }" |
|
|
id
|
id | string |
Identyfikator istniejącej procedury składowanej. |
|
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
Zastępowanie dokumentu (wersja 2)
Zastąp dokument (wersja 2).
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
Wyzwalacz wstępny
|
x-ms-documentdb-pre-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia przed wykonaniem operacji dokumentu. |
|
|
Wyzwalacz po uruchomieniu
|
x-ms-documentdb-post-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia po wykonaniu operacji dokumentu. |
|
|
Nazwa konta usługi Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nazwa konta usługi Azure Cosmos DB (bez documents.azure.com). |
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
- Body
- putDocumentResponse
Zastępowanie dokumentu [PRZESTARZAŁE]
Ta akcja została przestarzała. Zamiast tego użyj polecenia Zamień dokument (wersja 2).
Zamień dokument.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wartość klucza partycji
|
x-ms-documentdb-raw-partitionkey | string |
Wartość klucza partycji dla żądanego dokumentu lub operacji załącznika. |
|
|
Maksymalna liczba elementów
|
x-ms-max-item-count | number |
Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę. |
|
|
Token kontynuacji
|
x-ms-continuation | string |
Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli istnieje więcej wyników do odczytania. |
|
|
Poziom spójności
|
x-ms-consistency-level | string |
Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). |
|
|
Token sesji
|
x-ms-session-token | string |
Token ciągu używany ze spójnością na poziomie sesji. |
|
|
Identyfikator działania
|
x-ms-activity-id | string |
Klient podał identyfikator operacji, która zostanie powtórzona w odpowiedzi serwera. |
|
|
Wyzwalacz wstępny
|
x-ms-documentdb-pre-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia przed wykonaniem operacji dokumentu. |
|
|
Wyzwalacz po uruchomieniu
|
x-ms-documentdb-post-trigger-include | string |
Rozdzielona przecinkami lista nazw wyzwalaczy do uruchomienia po wykonaniu operacji dokumentu. |
|
|
Identyfikator bazy danych
|
databaseId | True | string |
Nazwa bazy danych. |
|
Identyfikator kolekcji
|
collectionId | True | string |
Nazwa kolekcji. |
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu. |
|
wersja API
|
x-ms-version | string |
Wersja interfejsu API. |
Zwraca
- Body
- putDocumentResponse
Definicje
QueryDocumentsResponse
Tablica dokumentów pasujących do żądanego zapytania i powiązanych metadanych.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Documents
|
Documents | array of ObjectWithoutType |
Tablica dokumentów pasujących do żądania. |
|
Liczba dokumentów
|
_count | integer |
Liczba dokumentów. |
|
Identyfikator działania
|
ActivityId | string |
Identyfikator działania usługi Azure Cosmos DB. |
DataWithSensitivityLabelInfo
Nazwa danych z informacjami o etykiecie poufności
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
name
|
name | string |
Name |
|
sensitivityLabelInfo
|
sensitivityLabelInfo | array of SensitivityLabelMetadata |
Lista informacji o etykiecie poufności |
SensitivityLabelMetadata
Informacje o metadanych funkcji SensitivityLabel
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
sensitivityLabelId
|
sensitivityLabelId | string |
SensitivityLabel Id. |
|
name
|
name | string |
Nazwa etykiety poufności. |
|
displayName
|
displayName | string |
SensitivityLabel displayName info |
|
etykietka narzędzia
|
tooltip | string |
WażnośćSzczegóły etykietki narzędzia. |
|
priority
|
priority | integer |
WażnośćWłaciwość. |
|
color
|
color | string |
Kolor etykiet poufności. |
|
jestZaszyfrowany
|
isEncrypted | boolean |
is SensitivityLabel Encrypted. |
|
isEnabled
|
isEnabled | boolean |
Określa, czy etykieta SensitivityLabel jest włączona. |
|
isParent
|
isParent | boolean |
Czy wartość SensitivityLabel jest elementem nadrzędnym. |
|
parentSensitivityLabelId
|
parentSensitivityLabelId | string |
Identyfikator elementu SensitivityLabel nadrzędnego. |
DocumentsCollection
Tablica dokumentów pasujących do żądanego zapytania i powiązanych metadanych.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Documents
|
value | array of ObjectWithoutType | |
|
Token kontynuacji
|
ContinuationToken | string | |
|
Liczba dokumentów
|
Count | integer | |
|
Opłata za żądanie
|
RequestCharge | double | |
|
Token sesji
|
SessionToken | string | |
|
Identyfikator działania
|
ActivityId | string |
postDocumentsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
_Rid
|
_rid | string | |
|
_Ts
|
_ts | integer | |
|
_jaźń
|
_self | string | |
|
_etag
|
_etag | string | |
|
_Załączniki
|
_attachments | string | |
|
id
|
id | string |
putDocumentResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
_Rid
|
_rid | string | |
|
id
|
id | string |
getDocumentsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
_Rid
|
_rid | string | |
|
Documents
|
Documents | array of object |
queryResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
_Rid
|
_rid | string | |
|
_hrabia
|
_count | number | |
|
Documents
|
Documents | array of |
getStoredProceduresResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
_hrabia
|
_count | integer |
_hrabia |
|
_Rid
|
_rid | string |
_Rid |
|
Przechowywane procedury
|
StoredProcedures | array of object |
Przechowywane procedury |
|
_etag
|
StoredProcedures._etag | string |
_etag |
|
_Rid
|
StoredProcedures._rid | string |
_Rid |
|
_jaźń
|
StoredProcedures._self | string |
_jaźń |
|
_Ts
|
StoredProcedures._ts | integer |
_Ts |
|
body
|
StoredProcedures.body | string |
body |
|
id
|
StoredProcedures.id | string |
id |
createStoredProcedureResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
_etag
|
_etag | string |
_etag |
|
_Rid
|
_rid | string |
_Rid |
|
_jaźń
|
_self | string |
_jaźń |
|
_Ts
|
_ts | integer |
_Ts |
|
body
|
body | string |
body |
|
id
|
id | string |
id |
ObjectWithoutType
ciąg
Jest to podstawowy typ danych "string".
obiekt
Jest to typ 'obiekt'.